Lelantos SDK

Appearance

@lelantos-org/sdk / index / TransferResult

Interface: TransferResult ​

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:46

Result of wallet.transfer. Spends 1-2 input notes; the outputs are the recipient's note, change back to self, and the relayer's fee note if one was charged — in a random order, so read TransferResult.recipientCommitment rather than indexing commitments.

Extends ​

  • TxResultBase

Properties ​

change ​

ts
change: CircuitAmount;

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:51

commitments ​

ts
commitments: Hex32[];

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:12

Commitments created by the tx, in output-slot order. One per output slot of the transact circuit: four at the default 4×4 shape.

Inherited from ​

ts
TxResultBase.commitments

inputSum ​

ts
inputSum: CircuitAmount;

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:49

kind ​

ts
kind: "transfer";

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:47

nonZeroCommitments ​

ts
nonZeroCommitments: Hex32[];

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:18

Subset of commitments with non-zero value (zero-value outputs are circuit pads that no party's scanner accepts). Receiver-side waiters should filter this against their own commitments.

Inherited from ​

ts
TxResultBase.nonZeroCommitments

ownCommitments ​

ts
ownCommitments: Hex32[];

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:20

Subset of commitments recoverable via this wallet's FMD scan.

Inherited from ​

ts
TxResultBase.ownCommitments

ownInflow ​

ts
ownInflow: CircuitAmount;

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:22

Total value of own outputs; pending balance once FMD indexes them.

Inherited from ​

ts
TxResultBase.ownInflow

recipientCommitment ​

ts
recipientCommitment: Hex32;

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:60

The commitment holding the recipient's note.

Output slots are shuffled — their order is what would otherwise publish which commitment is the payee's — so there is no fixed index to read this off. Handing it to the payee is not a leak: they recover the same note by scanning.

sent ​

ts
sent: CircuitAmount;

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:50

spent ​

ts
spent: string[];

Defined in: @lelantos-org/sdk/dist/wallet/result.d.ts:48

txHash ​

ts
txHash: Hex32;

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

Inherited from ​

ts
TxResultBase.txHash