@lelantos-org/sdk / advanced / WatchWalletConfig
Interface: WatchWalletConfig
Defined in: @lelantos-org/sdk/dist/wallet/watch/config.d.ts:12
Configuration for createWatchWallet: a Pick of WalletConfig, so a field added there must be opted into here. Fields serving a proof, a submission or the Merkle tree are excluded.
Extends
Pick<WalletConfig, |"chainId"|"fmdUrl"|"noteSource"|"noteStore"|"nullifierStore"|"nullifierPersistence"|"scanner"|"syncStrategy"|"http"|"denominations"|"feeBps">
Extended by
Properties
allowDetectionKeyRelease?
optional allowDetectionKeyRelease?: boolean;Defined in: @lelantos-org/sdk/dist/wallet/watch/config.d.ts:25
Permit syncStrategy: { kind: "matches" }. Off by default.
A matches subscription posts the γ detection scalars, from which the server recovers dk and detects the account's incoming notes permanently. The secret released is the owner's, not the viewer's.
chainId
chainId: bigint;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:29
Bound into the proof and the FMD query.
Inherited from
denominations?
optional denominations?: boolean;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:124
Whether this wallet uses withdrawal ladders. Defaults to true: each asset's ladder is derived from its scale and decimals; see protocol/denominations.
false disables ladders everywhere: change splits evenly, previewWithdraw reports no ladder, and redenominate is a no-op. Applied when an AssetInfo is resolved, so every path uses the same policy.
Inherited from
feeBps?
optional feeBps?: FeeOverride;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:54
Replaces the protocol fee rates the pool reports, for every asset. 1 bp = 0.01%.
A bigint sets both legs; { depositBps, withdrawBps } sets them separately. Applied when an AssetInfo is resolved, so deposit, withdraw, swap and previewWithdraw use the same rates.
Intended for pools whose rates the SDK cannot read: forks, fixtures, or chains without a deployed registry. Against a live pool, quotes become wrong as soon as the owner changes a rate.
Inherited from
fmdUrl?
optional fmdUrl?: string;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:81
Required if noteSource is not provided.
Inherited from
http?
optional http?: HttpOptions;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:71
Transport options for every default HTTP pluggable (the FMD client, the relayer submitter and the quoter): fetch, timeouts, retries, onRetry and extra headers. Ignored for pre-built pluggables.
Inherited from
noteSource?
optional noteSource?: NoteSource;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:92
Defaults to fmd-webserver.
Inherited from
noteStore?
optional noteStore?: NoteStore;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:90
Defaults to in-memory.
Inherited from
nullifierPersistence?
optional nullifierPersistence?: NullifierPersistence;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:103
As treePersistence, for the spent set. Ignored when nullifierStore is set.
Inherited from
WalletConfig.nullifierPersistence
nullifierStore?
optional nullifierStore?: NullifierStore;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:101
Defaults to a NullifierStore backed by fmd-webserver nullifier chunks.
Inherited from
reader?
optional reader?: ChainReader;Defined in: @lelantos-org/sdk/dist/wallet/watch/config.d.ts:17
Chain reads, for asset metadata and the chain tip only. When omitted, asset(), assets() and balance() reject WALLET_CONFIG and no RPC is contacted.
scanner?
optional scanner?: Scanner;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:126
Defaults to LocalScanner. WorkerPoolScanner scans in parallel off the main thread.
Inherited from
syncStrategy?
optional syncStrategy?: SyncStrategy;Defined in: @lelantos-org/sdk/dist/wallet/types/config.d.ts:105
Default { kind: "full" }.