Skip to content

@lelantos-org/sdk / advanced / NullifierStore

Class: NullifierStore ​

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:45

Constructors ​

Constructor ​

ts
new NullifierStore(fmd): NullifierStore;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:50

Parameters ​

ParameterType
fmdNullifierFeed

Returns ​

NullifierStore

Accessors ​

size ​

Get Signature ​

ts
get size(): number;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:67

Nullifiers mirrored so far.

Returns ​

number

Methods ​

has() ​

ts
has(nf): boolean;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:65

True if this nullifier was consumed on-chain as of the last sync. A stale mirror can only under-report, so this never reports a live note as spent (barring the truncation collision described at WIRE_BYTES).

Parameters ​

ParameterType
nfbigint

Returns ​

boolean


loadState() ​

ts
loadState(state): void;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:53

Parameters ​

ParameterType
stateNullifierStoreState

Returns ​

void


saveState() ​

ts
saveState(): NullifierStoreState;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:54

Returns ​

NullifierStoreState


sync() ​

ts
sync(opts?): Promise<NullifierSyncSummary>;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:59

Fetch chunks since the last sync, fold them into the set, then persist. Idempotent: the tail chunk is re-fetched every sync and already-mirrored entries are skipped by sequence.

Parameters ​

ParameterType
opts?NullifierSyncOpts

Returns ​

Promise<NullifierSyncSummary>


withPersistence() ​

ts
static withPersistence(fmd, persistence): Promise<NullifierStore>;

Defined in: @lelantos-org/sdk/dist/sync/nullifier-store.d.ts:52

Build a NullifierStore and restore any previously persisted state.

Parameters ​

ParameterType
fmdNullifierFeed
persistenceNullifierPersistence

Returns ​

Promise<NullifierStore>