Skip to content

token.grantRoles

Grants a role to an address. Requires the admin role for the role being granted. Learn more about token roles

Usage

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

Role granted: true

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 'tempo.ts/viem'
import { client } from './viem.config'
 
const hash = await client.token.grantRoles({
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000000',
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
const receipt = await client.waitForTransactionReceipt({ hash })
 
const events = Actions.token.grantRoles.extractEvents(receipt.logs)

Return Type

type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Array of role membership update events */
  value: readonly {
    /** Role identifier */
    role: Hex
    /** Address that received the role */
    account: Address
    /** Address that granted the role */
    sender: Address
    /** Whether the role was granted (true) or revoked (false) */
    hasRole: boolean
  }[]
}

Parameters

role

  • Type: "defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked"

Role to grant.

token

  • Type: Address | bigint

Address or ID of the TIP20 token.

to

  • Type: Address

Address to grant the role to.

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.