GroupStateStoreTransaction
Defined in: packages/core/src/group-state-store.ts:155
Properties
Section titled “Properties”baseRevision
Section titled “baseRevision”
readonlybaseRevision:number
Defined in: packages/core/src/group-state-store.ts:156
consumedKeyPackageRefs
Section titled “consumedKeyPackageRefs”
readonlyconsumedKeyPackageRefs: readonlyUint8Array<ArrayBufferLike>[]
Defined in: packages/core/src/group-state-store.ts:160
encryptedState
Section titled “encryptedState”
readonlyencryptedState:EncryptedGroupState|undefined
Defined in: packages/core/src/group-state-store.ts:157
forkEvidence
Section titled “forkEvidence”
readonlyforkEvidence:GroupStateForkEvidence|undefined
Defined in: packages/core/src/group-state-store.ts:163
outbox
Section titled “outbox”
readonlyoutbox: readonlyGroupStateOutboxEntry[]
Defined in: packages/core/src/group-state-store.ts:161
pendingKeyPackageRequests
Section titled “pendingKeyPackageRequests”
readonlypendingKeyPackageRequests: readonlyGroupStatePendingKeyPackageRequest[]
Defined in: packages/core/src/group-state-store.ts:159
pendingKeyPackages
Section titled “pendingKeyPackages”
readonlypendingKeyPackages: readonlyEncryptedKeyPackageState[]
Defined in: packages/core/src/group-state-store.ts:158
replay
Section titled “replay”
readonlyreplay: readonlyGroupStateReplayEntry[]
Defined in: packages/core/src/group-state-store.ts:162
Methods
Section titled “Methods”bindPendingKeyPackageRequest()
Section titled “bindPendingKeyPackageRequest()”bindPendingKeyPackageRequest(
request):boolean
Defined in: packages/core/src/group-state-store.ts:175
Binds one operation and request commitment to an existing pending state.
Parameters
Section titled “Parameters”request
Section titled “request”GroupStatePendingKeyPackageRequest
Returns
Section titled “Returns”boolean
consumePendingKeyPackage()
Section titled “consumePendingKeyPackage()”consumePendingKeyPackage(
reference):EncryptedKeyPackageState
Defined in: packages/core/src/group-state-store.ts:185
Atomically moves a pending package to consumed and returns a strict clone. Its pending request binding is removed in the same transaction. Missing, previously consumed, conflicting, and over-capacity references fail closed. Consumed references cannot be removed or made pending again.
Parameters
Section titled “Parameters”reference
Section titled “reference”Uint8Array
Returns
Section titled “Returns”enqueueOutbox()
Section titled “enqueueOutbox()”enqueueOutbox(
entry):boolean
Defined in: packages/core/src/group-state-store.ts:186
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
getPendingKeyPackage()
Section titled “getPendingKeyPackage()”getPendingKeyPackage(
reference):EncryptedKeyPackageState|undefined
Defined in: packages/core/src/group-state-store.ts:166
Returns a strict serialized clone, never the store’s live envelope.
Parameters
Section titled “Parameters”reference
Section titled “reference”Uint8Array
Returns
Section titled “Returns”EncryptedKeyPackageState | undefined
getPendingKeyPackageRequest()
Section titled “getPendingKeyPackageRequest()”getPendingKeyPackageRequest(
operationId):GroupStatePendingKeyPackageRequest|undefined
Defined in: packages/core/src/group-state-store.ts:171
Parameters
Section titled “Parameters”operationId
Section titled “operationId”Uint8Array
Returns
Section titled “Returns”GroupStatePendingKeyPackageRequest | undefined
hasConsumedKeyPackage()
Section titled “hasConsumedKeyPackage()”hasConsumedKeyPackage(
reference):boolean
Defined in: packages/core/src/group-state-store.ts:178
Parameters
Section titled “Parameters”reference
Section titled “reference”Uint8Array
Returns
Section titled “Returns”boolean
hasReplayRecord()
Section titled “hasReplayRecord()”hasReplayRecord(
recordId):boolean
Defined in: packages/core/src/group-state-store.ts:188
Parameters
Section titled “Parameters”recordId
Section titled “recordId”Uint8Array
Returns
Section titled “Returns”boolean
markFork()
Section titled “markFork()”markFork(
evidence):boolean
Defined in: packages/core/src/group-state-store.ts:191
Parameters
Section titled “Parameters”evidence
Section titled “evidence”Returns
Section titled “Returns”boolean
markReplay()
Section titled “markReplay()”markReplay(
entry):boolean
Defined in: packages/core/src/group-state-store.ts:189
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
putPendingKeyPackage()
Section titled “putPendingKeyPackage()”putPendingKeyPackage(
state):boolean
Defined in: packages/core/src/group-state-store.ts:170
Inserts an encrypted package; an identical existing envelope is a no-op.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
removeOutbox()
Section titled “removeOutbox()”removeOutbox(
id):boolean
Defined in: packages/core/src/group-state-store.ts:187
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”boolean
removeReplay()
Section titled “removeReplay()”removeReplay(
recordId):boolean
Defined in: packages/core/src/group-state-store.ts:190
Parameters
Section titled “Parameters”recordId
Section titled “recordId”Uint8Array
Returns
Section titled “Returns”boolean
setEncryptedState()
Section titled “setEncryptedState()”setEncryptedState(
state):void
Defined in: packages/core/src/group-state-store.ts:164
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void