@useboardwalk/sdk

Framework-agnostic builders for unsigned Boardwalk transactions, plus a boardwalk CLI. Lets an agent (or any app) launch a token, contribute to an auction, claim, stake BWLK, and vote — by producing {to, data, value, chainId} calldata that the caller's own wallet signs and submits.

Non-custodial by design. This package never requests, stores, or accepts a private key. It only emits unsigned calldata and EIP-712 payloads. Your wallet signs and submits.

Attribution. Transactions the SDK builds on Base carry Boardwalk's ERC-8021 builder-code suffix on their calldata (that's where the code is registered). There is no per-call, CLI, or env override — see Attribution.

Install

npm install @useboardwalk/sdk                  # library
npm install -g @useboardwalk/sdk               # CLI, then:  boardwalk --help
npx -p @useboardwalk/sdk@2.1.0 boardwalk --help   # …or zero-install (pinned)

Requires Node ≥ 18 (uses global fetch/Blob/FormData). The bin is boardwalk (the package is @useboardwalk/sdk).

CLI

The CLI turns an intent into unsigned calldata. Every transaction command prints JSON { calls: [{ id, label, to, data, value, chainId }], ...meta }. calls is ordered — a conditional ERC-20 approve is first when needed; submit the whole array as one batch (e.g. Base MCP send_calls) so the user approves once. value is a decimal wei string ("0" for all v1 actions). The CLI never signs or sends.

Every command and flag is self-documenting:

boardwalk --help
boardwalk <command> --help

Command	Summary	Chain
`launch`	Build a token launch (approve BWLK + `createLaunch`)	multi
`launch-metadata`	Upload logo + build the EIP-712 metadata payload to sign	multi
`submit-metadata`	POST the signed metadata (retries through indexer lag)	multi
`contribute`	Join an auction (approve raise token + `contribute`)	multi
`claim`	Claim tokens after a successful auction	multi
`stake-bwlk`	Stake BWLK (approve + `stakeBwlk`)	Ethereum
`vote`	Vote on the weekly revenue direction (optional approve + `vote`)	Ethereum
`launch-cost`	Read the BWLK burn cost to launch	read-only
`status`	Read a launch's status + presale address	read-only

Common flags: --chain <slug|id> (ethereum · base · arbitrum · robinhood), --wallet <address> (BYO; never a key), --rpc <url> (override; every supported chain has a built-in public default). Public RPCs rate-limit — for anything beyond occasional reads, pass --rpc <url> pointing at a dedicated endpoint. Amounts (--amount, --raise-goal) are in human units; the CLI scales to wei.

`launch`

Build the launch flow: a conditional BWLK approval (Boardwalk burns BWLK to launch) + createLaunch. meta carries bwlkBurnCost (wei) and the full config tuple.

boardwalk launch --chain base --wallet 0xYou \
  --name "My Token" --ticker MYT --category meme-culture \
  --path express --issuer-fee 0xYou

Naming: the longer path is a standard launch in Boardwalk's docs and UI. The CLI flag, the SDK types, and the onchain contracts all still spell it advanced — same path, two names. Pass --path advanced to create one.

Flags: --name --ticker --category (required) · --path express|advanced (standard = advanced, which adds a 24h start delay) · --description. Express: --issuer-fee <addr> (single recipient, 100%). Standard (--path advanced): --presale-percent <25–50, step 5> · --fee <label:addr:percent> (repeatable, 1–4 recipients — the issuer-fee split across individual|entity|publicGood|growthTeam) · --vesting <label:addr:percent> (repeatable, up to 5; required when presale < 50, not allowed at 50) · --referrer <addr>. The output carries the live graduationThreshold (the raise goal you later set in launch-metadata must exceed it) and auctionDuration — both read from the factory, since both are timelock-tunable. Output calls = [approve-bwlk?, create-launch] plus a next step.

# standard launch (--path advanced): fee breakdown + vesting
boardwalk launch --chain base --wallet 0xYou --name "My Token" --ticker MYT \
  --category ai-agents --path advanced --presale-percent 40 \
  --fee individual:0xYou:60 --fee entity:0xCo:40 --vesting individual:0xYou:100

