Set Validator Fee Token

Sets the calling validator's preferred fee token.

Usage

import { client } from './viem.config'
 
const { receipt } = await client.fee.setValidatorTokenSync({
  token: '0x20c0000000000000000000000000000000000001',
})
 
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 examples above use 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 fee.setValidatorToken action and wait for inclusion manually:

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

Recipes

Validate a Token Before Rotating

Combine fee.validateToken with setValidatorToken so fee revenue never switches to a paused or non-USD token.

import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
 
const { address } = await client.fee.validateToken({ token: alphaUsd })
 
const { receipt } = await client.fee.setValidatorTokenSync({ token: address })

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

Sign with the Validator Key from an Ops Client

Pass account to sign with the validator key when the Client defaults to another account: the preference applies to the sending account.

import { Account } from 'viem/tempo'
import { client } from './viem.config'
 
const validatorKey = Account.fromSecp256k1('0x...')
 
const { receipt } = await client.fee.setValidatorTokenSync({
  account: validatorKey,
  token: '0x20c0000000000000000000000000000000000001',
})

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

Confirm the Rotation On-Chain

Read the preference back with fee.getValidatorToken after rotating, as a convergence check in a validator runbook.

import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
 
await client.fee.setValidatorTokenSync({ token: alphaUsd })
 
const token = await client.fee.getValidatorToken({
  validator: client.account.address,
})
 
console.log('Receiving fees in:', token)
Receiving fees in: 0x20c0000000000000000000000000000000000001

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

Return Value

type ReturnType = {
  /** Token set as the validator's preferred fee token. */
  token: Address
  /** Validator the fee token was set for. */
  validator: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Parameters

token

• Type: Address

Token address to set as the preferred fee 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.