Skip to main content

BalanceWithdraw

Input for withdrawing funds from an accumulator.

type BalanceWithdraw {
allowance: Address
funder: Address
reservation: WithdrawalReservation
type: MoveType
withdrawFrom: WithdrawFrom
}

Fields

BalanceWithdraw.allowance ● Address object

The allowance authorizing the withdrawal, if withdrawFrom is SENDER_ALLOWANCE. Use asTransactionObject to see it as this transaction referenced it.

BalanceWithdraw.funder ● Address object

The account whose funds are withdrawn, if withdrawFrom is SENDER_ALLOWANCE.

BalanceWithdraw.reservation ● WithdrawalReservation union

How much to withdraw from the accumulator.

BalanceWithdraw.type ● MoveType object

The type of the funds accumulator to withdraw from (e.g. 0x2::balance::Balance<0x2::sui::SUI>).

BalanceWithdraw.withdrawFrom ● WithdrawFrom enum

The account to withdraw funds from.

Implemented By

TransactionInput union