policy.create

Creates a new transfer policy for token access control. Learn more about transfer policies

Usage

import { client } from './viem.config'
 
const { policyId, policyType, receipt } = await client.policy.createSync({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})
 
console.log('Policy ID:', policyId)
Policy ID: 1n

Asynchronous Usage

The example above uses 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 'tempo.ts/viem'
import { client } from './viem.config'
 
const hash = await client.policy.create({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const { args: { policyId } } 
  = Actions.policy.create.extractEvent(receipt.logs)

Return Type

type ReturnType = {
  /** ID of the created policy */
  policyId: bigint
  /** Type of the policy (0 = whitelist, 1 = blacklist) */
  policyType: number
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that created the policy */
  updater: Address
}

Parameters

type

• Type: 'whitelist' | 'blacklist'

Type of policy to create. A whitelist policy only allows listed addresses, while a blacklist policy allows all except listed addresses.

addresses (optional)

• Type: Address[]

Optional array of addresses to initialize the policy with.

admin

• Type: Address

Address of the policy admin.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be a TIP-20 token address or ID.

feePayer (optional)

• Type: Account | true

Fee payer for the transaction.

Can be a Viem Account, or true if a Fee Payer Service will be used.

gas (optional)

• Type: bigint

Gas limit for the transaction.

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: 'random' | bigint

Nonce key for the transaction. Use 'random' to generate a random nonce key.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to *Sync actions.