TonTransferOptions
Defined in: wallet-ton/src/types.ts:106
A native TON or jetton transfer. Amount in nanotons or the jetton’s base units.
Properties
Section titled “Properties”allowForeignResponseDestination?
Section titled “allowForeignResponseDestination?”
optionalallowForeignResponseDestination?:boolean
Defined in: wallet-ton/src/types.ts:130
Jetton only: let responseDestination be another address than this wallet. Off by default.
amount
Section titled “amount”amount:
string|number|bigint
Defined in: wallet-ton/src/types.ts:111
attachedValue?
Section titled “attachedValue?”
optionalattachedValue?:string|number|bigint
Defined in: wallet-ton/src/types.ts:134
Jetton only: nanotons attached to the jetton-wallet call (default config.jettonAttachedValue + forwardTonAmount).
customPayload?
Section titled “customPayload?”
optionalcustomPayload?:Cell
Defined in: wallet-ton/src/types.ts:122
Jetton only: custom payload cell (rarely needed; e.g. mintless jettons).
forwardPayload?
Section titled “forwardPayload?”
optionalforwardPayload?:string|Cell
Defined in: wallet-ton/src/types.ts:115
Jetton only: forward payload — a text comment or a Cell (DEX / escrow payloads).
forwardTonAmount?
Section titled “forwardTonAmount?”
optionalforwardTonAmount?:string|number|bigint
Defined in: wallet-ton/src/types.ts:113
Jetton only: nanotons forwarded to the recipient with the transfer notification (default 1).
optionalmemo?:string
Defined in: wallet-ton/src/types.ts:120
Text memo (a deposit memo, an exchange tag). Jetton: sent as the forward-payload comment (TEP-74);
native TON: the message comment. Cannot be combined with forwardPayload.
queryId?
Section titled “queryId?”
optionalqueryId?:number|bigint
Defined in: wallet-ton/src/types.ts:132
Jetton only: query id (default random).
recipient
Section titled “recipient”recipient:
string
Defined in: wallet-ton/src/types.ts:110
Wallet address that receives (for a jetton, its owner, not its jetton wallet).
responseDestination?
Section titled “responseDestination?”
optionalresponseDestination?:string
Defined in: wallet-ton/src/types.ts:128
Jetton only: where excess TON returns (default: this wallet). Another address is refused
unless allowForeignResponseDestination is set: it receives TON the policies’ recipient
check never sees.
token?
Section titled “token?”
optionaltoken?:string
Defined in: wallet-ton/src/types.ts:108
Jetton master address. Omit for native TON.