Grant Token Roles

Grants roles for a TIP-20 token. Requires the admin role for each role being granted. Learn more about token roles

Usage

import { client } from './viem.config'
 
const { receipt, value } = await client.token.grantRolesSync({
  roles: ['issuer'],
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000001',
})
 
console.log('Role granted:', value[0].hasRole)
Role granted: true

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

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

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.token.grantRoles({
  roles: ['issuer'],
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const events = Actions.token.grantRoles.extractEvents(receipt.logs)

Recipes

Separate Issuer and Pauser Duties Across Ops Teams

Grant each operations account only the roles its job requires: the minting service holds issuer, while the incident-response desk holds pause and unpause.

import { client } from './viem.config'
 
const token = '0x20c0000000000000000000000000000000000001'
 
await client.token.grantRolesSync({
  roles: ['issuer'],
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token,
})
 
const { value } = await client.token.grantRolesSync({
  roles: ['pause', 'unpause'],
  to: '0x8ba1f109551bD432803012645Ac136ddd64DBA72',
  token,
})
 
console.log('Roles granted:', value.length)
Roles granted: 2

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

Bootstrap Roles on a Newly Created Token

Combine grantRolesSync with token.createSync to deploy a stablecoin and hand its issuer role to your minting service in one flow.

import { client } from './viem.config'
 
const { token } = await client.token.createSync({
  currency: 'USD',
  name: 'Alpha USD',
  symbol: 'alphaUSD',
})
 
const { value } = await client.token.grantRolesSync({
  roles: ['issuer'],
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token,
})
 
console.log('Issuer granted:', value[0].hasRole)
Issuer granted: true

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

Return Value

type ReturnType = {
  /** Transaction receipt. */
  receipt: TransactionReceipt
  /** Role membership update events. */
  value: readonly {
    /** Role whose membership changed. */
    role: Hex
    /** Account whose role membership changed. */
    account: Address
    /** Sender that changed role membership. */
    sender: Address
    /** Whether the account has the role after the update. */
    hasRole: boolean
  }[]
}

Parameters

roles

• Type: readonly ("defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked")[]

Roles to grant.

to

• Type: Address

Address to grant the role to.

token

• Type: Address | bigint

Token to operate on: a TIP-20 token id or a contract address.

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.