Pause Activity - Base Documentation

If something goes wrong, halt activity fast. B20 pausing is granular: stop transfers, mints, or burns independently. PAUSE_ROLE and UNPAUSE_ROLE are separate, so the ability to stop the token can be held more widely than the ability to resume it.

Demo

New to B20? See the B20 Token Standard for the concepts and a full launch walkthrough. These samples target base-std@v1.0.0, viem@2.55.11, and Base Foundry v1.1.1.

Pause and resume transfers

import { type Address } from "viem";
import { publicClient } from "../../shared/clients.js";
import { b20Abi } from "../abi.js";
import { sendContract } from "../write.js";

export async function setTransfersPaused(token: Address, paused: boolean) {
  await sendContract({
    address: token,
    abi: b20Abi,
    functionName: paused ? "pause" : "unpause",
    args: [[0]],
  });
  const current = await publicClient.readContract({ address: token, abi: b20Abi, functionName: "isPaused", args: [0] });
  if (current !== paused) throw new Error("Pause state did not change");
}

base-cast send "$TOKEN_ADDRESS" "pause(uint8[])" "[0]" \
  --rpc-url "$RPC_URL" --private-key "$PRIVATE_KEY"
base-cast call "$TOKEN_ADDRESS" "isPaused(uint8)(bool)" 0 --rpc-url "$RPC_URL"
base-cast send "$TOKEN_ADDRESS" "unpause(uint8[])" "[0]" \
  --rpc-url "$RPC_URL" --private-key "$PRIVATE_KEY"

See the complete verified B20 examples for imports, client construction, and runnable projects.

isPaused(0) returns true after pausing and false after resuming.

Transfer is enum value 0. The function accepts an array; never pass a hash such as keccak256("TRANSFER").

See also

Block an account
Pause in the B20 standard

⌘I