Type Alias WithdrawInput

Type Declaration

• amount: number | bigint

  Amount (base units) to move from the confidential available balance to the public balance.

• OptionalapplyPending?: boolean

  Withdraw from what is pending too (default true): the one-transaction withdraw applies the pending balance first, in the same transaction, as transfer() does. With proof accounts only the available balance can be withdrawn.

• decimals: number

  Mint decimals (must match the mint).

• Optionalkeys?: ConfidentialKeypairs

  The owner's keys from deriveConfidentialKeys; skips the message signature.

• mint: Address

  Mint configured for confidential transfers.

• owner: TransactionSigner

  Owner of the token account: the withdraw authority, and the key source unless keys is given.

• payer: TransactionSigner

  Pays the transaction fees, and the rent of proof accounts if any (refunded when they close).

• OptionalprogramAddress?: Address

  Token program. Default: Token-2022.

• rpc: Rpc<SolanaRpcApi>

  RPC client, e.g. createSolanaRpc(url).

• rpcSubscriptions: RpcSubscriptions<SolanaRpcSubscriptionsApi>

  Used to confirm the transaction(s).

• OptionalsingleTransaction?: boolean

  Send the withdraw as one transaction with its proofs inside (default true). That needs a v1 transaction (up to 4,096 bytes), which Solana accepts since September 2026. Set false for a wallet or RPC that cannot handle v1 transactions: the proofs then go into proof accounts, as before 1.0.0. The SDK falls back to proof accounts by itself when the one transaction would be too large.

• Optionaltoken?: Address

  Token account to withdraw from (defaults to the owner's ATA).