Announce a Stock Dividend - Base Documentation

Bracket a holder-impacting action with an onchain description and supporting URI. This example announces a five-percent stock dividend and issues additional shares with batchMint in the same transaction.

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.

Announce and distribute the stock dividend

import { encodeFunctionData, parseUnits, type Address } from "viem";
import { publicClient } from "../../shared/clients.js";
import { assetAbi } from "../abi.js";
import { sendContract } from "../write.js";

export async function announceStockDividend(token: Address, holders: Address[]) {
  const mint = encodeFunctionData({
    abi: assetAbi,
    functionName: "batchMint",
    args: [holders, [parseUnits("30", 6), parseUnits("20", 6)]],
  });
  const id = `dividend-${Date.now()}`;
  await sendContract({
    address: token,
    abi: assetAbi,
    functionName: "announce",
    args: [[mint], id, "Five-percent stock dividend", "https://example.com/actions/dividend"],
  });
  const used = await publicClient.readContract({ address: token, abi: assetAbi, functionName: "isAnnouncementIdUsed", args: [id] });
  if (!used) throw new Error("Announcement was not recorded");
}

    function announceDividend(address token, address[] memory recipients, uint256[] memory amounts) public {
        bytes[] memory calls = new bytes[](1);
        calls[0] = abi.encodeCall(IB20Asset.batchMint, (recipients, amounts));
        IB20Asset(token).announce(
            calls,
            "2026-stock-dividend-01",
            "Five-percent stock dividend",
            "https://example.com/corporate-actions/2026-01"
        );
        require(IB20Asset(token).isAnnouncementIdUsed("2026-stock-dividend-01"), "announcement missing");
    }

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

The unique announcement ID is marked used and the batch mint executes between Announcement and EndAnnouncement.

This example issues additional shares. It does not distribute a cash dividend.

See also

Issue shares · Run a stock split
Announcements and Batch mint in the B20 standard

⌘I