TokenTransferRequestDto

Data structure for performing a fungible token transfer

Signature
{
  walletId! : string;
  to! : string;
  secretType! : SecretType;
  tokenAddress!: string;
  network?: {
    name!: string;
    nodeUrl!: string,
    chainId?: number;
  };
  data? : string;
  value! : BigDecimal;
}
Parameters
Parameter
Required
Type
Description
walletId
True
String
ID of the wallet one wants to sign with.
to
True
String
Destination address of the transaction. Can be an address or an email address.
secretType
True
​SecretType​
Chain the transaction will be executed on.
tokenAddress
True
String
Address of the token
network
False
Object
The network to submit the transaction to
network.name
True
String
Display name of the network to submit the transaction to (e.g.: "Rinkeby"). This will be shown to the user when signing the transaction
network.nodeUrl
True
String
URL of the node to submit the transaction to (e.g.: "https://rinkeby.infura.io")
network.chainId
False
Number
Network ID of the selected network
data
False
String
Data you want to send. This field will be ignored when building a token transaction request
value
True
Number
Token value that should be transferred.
🧙 You don’t have to take into account the number of decimals for different tokens, Arkane handles that for you.
Example: If a token has 18 decimals and you want to transfer 1 token, provide the value 1. Arkane will translate this to the correct nondecimal value (1 * 10e18). 
🧙 Using the network parameter, the node to which the transaction is sent can be set manually. It allows you to submit a transaction to any mainnet or testnet node of your choosing, public or private. ( Ethereum only)
Example
{
    walletId: '71dec640-4eb8-4321-adb8-b79461573fc4',
    to: '0xf147cA0b981C0CD0955D1323DB9980F4B43e9FED',
    value: 1010,
    tokenAddress: '0x02f96ef85cad6639500ca1cc8356f0b5ca5bf1d2'
    secretType: 'ETHEREUM',
}
Function Types
executeTokenTransfer
/widget-advanced/reference/executetokentransfer

TransferRequestDto

NftTransferRequestDto

Last updated 8 months ago

Parameter	Required	Type	Description
`walletId`	`True`	`String`	ID of the wallet one wants to sign with.
`to`	`True`	`String`	Destination address of the transaction. Can be an address or an email address.
`secretType`	`True`	`SecretType`	Chain the transaction will be executed on.
`tokenAddress`	`True`	`String`	Address of the token
`network`	`False`	`Object`	The network to submit the transaction to
`network.name`	`True`	`String`	Display name of the network to submit the transaction to (e.g.: "Rinkeby"). This will be shown to the user when signing the transaction
`network.nodeUrl`	`True`	`String`	URL of the node to submit the transaction to (e.g.: "https://rinkeby.infura.io")
`network.chainId`	`False`	`Number`	Network ID of the selected network
`data`	`False`	`String`	Data you want to send. This field will be ignored when building a token transaction request
`value`	`True`	`Number`	Token value that should be transferred.