buildWithdrawRequest

Build a submit-ready withdrawal proof from committed notes. Proving runs locally; the result can be submitted by wallet or relay.

Import

import { buildWithdrawRequest } from "@0xcurvy/curvy-sdk/actions";

Usage

const w = await buildWithdrawRequest({ notes, ownerBjjPrivateKeyHex, destinationAddress, tokenId: 1n });
await w.submit({ walletClient });

Signature

function buildWithdrawRequest(parameters: BuildWithdrawRequestParameters): Promise<SubmittableSubmission>

Returns

Promise<SubmittableSubmission>

The action resolves or returns the value shown in the signature.

Parameters

notes

• Type: Note[]
• Required: yes

One to maxInputs committed notes with the same token and owner.

const result = await buildWithdrawRequest({
  notes, 
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
});

ownerBjjPrivateKeyHex

• Type: string
• Required: yes

BabyJubjub private key (hex) that owns the notes and signs the withdrawal.

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex, 
  destinationAddress,
  tokenId,
});

destinationAddress

• Type: bigint
• Required: yes

Destination EOA the vault pays out to (as a bigint address).

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress, 
  tokenId,
});

tokenId

• Type: bigint
• Required: yes

The token to withdraw (must match every input note).

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId, 
});

notesTree

• Type: MerkleTree
• Required: no

The committed notes tree (omit when supplied is set).

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
  notesTree, 
});

supplied

• Type: SuppliedInclusionProofs
• Required: no

Lean-client alternative: pre-built inclusion proofs at one root.

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
  supplied, 
});

networkSlug

• Type: string
• Required: no

Network whose deployed aggregator/circuit to target; defaults to the active network.

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
  networkSlug, 
});

config

• Type: CurvyConfig
• Required: no

Curvy config to use. Defaults to the ambient config.

const result = await buildWithdrawRequest({
  notes,
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
  config, 
});

Errors

Errors from config resolution and the underlying SDK operation are propagated to the caller.

Related

• Interacting with assets guide
• proveWithdrawal — Prove a withdrawal: resolve the network's withdrawal circuit artifacts (from its CircuitConfig), flatten the supplied witness, and run it through the config's prover (default Rust/arkworks).
• submitToChain — Submit a built aggregator proof on-chain with the caller's wallet client.
• relaySubmission — Relay a built proof via the SDK's relay service — no EVM wallet, no gas.
• waitForRelay — Poll a relayed submission to the requested lifecycle milestone.

Source

packages/@0xcurvy/sdk/src/actions/aggregator/buildWithdrawRequest.ts