Change Validator Status

Changes validator active status.

Usage

import { client } from './viem.config'
 
const { receipt } = await client.validator.changeStatusSync({
  active: false,
  validator: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
 
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 validator.changeStatus action and wait for inclusion manually:

import { client } from './viem.config'
 
const hash = await client.validator.changeStatus({
  active: false,
  validator: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt

Recipes

Reactivate a Validator After Maintenance

Combine validator.get with changeStatus to skip the transaction when the validator is already back in the set.

import { client } from './viem.config'
 
const validator = '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb'
 
const { active } = await client.validator.get({ validator })
 
if (!active)
  await client.validator.changeStatusSync({ active: true, validator })

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

Deactivate Validators on a Compromised Host

Combine validator.list with changeStatus to pull every validator on a compromised host out of consensus.

import { client } from './viem.config'
 
const validators = await client.validator.list()
const affected = validators.filter(
  (validator) =>
    validator.active && validator.outboundAddress.startsWith('203.0.113.10:'),
)
 
for (const { validatorAddress } of affected)
  await client.validator.changeStatusSync({
    active: false,
    validator: validatorAddress,
  })

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

Return Value

type ReturnType = {
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The transaction receipt.

Parameters

active

• Type: boolean

Whether the validator should be active.

validator

• Type: Address

Validator 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.