@armada/sdk / index / ArmadaSdkConfig

Interface: ArmadaSdkConfig

Defined in: src/index.ts:54

Properties

pool

readonly pool: PoolConfig

Defined in: src/index.ts:55

---

rpc

readonly rpc: RpcConfig

Defined in: src/index.ts:56

---

storage

readonly storage: StorageAdapter

Defined in: src/index.ts:57

---

prover

readonly prover: ProverAdapter

Defined in: src/index.ts:58

---

artifacts

readonly artifacts: ArtifactSource

Defined in: src/index.ts:59

---

telemetry?

readonly optional telemetry?: TelemetrySink

Defined in: src/index.ts:60

---

indexer?

readonly optional indexer?: object

Defined in: src/index.ts:66

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

---

dangerouslyAllowPlaintextStorage?

readonly optional dangerouslyAllowPlaintextStorage?: boolean

Defined in: src/index.ts:74

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.