Class GroupsManager<THistory, TMedia>

constructor

• new GroupsManager<
      THistory extends BaseGroupHistory
      | undefined = any,
      TMedia extends BaseGroupMedia | undefined = any,
  >(
      options: GroupsManagerOptions<THistory, TMedia>,
  ): GroupsManager<THistory, TMedia>

  Type Parameters

  • THistory extends BaseGroupHistory | undefined = any
  • TMedia extends BaseGroupMedia | undefined = any

  Parameters

  • options: GroupsManagerOptions<THistory, TMedia>

  Returns GroupsManager<THistory, TMedia>

cryptoProvider

Readonlynetwork

Readonlysigner

Readonlystore

loaded

• get loaded(): MarmotGroup<THistory, TMedia>[]

  Returns the list of currently loaded group instances

  Returns MarmotGroup<THistory, TMedia>[]

adoptClientState

• adoptClientState(
      state: ClientState,
      options?: { emit?: "imported" | "joined" },
  ): Promise<MarmotGroup<THistory, TMedia>>

  Persists and caches a group built from a ClientState, emitting the given lifecycle event. Used by higher-level flows (e.g. joining from a welcome message) that construct ClientStates themselves.

  Parameters

  • state: ClientState

    The ClientState to adopt

  • Optionaloptions: { emit?: "imported" | "joined" }

    • Optionalemit?: "imported" | "joined"

      Which lifecycle event to emit. Defaults to "imported".

  Returns Promise<MarmotGroup<THistory, TMedia>>

  The persisted and cached MarmotGroup

  Throws

  Error if a group with the same id already exists

create

• create(
      name: string,
      options?: SimpleGroupOptions & {
          ciphersuite?:
              | "MLS_128_DHKEMX25519_AES128GCM_SHA256_Ed25519"
              | "MLS_128_DHKEMP256_AES128GCM_SHA256_P256"
              | "MLS_128_DHKEMX25519_CHACHA20POLY1305_SHA256_Ed25519"
              | "MLS_256_DHKEMX448_AES256GCM_SHA512_Ed448"
              | "MLS_256_DHKEMP521_AES256GCM_SHA512_P521"
              | "MLS_256_DHKEMX448_CHACHA20POLY1305_SHA512_Ed448"
              | "MLS_256_DHKEMP384_AES256GCM_SHA384_P384"
              | "MLS_128_MLKEM512_AES128GCM_SHA256_Ed25519"
              | "MLS_128_MLKEM512_CHACHA20POLY1305_SHA256_Ed25519"
              | "MLS_256_MLKEM768_AES256GCM_SHA384_Ed25519"
              | "MLS_256_MLKEM768_CHACHA20POLY1305_SHA384_Ed25519"
              | "MLS_256_MLKEM1024_AES256GCM_SHA512_Ed25519"
              | "MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_Ed25519"
              | "MLS_256_XWING_AES256GCM_SHA512_Ed25519"
              | "MLS_256_XWING_CHACHA20POLY1305_SHA512_Ed25519"
              | "MLS_256_MLKEM1024_AES256GCM_SHA512_MLDSA87"
              | "MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_MLDSA87"
              | "MLS_256_XWING_AES256GCM_SHA512_MLDSA87"
              | "MLS_256_XWING_CHACHA20POLY1305_SHA512_MLDSA87";
      },
  ): Promise<MarmotGroup<THistory, TMedia>>

  Creates a new simple group

  Parameters

  • name: string
  • Optionaloptions: SimpleGroupOptions & {
        ciphersuite?:
            | "MLS_128_DHKEMX25519_AES128GCM_SHA256_Ed25519"
            | "MLS_128_DHKEMP256_AES128GCM_SHA256_P256"
            | "MLS_128_DHKEMX25519_CHACHA20POLY1305_SHA256_Ed25519"
            | "MLS_256_DHKEMX448_AES256GCM_SHA512_Ed448"
            | "MLS_256_DHKEMP521_AES256GCM_SHA512_P521"
            | "MLS_256_DHKEMX448_CHACHA20POLY1305_SHA512_Ed448"
            | "MLS_256_DHKEMP384_AES256GCM_SHA384_P384"
            | "MLS_128_MLKEM512_AES128GCM_SHA256_Ed25519"
            | "MLS_128_MLKEM512_CHACHA20POLY1305_SHA256_Ed25519"
            | "MLS_256_MLKEM768_AES256GCM_SHA384_Ed25519"
            | "MLS_256_MLKEM768_CHACHA20POLY1305_SHA384_Ed25519"
            | "MLS_256_MLKEM1024_AES256GCM_SHA512_Ed25519"
            | "MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_Ed25519"
            | "MLS_256_XWING_AES256GCM_SHA512_Ed25519"
            | "MLS_256_XWING_CHACHA20POLY1305_SHA512_Ed25519"
            | "MLS_256_MLKEM1024_AES256GCM_SHA512_MLDSA87"
            | "MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_MLDSA87"
            | "MLS_256_XWING_AES256GCM_SHA512_MLDSA87"
            | "MLS_256_XWING_CHACHA20POLY1305_SHA512_MLDSA87";
    }

  Returns Promise<MarmotGroup<THistory, TMedia>>

