Skip to content

token.pause

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

Usage

example.ts
import { Actions } from 'tempo.ts/wagmi'
import { config } from './wagmi.config'
 
const { isPaused, receipt } = await Actions.token.pauseSync(config, {
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('Is paused:', isPaused)

Is paused: true

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 'tempo.ts/wagmi'
import { Actions as viem_Actions } from 'tempo.ts/viem'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { config } from './wagmi.config'
 
const hash = await Actions.token.pause(config, {
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })
 
const { args } 
  = viem_Actions.token.pause.extractEvent(receipt.logs)

Return Type

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

Parameters

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. Defaults to connected Wagmi account.

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.