Skip to content
LogoLogo

Update Validator

validator.update

Updates validator information.

Usage

import {  } from './viem.config'
 
const {  } = await ..({
  : 'validator.example.com:9000',
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '203.0.113.10:9000',
  : '0x1111111111111111111111111111111111111111111111111111111111111111',
})
 
.('Transaction hash:', .)
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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

import {  } from './viem.config'
 
const  = await ..({
  : 'validator.example.com:9000',
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  : '203.0.113.10:9000',
  : '0x1111111111111111111111111111111111111111111111111111111111111111',
})
const  = await ..({  }).

Recipes

Migrate a Node to New Infrastructure

Combine validator.get with update to point the record at new endpoints while keeping the validator's address and key.

import {  } from './viem.config'
 
const  = await ..({
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
 
const {  } = await ..({
  : 'validator-2.example.com:9000',
  : .,
  : '198.51.100.7:9000',
  : .,
})

Rotate a Validator's Address

Reuse the existing record from validator.get and pass a fresh newValidatorAddress to rotate the address that identifies the validator on chain.

import {  } from './viem.config'
 
const  = await ..({
  : '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
 
const {  } = await ..({
  : .,
  : '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  : .,
  : .,
})

Return Value

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

The transaction receipt.

Parameters

inboundAddress

  • Type: string

Validator inbound address <hostname|ip>:<port>.

newValidatorAddress

  • Type: Address

New address for this validator.

outboundAddress

  • Type: string

Validator outbound IP address <ip>:<port>.

publicKey

  • Type: Hex

Validator communication public key.

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.