Class MessageEncoder

Encrypts and encodes messages between two parties.

Index

Constructors

Accessors

Methods

encode encodeDeprecated encodePersistentHarvestingDelegation tryDecode tryDecodeDeprecated

Constructors

constructor

new MessageEncoder(keyPair): MessageEncoder
Creates message encoder around key pair.
Parameters
- keyPair: KeyPair
  Key pair.
Returns MessageEncoder
- Defined in symbol/MessageEncoder.d.ts:9

Accessors

publicKey

get publicKey(): PublicKey
Public key used for message encoding.

Returns PublicKey
Public key used for message encoding.
- Defined in symbol/MessageEncoder.d.ts:18

Methods

encode

encode(recipientPublicKey, message): Uint8Array
Encodes message to recipient using recommended format.
Parameters
- recipientPublicKey: PublicKey
  Recipient public key.
- message: Uint8Array
  Message to encode.
Returns Uint8Array
Encrypted and encoded message.
- Defined in symbol/MessageEncoder.d.ts:32

encodeDeprecated

encodeDeprecated(recipientPublicKey, message): Uint8Array
Encodes message to recipient using (deprecated) wallet format.
Parameters
- 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.
- Defined in symbol/MessageEncoder.d.ts:58

encodePersistentHarvestingDelegation

encodePersistentHarvestingDelegation(nodePublicKey, remoteKeyPair, vrfKeyPair): Uint8Array
Encodes persistent harvesting delegation to node.
Parameters
- nodePublicKey: PublicKey
  Node public key.
- remoteKeyPair: KeyPair
  Remote key pair.
- vrfKeyPair: KeyPair
  Vrf key pair.
Returns Uint8Array
Encrypted and encoded harvesting delegation request.
- Defined in symbol/MessageEncoder.d.ts:40

tryDecode

tryDecode(recipientPublicKey, encodedMessage): TryDecodeResult
Tries to decode encoded message.
Parameters
- recipientPublicKey: PublicKey
  Recipient's public key.
- encodedMessage: Uint8Array
  Encoded message.
Returns TryDecodeResult
Tuple containing decoded status and message.
- Defined in symbol/MessageEncoder.d.ts:25

tryDecodeDeprecated

tryDecodeDeprecated(recipientPublicKey, encodedMessage): TryDecodeResult
Tries to decode encoded message.
Parameters
- 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.
- Defined in symbol/MessageEncoder.d.ts:49