Documentation
    Preparing search index...

    Interface EncoderOptions

    interface EncoderOptions {
        contentTopic: string;
        ephemeral?: boolean;
        metaSetter?: IMetaSetter;
        routingInfo: IRoutingInfo;
        sigPrivKey?: Uint8Array<ArrayBufferLike>;
        symKey: Uint8Array;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contentTopic ephemeral? metaSetter? routingInfo sigPrivKey? symKey

    Properties

    contentTopic: string

    The content topic to set on outgoing messages.

    ephemeral?: boolean

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

    false

    metaSetter?: IMetaSetter

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

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

    routingInfo: IRoutingInfo

    The routing information for the message (cluster id, shard id, pubsubTopic)

    sigPrivKey?: Uint8Array<ArrayBufferLike>

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

    symKey: Uint8Array

    The symmetric key to encrypt the payload with.

    Settings

    Member Visibility

    On This Page

    Properties