Interface EncoderOptions

interface EncoderOptions {
    contentTopic: string;
    ephemeral?: boolean;
    metaSetter?: IMetaSetter;
    publicKey: Uint8Array;
    pubsubTopic?: string;
    pubsubTopicShardInfo?: SingleShardInfo;
    sigPrivKey?: Uint8Array;
}

Hierarchy (view full)

Properties

contentTopic ephemeral? metaSetter? publicKey pubsubTopic? pubsubTopicShardInfo? sigPrivKey?

Properties

contentTopic

contentTopic: string

The content topic to set on outgoing messages.

Optional ephemeral

ephemeral?: boolean

An optional flag to mark message as ephemeral, i.e., not to be stored by Waku Store nodes.

Default Value

false

Optional metaSetter

metaSetter?: IMetaSetter

A function called when encoding messages to set the meta field.

Param: IProtoMessage

The message encoded for wire, without the meta field. If encryption is used, metaSetter only accesses encrypted payload.

publicKey

publicKey: Uint8Array

The public key to encrypt the payload for.

Optional pubsubTopic

pubsubTopic?: string

Deprecated

Optional pubsubTopicShardInfo

pubsubTopicShardInfo?: SingleShardInfo

Optional sigPrivKey

sigPrivKey?: Uint8Array

An optional private key to be used to sign the payload before encryption.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc