KeychainProvider
Defined in: packages/core/src/keychain-provider.ts:9
Factory for Keychain objects.
Type Parameters
Section titled “Type Parameters”KeychainChange
Section titled “KeychainChange”KeychainChange
Type of a block of change(s) describing edits made to the document keychain.
DocumentKey
Section titled “DocumentKey”DocumentKey
Type of a document encryption key.
Properties
Section titled “Properties”keyIDLength
Section titled “keyIDLength”
readonlykeyIDLength:number
Defined in: packages/core/src/keychain-provider.ts:28
Number of bytes reserved on the wire for the key ID prefix on every
encrypted block, and the byte width of all key IDs emitted by
Keychain.add() / Keychain.addEpochKey(). The two provisioning
paths use the SAME width so the wire-format key-ID prefix is a
single fixed size and no truncation step exists between
BeeKEM-derived epoch IDs and the keychain’s storage key.
Methods
Section titled “Methods”initialize()
Section titled “initialize()”initialize():
Keychain<KeychainChange,DocumentKey>
Defined in: packages/core/src/keychain-provider.ts:18
Construct a new Keychain object. Each call must return an independent keychain that shares no mutable state with any other keychain; invitation bootstrap stages untrusted key material in a fresh instance and relies on discarding it when the bootstrap fails.
Returns
Section titled “Returns”Keychain<KeychainChange, DocumentKey>
A new Keychain object.