@armada/sdk / storage / StorageAdapter
Interface: StorageAdapter
Defined in: src/storage/index.ts:32
Raw environment KV. The SDK provides IndexedDBStorageAdapter (browser) and a classic-level adapter (node). Higher layers wrap this with encryption + schema versioning; chain-public data may be stored plaintext, decrypted note data is AEAD-encrypted under a rootSecret-derived key. Multi-instance safe: no process-wide lock files.
Methods
open()
open(
namespace):Promise<{reset:boolean; }>
Defined in: src/storage/index.ts:39
Bind the store to namespace. Returns { reset: true } when a namespace mismatch (a redeploy under a preserved identity) triggered a chain-state reset, so the instance can surface it as telemetry. Opening an already-open adapter under a DIFFERENT namespace throws StorageConflictError (it would wipe the chain state of whoever is using it); the same namespace again is a no-op.
Parameters
namespace
Returns
Promise<{ reset: boolean; }>
get()
get(
key):Promise<Uint8Array<ArrayBufferLike> |undefined>
Defined in: src/storage/index.ts:40
Parameters
key
string
Returns
Promise<Uint8Array<ArrayBufferLike> | undefined>
put()
put(
key,value):Promise<void>
Defined in: src/storage/index.ts:41
Parameters
key
string
value
Uint8Array
Returns
Promise<void>
del()
del(
key):Promise<void>
Defined in: src/storage/index.ts:42
Parameters
key
string
Returns
Promise<void>
update()
update(
key,fn,options?):Promise<Uint8Array<ArrayBufferLike> |undefined>
Defined in: src/storage/index.ts:48
Atomic read-modify-write: fn gets the current value (or undefined) and returns the new one (undefined deletes the record). Atomic with respect to every other write to this adapter. fn MUST be synchronous: an IndexedDB transaction commits as soon as it awaits anything else. Resolves to the value stored.
Parameters
key
string
fn
(current) => Uint8Array<ArrayBufferLike> | undefined
options?
Returns
Promise<Uint8Array<ArrayBufferLike> | undefined>
batch()
batch(
ops,options?):Promise<void>
Defined in: src/storage/index.ts:54
Apply ops in order as one atomic write: all of them land, or none do.
Parameters
ops
readonly StorageOp[]
options?
Returns
Promise<void>
list()
list(
prefix):AsyncIterable<{key:string;value:Uint8Array; }>
Defined in: src/storage/index.ts:56
Iterate entries whose key starts with prefix, in key order.
Parameters
prefix
string
Returns
AsyncIterable<{ key: string; value: Uint8Array; }>
resetChainState()
resetChainState():
Promise<void>
Defined in: src/storage/index.ts:58
Targeted reset of chain-derived namespaces, preserving identity records.
Returns
Promise<void>
close()
close():
Promise<void>
Defined in: src/storage/index.ts:59
Returns
Promise<void>