Set Transfer Policy Admin

Sets the admin for a TIP-403 transfer policy.

Usage

import { client } from './viem.config'
 
const { admin, receipt } = await client.policy.setAdminSync({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})
 
console.log('Admin:', admin)
console.log('Transaction hash:', receipt.transactionHash)
Admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
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 policy.setAdmin action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.policy.setAdmin({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.policy.setAdmin.extractEvent(receipt.logs)

Recipes

Hand Off Policy Control to a Compliance Multisig

Use policy.setAdminSync when a policy moves to production and a secured account should own membership changes; confirm the handoff with policy.getData. The previous admin loses control as soon as the transaction is included.

import { client } from './viem.config'
 
await client.policy.setAdminSync({
  admin: '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  policyId: 1n,
})
 
const { admin } = await client.policy.getData({ policyId: 1n })
 
console.log('Admin:', admin)
Admin: 0x8ba1f109551bD432803012645Ac136ddd64DBA72

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

Sign the Handoff with the Outgoing Admin Key

Pass account to sign with the policy's current admin when it differs from your client's default account; only the current admin can set a new one.

import { Account } from 'viem/tempo'
import { client } from './viem.config'
 
const outgoingAdmin = Account.fromSecp256k1('0x...')
 
await client.policy.setAdminSync({
  account: outgoingAdmin,
  admin: '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  policyId: 1n,
})

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

Return Value

type ReturnType = {
  /** Policy ID. */
  policyId: bigint
  /** Address that updated the admin. */
  updater: Address
  /** New admin address. */
  admin: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The updated policy admin details and the transaction receipt.

Parameters

admin

• Type: Address

New admin address.

policyId

• Type: bigint

Policy ID.

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.