@softseco/confidential-transfers - v3.3.0
    Preparing search index...

    Type Alias WithdrawInput

    WithdrawInput: SendOptions & {
        amount: number | bigint;
        decimals: number;
        keys?: ConfidentialKeypairs;
        mint: Address;
        owner: TransactionSigner;
        payer: TransactionSigner;
        programAddress?: Address;
        rpc: Rpc<SolanaRpcApi>;
        rpcSubscriptions: RpcSubscriptions<SolanaRpcSubscriptionsApi>;
        token?: Address;
    }

    Type Declaration

    • amount: number | bigint

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

    • 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 the proof accounts (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).

    • Optionaltoken?: Address

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