Register Virtual Master Address

Registers a virtual master address.

Usage

import { client } from './viem.config'
 
const { masterId, receipt } = await client.virtualAddress.registerMasterSync({
  salt: '0x00000000000000000000000000000000000000000000000000000000abf52baf',
})
 
console.log('Master ID:', masterId)
console.log('Transaction hash:', receipt.transactionHash)
Master ID: 0x58e21090
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.

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.virtualAddress.registerMaster({
  salt: '0x00000000000000000000000000000000000000000000000000000000abf52baf',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.virtualAddress.registerMaster.extractEvent(receipt.logs)

Recipes

Onboard a Deposit Master for an Exchange

Mine a proof-of-work salt for your wallet, register it once, then derive per-customer deposit addresses offchain with VirtualAddress.from (see the register guide for operational practices).

import { VirtualAddress, VirtualMaster } from 'viem/tempo'
import { client } from './viem.config'
 
const mined = await VirtualMaster.mineSaltAsync({
  address: client.account.address,
})
 
const { masterId } = await client.virtualAddress.registerMasterSync({
  salt: mined!.salt,
})
 
const depositAddress = VirtualAddress.from({ masterId, userTag: 1n })
 
console.log('Deposit address for customer 1:', depositAddress)
Deposit address for customer 1: 0x58e21090fdfdfdfdfdfdfdfdfdfd000000000001

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

Make Deploy-Time Registration Idempotent

Derive the master ID from your stored salt with VirtualMaster.getMasterId and check virtualAddress.getMasterAddress first, so a re-run deploy script skips the one-time registration.

import { VirtualMaster } from 'viem/tempo'
import { client } from './viem.config'
 
// Mined ahead of time, from your deploy config.
const salt =
  '0x00000000000000000000000000000000000000000000000000000000abf52baf'
 
const masterId = VirtualMaster.getMasterId({
  address: client.account.address,
  salt,
})
 
const registered = await client.virtualAddress.getMasterAddress({ masterId })
if (!registered)
  await client.virtualAddress.registerMasterSync({ salt })

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

Return Value

type ReturnType = {
  masterAddress: Address
  masterId: Hex
  receipt: TransactionReceipt
}

Registration details and the transaction receipt.

Parameters

salt

• Type: Hex

Salt used for proof-of-work master ID derivation.

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.