Lelantos SDK

Appearance

@lelantos-org/sdk / index / Balance

Interface: Balance ​

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

One asset's shielded balance, split by what a single spend can reach.

total === spendable + withheld.reserved + withheld.cooldown + withheld.dust + withheld.slots.

Properties ​

asset ​

ts
asset: AssetInfo;

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

spendable ​

ts
spendable: CircuitAmount;

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

What one spend can cover with no fee reserved: spendableMax(asset).max. For a fee-aware figure call spendableMax with kind.

syncedAt ​

ts
syncedAt: Date | undefined;

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

When the notes behind this figure last synced; undefined before the first sync.

total ​

ts
total: CircuitAmount;

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

Every unspent note. On a spentKnown: false wallet, everything ever received.

withheld ​

ts
withheld: WithheldValue;

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

  • reserved: leased by an in-flight spend or pending an unknown outcome;
  • cooldown: arrived too recently (inert without a chain tip);
  • dust: below the dust threshold;
  • slots: beyond the circuit's input arity; merging notes (autoConsolidate) recovers it.