Class GroupSession<THistory>

constructor

• new GroupSession<THistory extends GroupSessionHistory | undefined = undefined>(
      options: GroupSessionOptions<THistory>,
  ): GroupSession<THistory>

  Type Parameters

  • THistory extends GroupSessionHistory | undefined = undefined

  Parameters

  • options: GroupSessionOptions<THistory>

  Returns GroupSession<THistory>

Readonlyciphersuite

Readonlyhistory

Optional ReadonlyrewindStore

Readonlystore

convergenceStatus

• get convergenceStatus(): ConvergenceStatus

  The derived convergence status (group-state.md §Convergence status, B5).

  Returns ConvergenceStatus

dirty

• get dirty(): boolean

  Returns boolean

groupData

• get groupData(): MarmotGroupView | null

  Returns MarmotGroupView | null

historyTree

• get historyTree(): GroupHistoryTree

  The full-fork history tree (every observed state, canonical + forks).

  Returns GroupHistoryTree

id

• get id(): Uint8Array

  Returns Uint8Array

lifecycle

• get lifecycle(): GroupLifecycleState

  Returns GroupLifecycleState

relays

• get relays(): string[] | undefined

  Returns string[] | undefined

state

• get state(): ClientState

  Returns ClientState

• set state(newState: ClientState): void

  Parameters

  • newState: ClientState

  Returns void

unappliedProposals

• get unappliedProposals(): UnappliedProposals

  Returns UnappliedProposals

confirmPublished

• confirmPublished(pending: PendingState): void

  Parameters

  • pending: PendingState

  Returns void

destroyLocalState

• destroyLocalState(): Promise<void>

  Returns Promise<void>

dispose

• dispose(): void

  Releases engine resources (the settle-check timer); call on teardown (B5).

  Returns void

ingest

• ingest(
      events: NostrEvent[],
      options?: { maxRetries?: number },
  ): AsyncGenerator<DispositionedIngestResult>

  Parameters

  • events: NostrEvent[]
  • Optionaloptions: { maxRetries?: number }

  Returns AsyncGenerator<DispositionedIngestResult>

leave

• leave(ownPubkey: string): Promise<GroupEffects>

  Builds the self-remove proposal effects for leaving the group.

  Per RFC 9420 §12.4 a member cannot commit a Remove targeting their own leaf, so this emits self-remove proposal(s) for the next committer (e.g. an admin) to apply. Modelled as a send-intent — the darkmatter engine exposes the same operation as do_send_leave rather than letting callers hand-build the proposals.

  Parameters

  • ownPubkey: string

    The leaving member's Nostr public key (hex string).

  Returns Promise<GroupEffects>

  Publishable proposal effects (one per owned leaf node).

proposalContext

• proposalContext(): ProposalContext

  Returns ProposalContext

publishFailed

• publishFailed(pending: PendingState): void

  Parameters

  • pending: PendingState

  Returns void

save

• save(force?: boolean): Promise<void>

  Parameters

  • force: boolean = false

  Returns Promise<void>

send

• send(intent: GroupSessionSendIntent): Promise<GroupEffects>

  Parameters

  • intent: GroupSessionSendIntent

  Returns Promise<GroupEffects>