@lelantos-org/sdk / wallet / NoteCache
Class: NoteCache
Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:28
Where a sync writes what it finds.
Deliberately not a NoteStore: a store hands back a fresh NotesFile on every load(), so a sync that owned one would be mutating a second copy of state the wallet already holds in NoteCache — and whichever of the two saved last would erase the other's writes. The sink is the live file, so exactly one NotesFile exists per wallet. NoteCache implements it.
Implements
Constructors
Constructor
new NoteCache(store, initial): NoteCache;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:45
Parameters
| Parameter | Type |
|---|---|
store | NoteStore |
initial | NotesFile |
Returns
NoteCache
Properties
store
readonly store: NoteStore;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:29
Accessors
file
Get Signature
get file(): NotesFile;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:47
The live notes file. Read for the resume cursor; never replaced.
Returns
The live notes file. Read for the resume cursor; never replaced.
Implementation of
notes
Get Signature
get notes(): readonly StoredNote[];Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:48
Returns
readonly StoredNote[]
Methods
addHits()
addHits(hits): object;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:66
Append scan hits to the live file. Synchronous, so it cannot interleave with a queued write; persistence is deferred to checkpoint so a sync still batches its store writes.
Parameters
| Parameter | Type |
|---|---|
hits | ScanHit[] |
Returns
object
added
added: StoredNote[];skipped
skipped: number;Implementation of
checkpoint()
checkpoint(cursor): Promise<void>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:71
Persist the current notes together with the sync resume cursor.
Parameters
| Parameter | Type |
|---|---|
cursor | number |
Returns
Promise<void>
Implementation of
compact()
compact(): Promise<{
removed: number;
}>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:58
Drop notes flagged spent: true. Returns removed count.
Returns
Promise<{ removed: number; }>
markPendingSpend()
markPendingSpend(ids): Promise<void>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:78
Reserve every note whose id is in ids against a spend of unknown outcome, then persist. See StoredNote.pendingSpendAt.
Parameters
| Parameter | Type |
|---|---|
ids | Iterable<string> |
Returns
Promise<void>
markSpent()
markSpent(ids): Promise<void>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:73
Flip spent for every note whose id is in ids, then persist.
Parameters
| Parameter | Type |
|---|---|
ids | Iterable<string> |
Returns
Promise<void>
open()
static open(store): Promise<NoteCache>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:46
Parameters
| Parameter | Type |
|---|---|
store | NoteStore |
Returns
Promise<NoteCache>
reconcile()
reconcile(rules): Promise<void>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:88
Apply spent-set reconciliation. spent(note) returns true when the note's nullifier was observed on-chain; release(note) returns true when its reservation no longer stands for anything — either that same observation, or expiry.
Both in one pass, so a sync writes the notes file once and cannot leave a note marked spent while it still carries a reservation.
Parameters
| Parameter | Type |
|---|---|
rules | { release: (note) => boolean; spent: (note) => boolean; } |
rules.release | (note) => boolean |
rules.spent | (note) => boolean |
Returns
Promise<void>
refresh()
refresh(): Promise<void>;Defined in: @lelantos-org/sdk/dist/wallet/note-cache.d.ts:56
Replace the in-memory snapshot with the store's current state.
For external mutation only. A sync does not need it: syncWallet writes through this cache via NoteSink, so the snapshot is already current when it returns.
Returns
Promise<void>