withdraw

One-call WITHDRAW: build the proof from committed notes and send it in one shot, via the user's wallet or the relay service. Use buildWithdrawRequest + the .submit()/.relay() sugar when you want the proof object first.

Import

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

Usage

const { receipt } = await withdraw({ notes, ownerBjjPrivateKeyHex,
  destinationAddress, tokenId: 1n, via: { kind: "wallet", walletClient } });

Signature

function withdraw(parameters: WithdrawParameters): Promise<ChainSubmitResult | RelaySubmitReturnType>

Returns

Promise<ChainSubmitResult | RelaySubmitReturnType>

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 withdraw({
  notes, 
  ownerBjjPrivateKeyHex,
  destinationAddress,
  tokenId,
  via,
});

ownerBjjPrivateKeyHex

• Type: string
• Required: yes

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

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

destinationAddress

• Type: bigint
• Required: yes

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

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

tokenId

• Type: bigint
• Required: yes

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

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

notesTree

• Type: MerkleTree
• Required: no

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

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

supplied

• Type: SuppliedInclusionProofs
• Required: no

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

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

networkSlug

• Type: string
• Required: no

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

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

config

• Type: CurvyConfig
• Required: no

Curvy config to use. Defaults to the ambient config.

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

via

• Type: SubmitVia
• Required: yes

Where to send the built proof: { kind: "wallet", walletClient } or { kind: "relay" }.

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

Errors

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

Related

• Interacting with assets guide
• aggregate — One-call AGGREGATE: build the proof from committed notes and send it in one shot, either via the user's wallet (via.kind === "wallet") or the relay service (via.kind === "relay").
• estimateAggregationCosts — Load the inputs needed to allocate an aggregation.

Source

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