Set Token Supply Cap

Sets the supply cap for a TIP-20 token. Requires the default admin role.

Usage

import { Value } from 'viem/utils'
import { client } from './viem.config'
 
const { newSupplyCap, receipt } = await client.token.setSupplyCapSync({
  supplyCap: Value.from('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})
 
console.log('New supply cap:', newSupplyCap)
New supply cap: 1000000000000n

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

import { Actions } from 'viem/tempo'
import { Value } from 'viem/utils'
import { client } from './viem.config'
 
const hash = await client.token.setSupplyCap({
  supplyCap: Value.from('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.token.setSupplyCap.extractEvent(receipt.logs)

Recipes

Freeze Issuance at the Current Supply

Cap the token at its exact outstanding supply, read with token.getTotalSupply, to stop further minting while payments keep flowing.

import { client } from './viem.config'
 
const token = '0x20c0000000000000000000000000000000000001'
 
const { amount } = await client.token.getTotalSupply({ token })
 
const { newSupplyCap } = await client.token.setSupplyCapSync({
  supplyCap: amount,
  token,
})
 
console.log('Issuance frozen at:', newSupplyCap)
Issuance frozen at: 25000000000000n

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

Raise the Cap Ahead of a Scheduled Mint

Read the current cap with token.getMetadata and raise it by exactly the next payroll run, so the cap always tracks planned issuance.

import { Value } from 'viem/utils'
import { client } from './viem.config'
 
const token = '0x20c0000000000000000000000000000000000001'
 
const { supplyCap = 0n } = await client.token.getMetadata({ token })
 
const { newSupplyCap } = await client.token.setSupplyCapSync({
  supplyCap: supplyCap + Value.from('250000', 6),
  token,
})
 
console.log('New supply cap:', newSupplyCap)
New supply cap: 25250000000000n

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

Return Value

type ReturnType = {
  /** Address that updated the supply cap. */
  updater: Address
  /** New supply cap. */
  newSupplyCap: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

Parameters

supplyCap

• Type: bigint

New supply cap, in base units.

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.