Interface SessionState

State of a Double Ratchet session between two parties. Needed for persisting sessions.

interface SessionState {
    ourCurrentNostrKey?: KeyPair;
    ourNextNostrKey: KeyPair;
    previousSendingChainMessageCount: number;
    receivingChainKey?: Uint8Array<ArrayBufferLike>;
    receivingChainMessageNumber: number;
    rootKey: Uint8Array;
    sendingChainKey?: Uint8Array<ArrayBufferLike>;
    sendingChainMessageNumber: number;
    skippedKeys: {
        [pubKey: string]: {
            headerKeys: Uint8Array<ArrayBufferLike>[];
            messageKeys: { [msgIndex: number]: Uint8Array<ArrayBufferLike> };
        };
    };
    theirCurrentNostrPublicKey?: string;
    theirNextNostrPublicKey: string;
}

Properties

ourCurrentNostrKey? ourNextNostrKey previousSendingChainMessageCount receivingChainKey? receivingChainMessageNumber rootKey sendingChainKey? sendingChainMessageNumber skippedKeys theirCurrentNostrPublicKey? theirNextNostrPublicKey

Properties

OptionalourCurrentNostrKey

ourCurrentNostrKey?: KeyPair

Our current Nostr keypair used for this session

ourNextNostrKey

ourNextNostrKey: KeyPair

Our next Nostr keypair, used when ratcheting forward. It is advertised in messages we send.

previousSendingChainMessageCount

previousSendingChainMessageCount: number

Number of messages sent in previous sending chain

OptionalreceivingChainKey

receivingChainKey?: Uint8Array<ArrayBufferLike>

Key for decrypting incoming messages in current chain

receivingChainMessageNumber

receivingChainMessageNumber: number

Number of messages received in current receiving chain

rootKey

rootKey: Uint8Array

Root key used to derive new sending / receiving chain keys

OptionalsendingChainKey

sendingChainKey?: Uint8Array<ArrayBufferLike>

Key for encrypting outgoing messages in current chain

sendingChainMessageNumber

sendingChainMessageNumber: number

Number of messages sent in current sending chain

skippedKeys

skippedKeys: {
    [pubKey: string]: {
        headerKeys: Uint8Array<ArrayBufferLike>[];
        messageKeys: { [msgIndex: number]: Uint8Array<ArrayBufferLike> };
    };
}

Cache of message & header keys for handling out-of-order messages

OptionaltheirCurrentNostrPublicKey

theirCurrentNostrPublicKey?: string

The other party's current Nostr public key

theirNextNostrPublicKey

theirNextNostrPublicKey: string

The other party's next Nostr public key

Settings

Member Visibility

On This Page

Properties