Class Session

Double ratchet secure communication session over Nostr

Very similar to Signal's "Double Ratchet with header encryption" https://signal.org/docs/specifications/doubleratchet/

Methods

close onEvent send sendEvent init

Methods

close

  • close(): void

    Stop listening to incoming messages

    Returns void

onEvent

send

  • send(text: string): { event: VerifiedEvent; innerEvent: Rumor }

    Sends a text message through the encrypted session. Sent in a Nostr event with the kind CHAT_MESSAGE_KIND.

    Parameters

    • text: string

      The plaintext message to send

    Returns { event: VerifiedEvent; innerEvent: Rumor }

    A verified Nostr event containing the encrypted message. You need to publish this event to the Nostr network.

    Throws

    Error if we are not the initiator and trying to send the first message

sendEvent

  • sendEvent(
        event: Partial<UnsignedEvent>,
    ): { event: VerifiedEvent; innerEvent: Rumor }

    Send a partial Nostr event through the encrypted session. In addition to chat messages, it could be files, webrtc negotiation or many other types of messages.

    Parameters

    • event: Partial<UnsignedEvent>

      Partial Nostr event to send. Must be unsigned. Id and will be generated if not provided.

    Returns { event: VerifiedEvent; innerEvent: Rumor }

    A verified Nostr event containing the encrypted message. You need to publish this event to the Nostr network.

    Throws

    Error if we are not the initiator and trying to send the first message

Staticinit

  • init(
        nostrSubscribe: NostrSubscribe,
        theirEphemeralNostrPublicKey: string,
        ourEphemeralNostrPrivateKey: Uint8Array,
        isInitiator: boolean,
        sharedSecret: Uint8Array,
        name?: string,
    ): Session

    Initializes a new secure communication session

    Parameters

    • nostrSubscribe: NostrSubscribe

      Function to subscribe to Nostr events

    • theirEphemeralNostrPublicKey: string
    • ourEphemeralNostrPrivateKey: Uint8Array
    • isInitiator: boolean

      Whether we are initiating the conversation (true) or responding (false)

    • sharedSecret: Uint8Array

      Initial shared secret for securing the first message chain

    • Optionalname: string

      Optional name for the session (for debugging)

    Returns Session

    A new Session instance

Settings

Member Visibility

On This Page

Methods