@armada/sdk

Appearance

@armada/sdk / storage / StorageAdapter

Interface: StorageAdapter ​

Defined in: src/storage/index.ts:22

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:27

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.

Parameters ​

namespace ​

StorageNamespace

Returns ​

Promise<{ reset: boolean; }>

get() ​

get(key): Promise<Uint8Array<ArrayBufferLike> | undefined>

Defined in: src/storage/index.ts:28

Parameters ​

key ​

string

Returns ​

Promise<Uint8Array<ArrayBufferLike> | undefined>

put() ​

put(key, value): Promise<void>

Defined in: src/storage/index.ts:29

Parameters ​

key ​

string

value ​

Uint8Array

Returns ​

Promise<void>

del() ​

del(key): Promise<void>

Defined in: src/storage/index.ts:30

Parameters ​

key ​

string

Returns ​

Promise<void>

list() ​

list(prefix): AsyncIterable<{ key: string; value: Uint8Array; }>

Defined in: src/storage/index.ts:32

Iterate entries whose key starts with prefix (ordered).

Parameters ​

prefix ​

string

Returns ​

AsyncIterable<{ key: string; value: Uint8Array; }>

resetChainState() ​

resetChainState(): Promise<void>

Defined in: src/storage/index.ts:34

Targeted reset of chain-derived namespaces, preserving identity records.

Returns ​

Promise<void>

close() ​

close(): Promise<void>

Defined in: src/storage/index.ts:35

Returns ​

Promise<void>