Change Token Transfer Policy

Changes the transfer policy ID for a TIP-20 token. Requires the default admin role. Learn more about transfer policies

Usage

import { client } from './viem.config'
 
const { receipt } = await client.token.changeTransferPolicySync({
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

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.changeTransferPolicy action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.token.changeTransferPolicy({
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.token.changeTransferPolicy.extractEvent(receipt.logs)

Recipes

Launch a Token with a KYC Allowlist

Combine policy.createSync with token.changeTransferPolicySync to gate a new token to KYC-verified accounts from the first transfer.

import { client } from './viem.config'
 
const { policyId } = await client.policy.createSync({
  addresses: ['0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb'],
  type: 'whitelist',
})
 
const { receipt } = await client.token.changeTransferPolicySync({
  policyId,
  token: '0x20c0000000000000000000000000000000000000',
})

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Verify Membership Before Migrating Policies

Check critical accounts against the new policy with policy.isAuthorized before switching, so a compliance migration never strands your treasury or settlement partners.

import { client } from './viem.config'
 
const newPolicyId = 2n
const treasury = '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
 
const isAuthorized = await client.policy.isAuthorized({
  policyId: newPolicyId,
  user: treasury,
})
if (!isAuthorized) throw new Error('treasury is not on the new policy')
 
const { receipt } = await client.token.changeTransferPolicySync({
  policyId: newPolicyId,
  token: '0x20c0000000000000000000000000000000000000',
})

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Return Value

type ReturnType = {
  /** Address that updated the transfer policy. */
  updater: Address
  /** New transfer policy ID. */
  newPolicyId: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Parameters

policyId

• Type: bigint

New transfer policy ID.

token

• Type: Address | bigint

Address or ID of the TIP-20 token.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feePayer (optional)

• Type: Account | boolean

Fee payer for the transaction (TIP-1 gas sponsorship).

Pass true to defer the fee token to an external fee payer (e.g. a relay), or a local Account to co-sign the transaction as the fee payer.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID.

gas (optional)

• Type: bigint

Gas limit for the transaction.

keyAuthorization (optional)

• Type: KeyAuthorization

Signed key authorization to include with the transaction, authorizing an access key to act for the sending account.

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: 'expiring' | 'random' | bigint

Nonce key for the transaction (TIP-1009 2D nonces).

Use 'expiring' to select an expiring nonce, which enables concurrent transaction submission without nonce ordering. Use 'random' to select a random key.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether a Sync action throws when the receipt reports a revert.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.