Interface WithdrawParameters

Parameters for withdraw operations WithdrawParameters

interface WithdrawParameters {
    amount: bigint;
    amountToTransfer: bigint;
    asset: PoolAssetConfig;
    customPayloadSaturationFlag: boolean;
    forwardAmount?: bigint;
    includeUserCode: boolean;
    payload: Cell;
    queryID: bigint;
    returnRepayRemainingsFlag: boolean;
    subaccountId?: number;
    userAddress: Address;
}

Hierarchy (View Summary)

Properties

amount amountToTransfer asset customPayloadSaturationFlag forwardAmount? includeUserCode payload queryID returnRepayRemainingsFlag subaccountId? userAddress

Properties

Readonlyamount

amount: bigint

Amount to withdraw (must be positive)

ReadonlyamountToTransfer

amountToTransfer: bigint

Actual amount to transfer after calculations

Readonlyasset

asset: PoolAssetConfig

Asset configuration for the withdrawal

ReadonlycustomPayloadSaturationFlag

customPayloadSaturationFlag: boolean

Whether to saturate custom payload

Optional ReadonlyforwardAmount

forwardAmount?: bigint

Optional forward amount for transaction fees

ReadonlyincludeUserCode

includeUserCode: boolean

Whether to include user contract code update

Readonlypayload

payload: Cell

Operation payload cell

ReadonlyqueryID

queryID: bigint

Unique identifier for this operation

ReadonlyreturnRepayRemainingsFlag

returnRepayRemainingsFlag: boolean

Whether to return repay remainings

Optional ReadonlysubaccountId

subaccountId?: number

Optional subaccount identifier (0-255)

ReadonlyuserAddress

userAddress: Address

Address of the user performing the withdrawal

Settings

Member Visibility

On This Page

Properties