Create Transfer Policy

Creates a TIP-403 transfer policy.

When admin is omitted, it defaults to the calling account.

Usage

import { client } from './viem.config'
 
const { policyId, receipt } = await client.policy.createSync({
  type: 'whitelist',
})
 
console.log('Policy ID:', policyId)
console.log('Transaction hash:', receipt.transactionHash)
Policy ID: 1n
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.create action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.policy.create({
  type: 'whitelist',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.policy.create.extractEvent(receipt.logs)

Recipes

Seed a Whitelist with KYC-Approved Accounts

Pass addresses to open the policy with your approved accounts in a single transaction. Verify membership with policy.isAuthorized before the policy gates transfers.

import { client } from './viem.config'
 
const { policyId } = await client.policy.createSync({
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  ],
  type: 'whitelist',
})
 
const authorized = await client.policy.isAuthorized({
  policyId,
  user: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
 
console.log('Authorized:', authorized)
Authorized: true

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

Delegate Policy Administration to a Compliance Team

Pass admin when a dedicated compliance account, rather than the deploying account, should manage membership. Only the admin can call policy.modifyBlacklist or policy.setAdmin.

import { client } from './viem.config'
 
await client.policy.createSync({
  admin: '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  type: 'blacklist',
})

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

Enforce a Sanctions Blacklist on a Stablecoin

Combine policy.createSync with token.changeTransferPolicySync to block designated addresses from sending or receiving your token. See the Configure Transfer Policies guide for the full flow.

import { client } from './viem.config'
 
const { policyId } = await client.policy.createSync({
  addresses: ['0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb'],
  type: 'blacklist',
})
 
await client.token.changeTransferPolicySync({
  policyId,
  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
  /** Policy type. */
  type: 'blacklist' | 'whitelist'
  /** Address that created the policy. */
  updater: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Policy creation details and the transaction receipt.

Parameters

addresses

• Type: readonly Address[]

Optional accounts to initialize the policy with.

admin

• Type: Account | Address

Policy admin address. Defaults to the calling account when omitted.

type

• Type: 'blacklist' | 'whitelist'

Policy type.

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.