Transfer Alien Token
Same as the last two examples, Alien tokens, such as USDT or others which are not EVM gas tokens such as WBNB or WETH, can be transferred to another EVM network via two methods. The first method involves manual asset releasing on an EVM network, while the second method automatically releases the assets on the EVM network. The code sample provided below demonstrates the implementation of your preferred approach.
In order to have a complete token bridging, if the EVM fees are paid with an Evm gas token, once you have initiated a transaction on this section, get your event address and use it to complete the token bridging on saveWithdrawAlien section.
To perform such an operation we need the Tip3 TokenRoot and TokenWalletUpgradable ABIs which are as follows :
TokenRoot Contract ABI
typescript
const TokenRootAbi = {
"ABI version": 2,
version: "2.2",
header: ["pubkey", "time", "expire"],
functions: [
{
name: "constructor",
inputs: [
{ name: "initialSupplyTo", type: "address" },
{ name: "initialSupply", type: "uint128" },
{ name: "deployWalletValue", type: "uint128" },
{ name: "mintDisabled", type: "bool" },
{ name: "burnByRootDisabled", type: "bool" },
{ name: "burnPaused", type: "bool" },
{ name: "remainingGasTo", type: "address" },
],
outputs: [],
},
{
name: "supportsInterface",
inputs: [
{ name: "answerId", type: "uint32" },
{ name: "interfaceID", type: "uint32" },
],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "disableMint",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "mintDisabled",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "burnTokens",
inputs: [
{ name: "amount", type: "uint128" },
{ name: "walletOwner", type: "address" },
{ name: "remainingGasTo", type: "address" },
{ name: "callbackTo", type: "address" },
{ name: "payload", type: "cell" },
],
outputs: [],
},
{
name: "disableBurnByRoot",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "burnByRootDisabled",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "burnPaused",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "setBurnPaused",
inputs: [
{ name: "answerId", type: "uint32" },
{ name: "paused", type: "bool" },
],
outputs: [{ name: "value0", type: "bool" }],
},
{
name: "transferOwnership",
inputs: [
{ name: "newOwner", type: "address" },
{ name: "remainingGasTo", type: "address" },
{
components: [
{ name: "value", type: "uint128" },
{ name: "payload", type: "cell" },
],
name: "callbacks",
type: "map(address,tuple)",
},
],
outputs: [],
},
{
name: "name",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "string" }],
},
{
name: "symbol",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "string" }],
},
{
name: "decimals",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "uint8" }],
},
{
name: "totalSupply",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "uint128" }],
},
{
name: "walletCode",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "cell" }],
},
{
name: "rootOwner",
inputs: [{ name: "answerId", type: "uint32" }],
outputs: [{ name: "value0", type: "address" }],
},
{
name: "walletOf",
inputs: [
{ name: "answerId", type: "uint32" },
{ name: "walletOwner", type: "address" },
],
outputs: [{ name: "value0", type: "address" }],
},
{
name: "deployWallet",
inputs: [
{ name: "answerId", type: "uint32" },
{ name: "walletOwner", type: "address" },
{ name: "deployWalletValue", type: "uint128" },
],
outputs: [{ name: "tokenWallet", type: "address" }],
},
{
name: "mint",
inputs: [
{ name: "amount", type: "uint128" },
{ name: "recipient", type: "address" },
{ name: "deployWalletValue", type: "uint128" },
{ name: "remainingGasTo", type: "address" },
{ name: "notify", type: "bool" },
{ name: "payload", type: "cell" },
],
outputs: [],
},
{
name: "acceptBurn",
id: "0x192B51B1",
inputs: [
{ name: "amount", type: "uint128" },
{ name: "walletOwner", type: "address" },
{ name: "remainingGasTo", type: "address" },
{ name: "callbackTo", type: "address" },
{ name: "payload", type: "cell" },
],
outputs: [],
},
{
name: "sendSurplusGas",
inputs: [{ name: "to", type: "address" }],
outputs: [],
},
],
data: [
{ key: 1, name: "name_", type: "string" },
{ key: 2, name: "symbol_", type: "string" },
{ key: 3, name: "decimals_", type: "uint8" },
{ key: 4, name: "rootOwner_", type: "address" },
{ key: 5, name: "walletCode_", type: "cell" },
{ key: 6, name: "randomNonce_", type: "uint256" },
{ key: 7, name: "deployer_", type: "address" },
],
events: [],
fields: [
{ name: "_pubkey", type: "uint256" },
{ name: "_timestamp", type: "uint64" },
{ name: "_constructorFlag", type: "bool" },
{ name: "name_", type: "string" },
{ name: "symbol_", type: "string" },
{ name: "decimals_", type: "uint8" },
{ name: "rootOwner_", type: "address" },
{ name: "walletCode_", type: "cell" },
{ name: "totalSupply_", type: "uint128" },
{ name: "burnPaused_", type: "bool" },
{ name: "burnByRootDisabled_", type: "bool" },
{ name: "mintDisabled_", type: "bool" },
{ name: "randomNonce_", type: "uint256" },
{ name: "deployer_", type: "address" },
],
} as const;TokenWalletUpgradable Contract ABI
typescript
const TokenWalletUpgradableAbi{
"ABI version": 2,
"version": "2.2",
"header": ["pubkey", "time", "expire"],
"functions": [
{
"name": "supportsInterface",
"inputs": [
{"name":"answerId","type":"uint32"},
{"name":"interfaceID","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"bool"}
]
},
{
"name": "platformCode",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"cell"}
]
},
{
"name": "onDeployRetry",
"id": "0x15A038FB",
"inputs": [
{"name":"value0","type":"cell"},
{"name":"value1","type":"uint32"},
{"name":"sender","type":"address"},
{"name":"remainingGasTo","type":"address"}
],
"outputs": [
]
},
{
"name": "version",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"uint32"}
]
},
{
"name": "upgrade",
"inputs": [
{"name":"remainingGasTo","type":"address"}
],
"outputs": [
]
},
{
"name": "acceptUpgrade",
"inputs": [
{"name":"newCode","type":"cell"},
{"name":"newVersion","type":"uint32"},
{"name":"remainingGasTo","type":"address"}
],
"outputs": [
]
},
{
"name": "burnByRoot",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"remainingGasTo","type":"address"},
{"name":"callbackTo","type":"address"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "destroy",
"inputs": [
{"name":"remainingGasTo","type":"address"}
],
"outputs": [
]
},
{
"name": "burn",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"remainingGasTo","type":"address"},
{"name":"callbackTo","type":"address"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "balance",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"uint128"}
]
},
{
"name": "owner",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"address"}
]
},
{
"name": "root",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"address"}
]
},
{
"name": "walletCode",
"inputs": [
{"name":"answerId","type":"uint32"}
],
"outputs": [
{"name":"value0","type":"cell"}
]
},
{
"name": "transfer",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"recipient","type":"address"},
{"name":"deployWalletValue","type":"uint128"},
{"name":"remainingGasTo","type":"address"},
{"name":"notify","type":"bool"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "transferToWallet",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"recipientTokenWallet","type":"address"},
{"name":"remainingGasTo","type":"address"},
{"name":"notify","type":"bool"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "acceptTransfer",
"id": "0x67A0B95F",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"sender","type":"address"},
{"name":"remainingGasTo","type":"address"},
{"name":"notify","type":"bool"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "acceptMint",
"id": "0x4384F298",
"inputs": [
{"name":"amount","type":"uint128"},
{"name":"remainingGasTo","type":"address"},
{"name":"notify","type":"bool"},
{"name":"payload","type":"cell"}
],
"outputs": [
]
},
{
"name": "sendSurplusGas",
"inputs": [
{"name":"to","type":"address"}
],
"outputs": [
]
},
{
"name": "constructor",
"inputs": [
],
"outputs": [
]
}
],
"data": [
{"key":1,"name":"root_","type":"address"},
{"key":2,"name":"owner_","type":"address"}
],
"events": [
],
"fields": [
{"name":"_pubkey","type":"uint256"},
{"name":"_timestamp","type":"uint64"},
{"name":"_constructorFlag","type":"bool"},
{"name":"root_","type":"address"},
{"name":"owner_","type":"address"},
{"name":"balance_","type":"uint128"},
{"name":"version_","type":"uint32"},
{"name":"platformCode_","type":"cell"}
]
} as constInitiating the token transfer on Everscale
Transfer Alien Token
typescript
// Import the required libraries
import { ethers } from "ethers";
import { Address } from "everscale-inpage-provider";
// Initiate the Tvm provider as mentioned in prerequisites section
// User's Everscale address
const everSender: Address = new Address("0:12345");
/**
* @param TokenRootAbi {JSON} The ABI of the token root contract
* @param tokenAddress {Address} Address of the token root contract
*/
const AlienTokenRoot = new provider.Contract(TokenRootAbi, tokenAddress);
/**
* @param TokenWalletUpgradableAbi {JSON} The ABI of the token wallet upgradable contract
* @param everSender {Address} User's Everscale address
*/
const AlienTokenWalletUpgradable = new provider.Contract(
TokenWalletUpgradableAbi,
(
await AlienTokenRoot.methods
.walletOf({ answerId: 0, walletOwner: everSender })
.call({})
).value0
);
// Token amount
let amount: string;
// Pay EVM network fees with EVER ?
let payWithEver: boolean;
// Amount to attach to the transaction if payWithEver = true
/// @dev This parameter represents the estimated gas fees for one of the saveWithdraws functions in EVER coins.
const auto_value: string;
// Amount to attach to the transaction if payWithEver = false
const manual_value: string = 6;
// See building payloads -> Alien Token Payload
let ALienTokenPayload: string;
// Decimals of the target token
const decimals: string = (
await AlienTokenRoot.methods.decimals({ answerId: 0 }).call({})
).value0;
/**
* @param amount {string} Token amount
* @param callbackTo {Address} Callback receiver
* @param payload {string} Operational payload
* @param remainingGasTo {Address} Address to send the change back
* @param from {Address} Sender address
* @notice @param amount {string} This parameter is important when asset releasing on EVM side is done automatically
* @param bounce {boolean} Return remaining gas ? always true
*/
await AlienTokenWalletUpgradable.methods
.burn({
amount: ethers.parseUnits(amount, decimals).toString(),
callbackTo: MergePool_V4,
payload: ALienTokenPayload,
remainingGasTo: payWithEver ? EventCloser : everSender,
})
.send({
from: everSender,
amount: ethers
.parseUnits(payWithEver ? auto_value : manual_value, 9)
.toString(),
bounce: true,
});WARNING
Kindly be aware that you are signing a transaction on the mainnet (this is not a testnet).