Modify Transfer Policy Whitelist

Modifies a TIP-403 transfer policy whitelist.

Usage

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

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

Recipes

Onboard a Customer After KYC Approval

Combine policy.modifyWhitelistSync with token.transferSync to grant access and settle the customer's first payout in one flow.

import { client } from './viem.config'
 
const customer = '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb'
 
await client.policy.modifyWhitelistSync({
  address: customer,
  allowed: true,
  policyId: 1n,
})
 
await client.token.transferSync({
  amount: { formatted: '100' },
  to: customer,
  token: '0x20c0000000000000000000000000000000000000',
})

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

Stage a Replacement Whitelist Before Attaching It

Populate a staged policy, then switch the token over with token.changeTransferPolicySync, so live transfers are never gated by a half-built list.

import { client } from './viem.config'
 
const members = [
  '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
] as const
 
for (const address of members)
  await client.policy.modifyWhitelistSync({
    address,
    allowed: true,
    policyId: 2n,
  })
 
await client.token.changeTransferPolicySync({
  policyId: 2n,
  token: '0x20c0000000000000000000000000000000000000',
})

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 policy. */
  updater: Address
  /** Target account address. */
  address: Address
  /** Whether the account is allowed. */
  allowed: boolean
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The updated policy details and the transaction receipt.

Parameters

address

• Type: Address

Target account address.

allowed

• Type: boolean

Whether the account is allowed.

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.