Pause Token

Pauses a TIP-20 token, preventing all transfers. Requires the PAUSE role. Learn more about token roles

Usage

import { client } from './viem.config'
 
const { isPaused, receipt } = await client.token.pauseSync({
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Is paused:', isPaused)
Is paused: true

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

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

Recipes

Freeze Transfers While Rotating a Compromised Issuer Key

Combine token.pauseSync with token.revokeRolesSync to stop transfers while you remove a compromised issuer key, then token.unpauseSync once rotation completes.

import { client } from './viem.config'
 
const token = '0x20c0000000000000000000000000000000000001'
 
const { isPaused } = await client.token.pauseSync({ token })
 
const { value } = await client.token.revokeRolesSync({
  from: '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  roles: ['issuer'],
  token,
})
 
console.log('Roles revoked:', value.length)
Roles revoked: 1

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

Pause a Token Family in One Batch

Pass nonceKey: 'expiring' to pause every token you operate concurrently during an incident, without serializing the transactions on the operator account's nonce.

import { client } from './viem.config'
 
const tokens = [
  '0x20c0000000000000000000000000000000000001',
  '0x20c0000000000000000000000000000000000004',
] as const
 
const results = await Promise.all(
  tokens.map((token) =>
    client.token.pauseSync({ nonceKey: 'expiring', token }),
  ),
)
 
console.log(results.map(({ isPaused }) => isPaused))
[true, true]

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

Return Value

type ReturnType = {
  /** Address that updated the pause state. */
  updater: Address
  /** Whether the token is paused. */
  isPaused: boolean
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Parameters

token

• Type: Address | bigint

Token to operate on: a TIP-20 token id or a contract address.

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.