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): Uint8Array

MessageEncoder.encode

Encodes message to recipient using recommended format.

Parameters

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

Returns

Uint8Array

Encrypted and encoded message.

---

encodeDeprecated()

encodeDeprecated(recipientPublicKey, message): Uint8Array

Encodes message to recipient using (deprecated) wallet format.

Parameters

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

Returns

Uint8Array

Encrypted and encoded message.

Deprecated

This function is only provided for compatability with the original Symbol wallets. Please use encode in any new code.

---

encodePersistentHarvestingDelegation()

encodePersistentHarvestingDelegation(
   nodePublicKey, 
   remoteKeyPair, 
   vrfKeyPair): Uint8Array

MessageEncoder.encodePersistentHarvestingDelegation

Encodes persistent harvesting delegation to node.

Parameters

Parameter	Type	Description
nodePublicKey	PublicKey	Node public key.
remoteKeyPair	KeyPair	Remote key pair.
vrfKeyPair	KeyPair	Vrf key pair.

Returns

Uint8Array

Encrypted and encoded harvesting delegation request.

---

tryDecode()

tryDecode(recipientPublicKey, encodedMessage): TryDecodeResult

MessageEncoder.tryDecode

Tries to decode encoded message.

Parameters

Parameter	Type	Description
recipientPublicKey	PublicKey	Recipient's public key.
encodedMessage	Uint8Array	Encoded message.

Returns

TryDecodeResult

Tuple containing decoded status and message.

---

tryDecodeDeprecated()

tryDecodeDeprecated(recipientPublicKey, encodedMessage): TryDecodeResult

Tries to decode encoded message.

Parameters

Parameter	Type	Description
recipientPublicKey	PublicKey	Recipient's public key.
encodedMessage	Uint8Array	Encoded message

Returns

TryDecodeResult

Tuple containing decoded status and message.

Deprecated

This function is only provided for compatability with the original Symbol wallets. Please use tryDecode in any new code.