token.transfer

Transfers TIP-20 tokens from the caller to a recipient.

Usage

import { parseUnits } from 'viem'
import { client } from './viem.config'
 
const { receipt } = await client.token.transferSync({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

Asynchronous Usage

The example above uses a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync token.transfer action and wait for inclusion manually:

import { Actions } from 'tempo.ts/viem'
import { parseUnits } from 'viem'
import { client } from './viem.config'
 
const hash = await client.token.transfer({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args } 
  = Actions.token.transfer.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** Amount of tokens transferred */
  amount: bigint
  /** Address tokens were transferred from */
  from: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address tokens were transferred to */
  to: Address
}

Parameters

amount

• Type: bigint

Amount of tokens to transfer.

to

• Type: Address

Address to transfer tokens to.

token

• Type: Address | bigint

Address or ID of the TIP-20 token.

memo (optional)

• Type: Hex

Optional memo to attach to the transfer event.

from (optional)

• Type: Address

Address to transfer tokens from. When specified, transfers tokens from the given address (requires prior approval). Defaults to the caller's address.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be a TIP-20 token address or ID.

feePayer (optional)

• Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

• Type: bigint

Gas limit for the transaction.

maxFeePerGas (optional)

• Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

• Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

• Type: number

Nonce for the transaction.

nonceKey (optional)

• Type: 'random' | bigint

Nonce key for the transaction. Use 'random' to generate a random nonce key.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.