Lelantos SDK

Appearance

@lelantos-org/sdk / index / WithheldValue

Interface: WithheldValue ​

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

Value held back from a spend, by the rule that held it.

Plain bigint: CircuitAmount is a subtype of bigint, so a union with it would erase the brand.

Properties ​

cooldown ​

ts
cooldown: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/selection/types.d.ts:85

Too recently seen to have cleared the spend cooldown.

dust ​

ts
dust: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/selection/types.d.ts:83

Below the dust threshold.

reserved ​

ts
reserved: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/selection/types.d.ts:81

Held by an in-flight spend, or reserved by a submit of unknown outcome.

slots ​

ts
slots: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/selection/types.d.ts:94

Spendable, but beyond the circuit's input arity: a balance spread across more than maxInputs notes has a remainder no single spend can reach. Recovered by consolidation, not by waiting.

Depends on maxInputs, so partitionSpendable leaves it 0n and spendableMax fills it in.