MessageEncoder

MessageEncoder

Encrypts and encodes messages between two parties.

Constructors

new default()

new default(keyPair): MessageEncoder

Creates message encoder around key pair.

Parameters

Parameter	Type	Description
keyPair	KeyPair	Key pair.

Returns

MessageEncoder

Accessors

publicKey

Get Signature

get publicKey(): PublicKey

MessageEncoder.publicKey

Public key used for message encoding.

Returns

PublicKey

Public key used for message encoding.

Methods

encode()

encode(recipientPublicKey, message): Message

MessageEncoder.encode

Encodes message to recipient using recommended format.

Parameters

Parameter	Type	Description
recipientPublicKey	PublicKey	Recipient public key.
message	Uint8Array	Message to encode.

Returns

Message

Encrypted and encoded message.

---

encodeDeprecated()

encodeDeprecated(recipientPublicKey, message): Message

Encodes message to recipient using recommended format.

Parameters

Parameter	Type	Description
recipientPublicKey	PublicKey	Recipient public key.
message	Uint8Array	Message to encode.

Returns

Message

Encrypted and encoded message.

Deprecated

This function is only provided for compatability with older NEM messages. Please use encode in any new code.

---

tryDecode()

tryDecode(recipientPublicKey, encodedMessage): TryDecodeResult

MessageEncoder.tryDecode

Tries to decode encoded message.

Parameters

Parameter	Type	Description
recipientPublicKey	PublicKey	Recipient public key.
encodedMessage	Message	Encoded message.

Returns

TryDecodeResult

Tuple containing decoded status and message.