destroy

• destroy(groupId: string | Uint8Array<ArrayBufferLike>): Promise<void>

  Destroys a group and purges the group history

  Parameters

  • groupId: string | Uint8Array<ArrayBufferLike>

  Returns Promise<void>

get

• get(
      groupId: string | Uint8Array<ArrayBufferLike>,
  ): Promise<MarmotGroup<THistory, TMedia>>

  Gets a group from cache or loads it from store

  Parameters

  • groupId: string | Uint8Array<ArrayBufferLike>

  Returns Promise<MarmotGroup<THistory, TMedia>>

has

• has(groupId: string | Uint8Array<ArrayBufferLike>): Promise<boolean>

  Checks if a group exists in the backend

  Parameters

  • groupId: string | Uint8Array<ArrayBufferLike>

  Returns Promise<boolean>

import

• import(state: ClientState): Promise<MarmotGroup<THistory, TMedia>>

  Imports a new group from a ClientState object, persisting it to the store and emitting imported.

  Parameters

  • state: ClientState

  Returns Promise<MarmotGroup<THistory, TMedia>>

leave

• leave(
      groupId: string | Uint8Array<ArrayBufferLike>,
  ): Promise<Record<string, PublishResponse>>

  Leaves a group by publishing a self-remove proposal and purging all local group data from storage.

  At least one relay must acknowledge the proposals before local state is destroyed. If no relay acks, an error is thrown and local state is preserved so the caller can retry.

  Parameters

  • groupId: string | Uint8Array<ArrayBufferLike>

    The group ID as a hex string or Uint8Array.

  Returns Promise<Record<string, PublishResponse>>

  The relay publish responses for the leave proposal event(s).

listIds

• listIds(): Promise<Uint8Array<ArrayBufferLike>[]>

  Lists all persisted group IDs, decoded from their hex storage keys.

  Returns Promise<Uint8Array<ArrayBufferLike>[]>

loadAll

• loadAll(): Promise<MarmotGroup<THistory, TMedia>[]>

  Loads all groups from the store and returns them

  Returns Promise<MarmotGroup<THistory, TMedia>[]>

unload

• unload(groupId: string | Uint8Array<ArrayBufferLike>): Promise<void>

  Unloads a group from the client but does not remove it from the store

  Parameters

  • groupId: string | Uint8Array<ArrayBufferLike>

  Returns Promise<void>

watch

• watch(): AsyncGenerator<MarmotGroup<THistory, TMedia>[]>

  Watches for changes to the groups in the store. Returns an async generator that yields the current list of groups whenever the store changes.

  Returns AsyncGenerator<MarmotGroup<THistory, TMedia>[]>