Skip to content

@lelantos-org/sdk / internal / ConsolidateHost

Interface: ConsolidateHost ​

Defined in: @lelantos-org/sdk/dist/wallet/ops/consolidate.d.ts:5

The slice of a wallet consolidation drives.

Extends ​

  • SelfTransferHost

Properties ​

address ​

ts
readonly address: ShieldedAddress;

Defined in: @lelantos-org/sdk/dist/wallet/tx/self-transfer.d.ts:7

Own shielded address; the transfer pays it.

Inherited from ​

ts
SelfTransferHost.address

maxInputs ​

ts
readonly maxInputs: number;

Defined in: @lelantos-org/sdk/dist/wallet/tx/self-transfer.d.ts:9

Input arity of the configured circuit: every slot may be used.

Inherited from ​

ts
SelfTransferHost.maxInputs

Methods ​

awaitCommitments() ​

ts
awaitCommitments(cms): Promise<unknown>;

Defined in: @lelantos-org/sdk/dist/wallet/tx/self-transfer.d.ts:11

Parameters ​

ParameterType
cmsstring[]

Returns ​

Promise<unknown>

Inherited from ​

ts
SelfTransferHost.awaitCommitments

blockNumber() ​

ts
blockNumber(): Promise<number | undefined>;

Defined in: @lelantos-org/sdk/dist/wallet/ops/consolidate.d.ts:7

Chain tip, when the adapter can report one.

Returns ​

Promise<number | undefined>


spendableMax() ​

ts
spendableMax(asset, only): Promise<{
  fee: bigint;
  max: bigint;
}>;

Defined in: @lelantos-org/sdk/dist/wallet/ops/consolidate.d.ts:15

spendableMax over the notes only names: the most one transfer can send out of them, and the relayer fee reserved from it. A self-transfer names no fee asset, so the fee is charged in asset or not at all; fee is 0n when nothing is reserved.

Parameters ​

ParameterType
assetbigint
onlyreadonly string[]

Returns ​

Promise<{ fee: bigint; max: bigint; }>


storedNotes() ​

ts
storedNotes(): readonly StoredNote[];

Defined in: @lelantos-org/sdk/dist/wallet/ops/consolidate.d.ts:9

The in-memory note set, which carries firstSeenBlock.

Returns ​

readonly StoredNote[]


transfer() ​

ts
transfer(args): Promise<TransferResult>;

Defined in: @lelantos-org/sdk/dist/wallet/tx/self-transfer.d.ts:10

Parameters ​

ParameterType
argsTransferOptions

Returns ​

Promise<TransferResult>

Inherited from ​

ts
SelfTransferHost.transfer