Skip to content

tokentransferrequest.md

Latest commit

 

History

History
29 lines (23 loc) · 5.99 KB

tokentransferrequest.md

File metadata and controls

29 lines (23 loc) · 5.99 KB

TokenTransferRequest

Request model for transferring ETH or ERC20 tokens.

Example Usage

import { TokenTransferRequest } from "@compass-labs/api-sdk/models/components";

let value: TokenTransferRequest = {
  to: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc44",
  token: "USDC",
  amount: 1.5,
  chain: "base",
  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
};

Fields

Field Type Required Description Example
actionType string ➖ N/A
to string ✔️ The recipient of the tokens. 0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc44
token string ✔️ The symbol or address of the token to transfer. USDC
amount components.TokenTransferRequestAmount ✔️ Amount of token to transfer 1.5
chain components.TokenTransferRequestChain ✔️ N/A
sender string ✔️ The address of the transaction sender. 0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B
estimateGas boolean ➖ Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.