Update Quote Token

Completes a prepared quote token update for a TIP-20 token. Requires the token's admin role.

Quote token updates are a two-step flow: token.prepareUpdateQuoteToken stages the next quote token, then this action completes the update.

Usage

import { client } from './viem.config'
 
const { newQuoteToken, receipt } = await client.token.updateQuoteTokenSync({
  token: '0x20c0000000000000000000000000000000000001',
})
 
console.log('New quote token:', newQuoteToken)
New quote token: 0x20C0000000000000000000000000000000000002

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

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

Recipes

Complete a Migration Staged by Another Operator

Assert the applied quote token matches your change ticket after completing, since this action applies whatever token.prepareUpdateQuoteToken staged last.

import { client } from './viem.config'
 
const expected = '0x20c0000000000000000000000000000000000002'
 
const { newQuoteToken } = await client.token.updateQuoteTokenSync({
  token: '0x20c0000000000000000000000000000000000001',
})
 
if (newQuoteToken.toLowerCase() !== expected.toLowerCase())
  throw new Error(`Unexpected quote token: ${newQuoteToken}`)

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

Trigger Downstream Updates When the Switch Lands

Combine the update with token.watchUpdateQuoteToken so pricing and settlement services react the moment the new quote token applies.

import { client } from './viem.config'
 
const token = '0x20c0000000000000000000000000000000000001'
 
const watcher = client.token.watchUpdateQuoteToken({ token })
watcher.onLogs((logs) => {
  for (const log of logs) {
    if (log.eventName !== 'QuoteTokenUpdate') continue
    console.log('New quote token live:', log.args.newQuoteToken)
  }
})
 
await client.token.updateQuoteTokenSync({ token })

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

Return Value

type ReturnType = {
  /** Account that completed the quote token update. */
  updater: Address
  /** New quote token. */
  newQuoteToken: Address
  /** 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.