Skip to content

policy.modifyWhitelist

Modifies the whitelist for a whitelist-type transfer policy. Requires policy admin role.

Usage

example.ts
import { client } from './viem.config'
 
const { receipt } = await client.policy.modifyWhitelistSync({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  allowed: true,
  policyId: 1n,
})
 
console.log('Transaction hash:', receipt.transactionHash)

Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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.modifyWhitelist action and wait for inclusion manually:

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

Return Type

type ReturnType = {
  /** Address that was added/removed from whitelist */
  account: Address
  /** Whether the address is allowed */
  allowed: boolean
  /** ID of the policy */
  policyId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that modified the whitelist */
  updater: Address
}

Parameters

address

  • Type: Address

Target account address to add or remove from the whitelist.

allowed

  • Type: boolean

Whether the address should be allowed (true) or disallowed (false).

policyId

  • Type: bigint

ID of the whitelist policy to modify.

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.