Update Access Key Limit

Updates the spending limit for a specific token on an authorized access key.

Usage

import { client } from './viem.config'
 
const { limit, receipt } = await client.accessKey.updateLimitSync({
  accessKey: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  limit: 1000000000000000000n,
  token: '0x20c0000000000000000000000000000000000001',
})
 
console.log('New limit:', limit)
console.log('Transaction hash:', receipt.transactionHash)
New limit: 1000000000000000000n
Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

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

Asynchronous Usage

The examples above use 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 accessKey.updateLimit action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.accessKey.updateLimit({
  accessKey: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  limit: 1000000000000000000n,
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.accessKey.updateLimit.extractEvent(receipt.logs)

Recipes

Freeze a Key Without Revoking It

Set limit to 0n to stop a key from spending during an investigation, keeping the option to restore it later, unlike accessKey.revoke.

import { client } from './viem.config'
 
const { receipt } = await client.accessKey.updateLimitSync({
  accessKey: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  limit: 0n,
  token: '0x20c0000000000000000000000000000000000000',
})

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

Top Up a Budget When It Runs Low

Combine accessKey.getRemainingLimit with updateLimit to raise an agent's cap only when its remaining budget drops below a threshold.

import { Value } from 'viem/utils'
import { client } from './viem.config'
 
const accessKey = '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
const token = '0x20c0000000000000000000000000000000000000'
 
const { remaining } = await client.accessKey.getRemainingLimit({
  accessKey,
  token,
})
 
if (remaining < Value.from('100', 6)) {
  await client.accessKey.updateLimitSync({
    accessKey,
    limit: Value.from('1000', 6),
    token,
  })
}

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

Return Value

type ReturnType = {
  /** Account that owns the key. */
  account: Address
  /** New spending limit. */
  limit: bigint
  /** Access key address. */
  publicKey: Address
  /** Token address. */
  token: Address
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The updated spending limit details and the transaction receipt.

Parameters

accessKey

• Type: Address | AccessKeyAccount

Access key to update. Pass an access key address or an AccessKeyAccount.

limit

• Type: bigint

New spending limit.

token

• Type: Address

Token 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.