@armada/sdk

Appearance

@armada/sdk / index / ArmadaSdkConfig

Interface: ArmadaSdkConfig ​

Defined in: src/index.ts:69

Properties ​

pool ​

readonly pool: PoolConfig

Defined in: src/index.ts:70

rpc ​

readonly rpc: RpcConfig

Defined in: src/index.ts:71

storage ​

readonly storage: StorageAdapter

Defined in: src/index.ts:72

prover ​

readonly prover: ProverAdapter

Defined in: src/index.ts:73

artifacts ​

readonly artifacts: ArtifactSource

Defined in: src/index.ts:74

telemetry? ​

readonly optional telemetry?: TelemetrySink

Defined in: src/index.ts:75

indexer? ​

readonly optional indexer?: object

Defined in: src/index.ts:81

Optional native quick-sync indexer (e.g. the relayer-v2 watcher) serving the /v2/quick-sync wire contract. When set it is the primary event source, with RPC getLogs covering the tail and verifying results against the on-chain root. Omit to sync purely from RPC.

url ​

readonly url: string

fetchFn? ​

readonly optional fetchFn?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Inject a custom fetch (proxy, instrumentation, tests). Defaults to the global fetch.

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

RequestInfo | URL

init? ​

RequestInit

Returns ​

Promise<Response>

Call Signature ​

(input, init?): Promise<Response>

MDN Reference

Parameters ​
input ​

string | Request | URL

init? ​

RequestInit

Returns ​

Promise<Response>

dangerouslyAllowPlaintextStorage? ​

readonly optional dangerouslyAllowPlaintextStorage?: boolean

Defined in: src/index.ts:93

Escape hatch that disables the SDK's at-rest encryption (SPEC §4.3). Decrypted note data, TXO records, balances, and history are AEAD-encrypted at rest by default under a per-wallet key the SDK derives itself — the caller's storage adapter is auto-wrapped, so plaintext never reaches disk without setting this flag. Set it ONLY for ephemeral/test stores where at-rest secrecy is a non-goal; in production it defeats WS7.2 Option B.