Lelantos SDK

Appearance

@lelantos-org/sdk / bundle / SpendArgs

Interface: SpendArgs ​

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:5

Properties ​

asset ​

ts
asset: bigint;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:35

Inherited from ​

ts
BundleCommon.asset

chainId ​

ts
chainId: bigint;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:34

Inherited from ​

ts
BundleCommon.chainId

inputs ​

ts
inputs: InputSlots;

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:8

J ​

ts
J: WasmJubjub;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:33

Inherited from ​

ts
BundleCommon.J

kind ​

ts
kind: SpendKind;

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:7

Which on-chain entry point the relayer should call.

merkleRoot ​

ts
merkleRoot: bigint;

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:9

outputRandomness ​

ts
outputRandomness: readonly OutputRandomness[];

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:21

outputRecipients ​

ts
outputRecipients: readonly OutputRecipient[];

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:20

Recipient address per output slot (drives the FMD clue + ECDH). Change slots take the sender's own address.

outputs ​

ts
outputs: readonly Note[];

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:15

One note per output slot. For a transfer these are the send note and the change notes; for a withdraw all are change back to self. Together they must sum to total real input value − publicOut.

P ​

ts
P: Poseidon;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:32

Inherited from ​

ts
BundleCommon.P

payerAddress ​

ts
payerAddress: string;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:36

Inherited from ​

ts
BundleCommon.payerAddress

prover? ​

ts
optional prover?: Prover;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:46

Inherited from ​

ts
BundleCommon.prover

proverPaths? ​

ts
optional proverPaths?: ProverPaths;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:45

Pluggable prover. Pass either:

  • proverPaths: ProverPaths — the SDK builds a SnarkjsProver
  • prover: Prover — a custom backend (remote / worker / mock) Exactly one is required.

Inherited from ​

ts
BundleCommon.proverPaths

publicOut? ​

ts
optional publicOut?: bigint;

Defined in: @lelantos-org/sdk/dist/bundle/spend.d.ts:23

Value leaving the shielded pool. 0 for a transfer.

recipientAddress ​

ts
recipientAddress: string;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:38

Inherited from ​

ts
BundleCommon.recipientAddress

relayerAddress ​

ts
relayerAddress: string;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:37

Inherited from ​

ts
BundleCommon.relayerAddress

shape? ​

ts
optional shape?: CircuitShape;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:57

Circuit arity, when the caller knows it.

Optional because toCircomInput reads the shape off the array lengths and does not need telling. Supplying it buys a pre-flight check that the slot counts match the zkey about to be loaded — otherwise a 2-output spend against a 3x3 key builds a perfectly valid witness with the wrong number of public inputs and fails inside the prover.

Inherited from ​

ts
BundleCommon.shape

treeDepth ​

ts
treeDepth: number;

Defined in: @lelantos-org/sdk/dist/bundle/common.d.ts:47

Inherited from ​

ts
BundleCommon.treeDepth