Lelantos SDK

Appearance

@lelantos-org/sdk / index / SyncOptions

Interface: SyncOptions ​

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:28

Properties ​

onProgress? ​

ts
optional onProgress?: (p) => void;

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:41

Parameters ​

ParameterType
pSyncProgress

Returns ​

void

pageSize? ​

ts
optional pageSize?: number;

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:38

Feed page size. Not a cap on what is fetched.

reload? ​

ts
optional reload?: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:36

Re-read the NoteStore first, after another tab or process wrote to it.

scope? ​

ts
optional scope?: "full" | "notes";

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:34

  • "full" (default on a spending wallet): notes, spent set and Merkle tree, then reconcile.
  • "notes": notes and spent set, then reconcile. Enough for balances; a spend syncs the tree itself. A watch wallet always syncs "notes".

signal? ​

ts
optional signal?: AbortSignal;

Defined in: @lelantos-org/sdk/dist/wallet/types/sync.d.ts:40

Stops at the next page boundary; progress so far is kept. Rejects with signal.reason.