`launch-metadata` / `submit-metadata`

After the create-launch tx confirms, pass its tx hash to launch-metadata — the SDK resolves the token from the receipt (you never parse event logs), uploads the logo, and returns the resolved token, the auctionUrl, and the EIP-712 payload (sign). Sign sign with the issuer wallet, then run submit-metadata, which retries through backend indexer lag (a fresh launch takes a few seconds to register).

boardwalk launch-metadata --tx 0x<create-launch tx hash> --chain base \
  --logo ./logo.png --twitter myhandle --homepage https://example.com --raise-goal 50
# → { token, auctionUrl, sign, next }. Sign `sign` (EIP-712), then:
boardwalk submit-metadata --token 0x<token> --chain base \
  --signature 0x<sig> --message '<sign.message json>'

Already have the token address? Use --token 0x… instead of --tx. Logo (one of): --logo <file> (path on disk) · --logo-data <base64|dataURL> (e.g. an agent-generated image) · --logo-url <url> (already hosted) — see Logos. Other fields: --twitter --discord --telegram --homepage --video --description --raise-goal --tos-uri --tos-version. --raise-goal (standard launches) is validated to exceed that launch's own graduation threshold, read from its PresaleManager. Each launch keeps the threshold it snapshotted at creation, so an older launch can require more than a new one. A launch is valid onchain even if you skip metadata.

`contribute`

boardwalk contribute --token 0xLaunch --amount 0.1 --chain base --wallet 0xYou

Resolves the presale + raise token, gates on status == "presale", then builds [approve-raise-token?, contribute]. Example output (0.01 on Base):

{
  "calls": [
    {
      "id": "approve-raise-token",
      "to": "0x4200…0006",
      "data": "0x095ea7b3…",
      "value": "0",
      "chainId": 8453,
    },
    {
      "id": "contribute",
      "to": "0x0000…0000", // the launch's presale manager, resolved on-chain
      "data": "0xc1cbbca7…",
      "value": "0",
      "chainId": 8453,
    },
  ],
  "action": "contribute",
  "token": "0xLaunch…",
  "amount": "10000000000000000",
  "raiseToken": "0x4200…0006",
}

`claim`

boardwalk claim --token 0xLaunch --chain base --wallet 0xYou

Gates on seeded status and the 7-day post-seed cliff (cliffEnd), then builds a single claimTokens call.

`stake-bwlk`

boardwalk stake-bwlk --amount 100 --wallet 0xYou --chain ethereum

[approve-bwlk?, stake-bwlk]. Ethereum-only — errors clearly on other chains.

`vote`

boardwalk vote --option 1 --wallet 0xYou --chain ethereum

Weekly revenue vote — epoch N's vote directs epoch N+1's budget. --option: 1 Treasury · 2 Buy & Burn BWLK · 3 Buy & Burn LP · 4 Participation. Prepends a BWLK approve only when the configured burn is > 0. Ethereum-only.

Read commands

boardwalk status      --token 0xLaunch --chain base
# → { token, chainId, status, path, presaleManager, raiseToken, seeded }
boardwalk launch-cost --chain base --wallet 0xYou
# → { chainId, baseBurn, discountBps, isMember, bwlkBurnCost }   (wei strings)

Submitting with Base MCP

get_wallets → use as --wallet
boardwalk <action> …        → take `calls`
send_calls(calls)           → one batched approval (approve + action)
get_request_status          → confirm

Staking and governance commands (stake-bwlk, unstake-bwlk, handle-rewards, vote, claim-participation) emit Ethereum calldata — submit those with a wallet that sends on chain 1.

SDK

Each builder takes a viem PublicClient (for live reads like allowance / burn cost) and returns TxStep[]; encodeSteps turns them into ready-to-submit calldata (with the builder-code suffix applied on Base).

import { createPublicClient, http } from "viem";
import { base } from "viem/chains";
import { buildContributeSteps, encodeSteps, getLaunch } from "@useboardwalk/sdk";

const client = createPublicClient({ chain: base, transport: http() });
const launch = await getLaunch("0xLaunch…", base.id); // { presaleManager, status, raiseToken, … }

