validator.changeStatus

Changes a validator's active status. Requires owner permission.

Usage

import { client } from './viem.config'
 
const { receipt } = await client.validator.changeStatusSync({
  validator: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  active: false,
})
 
console.log('Transaction hash:', receipt.transactionHash)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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

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

Return Type

type ReturnType = {
  receipt: TransactionReceipt
}

Parameters

validator

• Type: Address

The validator address.

active

• Type: boolean

Whether the validator should be active.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

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.