Interface SupplyParameters

Parameters for supply operations SupplyParameters

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

Properties

amount asset customPayloadRecipient? customPayloadSaturationFlag? forwardAmount? includeUserCode payload queryID responseAddress? returnRepayRemainingsFlag? subaccountId? userAddress

Properties

Readonlyamount

amount: bigint

Amount to supply (must be positive)

Readonlyasset

asset: PoolAssetConfig

Asset configuration for the supply operation

Optional ReadonlycustomPayloadRecipient

customPayloadRecipient?: Address

Optional custom payload recipient address

Optional 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

Optional ReadonlyresponseAddress

responseAddress?: Address

Optional address for operation response

Optional 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 supply

Settings

Member Visibility

On This Page

Properties