const steps = await buildContributeSteps({
  client,
  account: "0xYou…",
  chainId: base.id,
  presale: launch.presaleManager!,
  amount: 10n ** 17n, // 0.1 raise token (wei)
});

const calls = encodeSteps(steps, base.id); // [{ to, data, value, chainId }, …] — sign + submit these

The launch metadata leg (buildLaunchMetadataTypedData → your wallet signs → postSignedMetadata), uploadLogo, and readLaunchCost are exported too. All public types come from one place — import type { … } from "@useboardwalk/sdk".

Agent skill

This package ships an Agent Skill at skills/boardwalk/SKILL.md that teaches an agent how and when to drive the CLI (and emit prefilled launch links). It references the CLI via npx; it does not bundle the SDK.

Claude Code — install as a plugin:

/plugin marketplace add useboardwalk/boardwalk-sdk
/plugin install boardwalk@boardwalk-sdk

Or drop it in by hand (swap ~/.claude for a project's .claude to scope it locally):

mkdir -p ~/.claude/skills/boardwalk
curl -sL https://unpkg.com/@useboardwalk/sdk/skills/boardwalk/SKILL.md \
  -o ~/.claude/skills/boardwalk/SKILL.md

Other agents (Cursor, Codex, Gemini CLI, …) — the standard skills/boardwalk/ layout loads anywhere the Agent Skills format is supported.

Logos

The logo is off-chain, metadata-only (logo_url in the signed metadata; a launch is valid without one). Provide it as a file path (--logo ./logo.png / uploadLogo(bytes, { mime })), base64 / data URL (--logo-data / uploadLogo(dataUrl) — e.g. an agent-generated image), or an already-hosted URL (--logo-url). Constraints: ≤ 1 MB (backend cap; compress larger images first) and a standard image MIME.

Note for Claude Code: an image pasted/dropped into the chat is not exposed to the agent as bytes — save it to a file (or reference an existing path) and use --logo <path>.

Attribution

SDK-built transactions on Base carry Boardwalk's ERC-8021 builder code, appended to the calldata so it survives any submit path (including send_calls). Base is where the code is registered (base.dev → Builder Codes), so non-Base chains carry no suffix. The code is fixed in src/constants.ts (BUILDER_CODE) and is enforced for Base — there is intentionally no per-call, CLI, or env override.

Maintainers: BUILDER_CODE is Boardwalk's registered code (from base.dev → Builder Codes); update it there if it ever rotates.

Chains

Ethereum (1) · Base (8453) · Arbitrum (42161) · Robinhood Chain (4663). Launch / contribute / claim / LP / swap / visibility work on all four; stake-bwlk, unstake-bwlk, handle-rewards, vote, and claim-participation are Ethereum-only (the SDK errors clearly elsewhere via assertDeployed).

Develop

npm run typecheck   # tsc --noEmit
npm test            # vitest
npm run build       # tsup → dist (ESM + CJS + d.ts)

See AGENTS.md for architecture and conventions.

Name		Name	Last commit message	Last commit date
Latest commit History 45 Commits
.claude-plugin		.claude-plugin
.github/workflows		.github/workflows
scripts		scripts
skills/boardwalk		skills/boardwalk
src		src
test		test
.coderabbit.yaml		.coderabbit.yaml
.gitattributes		.gitattributes
.gitignore		.gitignore
AGENTS.md		AGENTS.md
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts

Navigation Menu

Uh oh!

Repository files navigation

@useboardwalk/sdk

Install

CLI

`launch`

`launch-metadata` / `submit-metadata`

`contribute`

`claim`

`stake-bwlk`

`vote`

Read commands

Submitting with Base MCP

SDK

Agent skill

Logos

Attribution

Chains

Develop

About

Releases

Packages

Contributors

Languages

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

@useboardwalk/sdk

Install

CLI

launch

launch-metadata / submit-metadata

contribute

claim

stake-bwlk

vote

Read commands

Submitting with Base MCP

SDK

Agent skill

Logos

Attribution

Chains

Develop

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

`launch`

`launch-metadata` / `submit-metadata`

`contribute`

`claim`

`stake-bwlk`

`vote`