Contract operations
Generated from the package-owned CLI definitions: 92 operations in 15 groups. Every command runs as bun run contracts -- <command> from the repository root; bun run contracts -- help lists them and --help after any command explains it. Deployments, upgrades, migrations, and repairs require an explicit network and execution mode.
--explain --json describes resolution without credentials, service access, or execution. Broadcasts require release authorization. Planning, compilation, simulation, and upload can write artifacts. Read the owning runbook before executing an operation.
Execution modes
| Mode | Meaning |
|---|---|
| preflight | Compile/artifact checks without RPC |
| simulate | RPC simulation without broadcasting |
| plan | Produce transaction-plan artifacts |
| broadcast | Execute transactions |
| upload | Upload content and write associated artifacts |
Only the modes listed for each operation are accepted. Read-only operations do not require a mode. Release sessions retain the existing operator's stage, commit, credential, and transaction-boundary checks.
Operations
Commands that accept the same options sit in one table under that option list, so each list appears once. A required value is marked. A copied command carries everything the operation always needs: --network <network> when it is network-scoped, --mode <mode> when a mode is required, and --<name> <value> for each value marked required. Replace the placeholders with a network and mode from its row and your own values. A few operations need more in one mode only (a nonce to plan or broadcast, for instance); --help after the command says which.
Deploy (18)
Bring contracts, modules, and garden fixtures onto a network.
Options: --save-artifacts, --update-schemas, --force, --finalize-community-testimony, --skip-envio, --skip-verification, --start-indexer, --save-report, --override-sepolia-gate, --sender <value>, --salt <value>, --stage <value>, --step <value>, --expected-nonce <value>, --receipt <value>, --artifact <value>, --owner-phase <value>, --owner <value>, --genesis-hat-id <value>, --genesis-lock <value>, --first-work-lock <value>, --first-support-lock <value>, --genesis-metadata-uri <value>, --first-work-metadata-uri <value>, --first-support-metadata-uri <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- deploy core --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy goods --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy juicebox --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy octant-factory --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy garden <input> --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy actions <input> --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy hats-tree --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast |
bun run contracts -- deploy badge-locks --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | broadcast, preflight |
bun run contracts -- deploy greenwill --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast |
bun run contracts -- deploy badge-schemas --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | broadcast, preflight |
bun run contracts -- deploy commitment-schemas --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight, plan |
bun run contracts -- deploy pooling-configure --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight |
bun run contracts -- deploy ownership-transfer --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast, preflight, plan |
Options: --save-artifacts, --update-schemas, --force, --finalize-community-testimony, --skip-envio, --skip-verification, --start-indexer, --save-report, --override-sepolia-gate, --sender <value>, --salt <value>, --stage <value>, --step <value>, --expected-nonce <value> (required), --receipt <value>, --artifact <value>, --owner-phase <value>, --owner <value>, --genesis-hat-id <value>, --genesis-lock <value>, --first-work-lock <value>, --first-support-lock <value>, --genesis-metadata-uri <value>, --first-work-metadata-uri <value>, --first-support-metadata-uri <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- deploy pooling --network <network> --mode <mode> --expected-nonce <value> | arbitrum | simulate, broadcast, preflight, plan |
bun run contracts -- deploy settlement-module --network <network> --mode <mode> --expected-nonce <value> | arbitrum | simulate, broadcast, preflight, plan |
bun run contracts -- deploy credit-registry --network <network> --mode <mode> --expected-nonce <value> | arbitrum | simulate, broadcast, preflight, plan |
bun run contracts -- deploy settlement-executor --network <network> --mode <mode> --expected-nonce <value> | celo | simulate, broadcast, preflight, plan |
Options: --sender <value>, --expected-nonce <value>, --plan <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- deploy single-attestation-policy --network <network> --mode <mode> | localhost, sepolia, arbitrum | preflight, plan, simulate, broadcast |
Upgrade (18)
Move an upgradeable module to a new implementation.
Options: --override-sepolia-gate, --sender <value>, --expected-nonce <value>, --plan <value>, --step <value>, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- upgrade action-registry --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade garden-token --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade yield-resolver --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade gardens-module --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade signal-pool-yield-wiring --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade yield-gardens-wiring --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade octant-module --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade hats-module --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade cookie-jar-module --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade karma-gap-module --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade work-resolver --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade work-approval-resolver --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade assessment-resolver --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade testimony-resolver --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade deployment-registry --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade greenwill --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade commitment-pooling --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
bun run contracts -- upgrade all --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, plan, broadcast |
Verify (4)
Check that what a network records matches the source and the recorded policy.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- verify arbitrum-fork --network <network> | arbitrum | none |
bun run contracts -- verify reporting-kernel --network <network> --mode <mode> | arbitrum | simulate |
Options: --check-etherscan, --check-indexer-runtime, --check-steward-upgrade, --skip-indexer, --skip-indexer-runtime, --skip-local-indexer-start, --start-local-indexer, --stop-local-indexer-after-check, --no-octant, --no-cookiejar, --ack-product-copy, --require-product-copy, --rpc-url <value>, --chain-id <value>, --community-slug <value>, --expected-hats-implementation <value>, --indexer-poll-seconds <value>, --indexer-timeout-seconds <value>, --indexer-url <value>, --steward-baseline <value>, --steward-probe-account <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- verify --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |
Options: --publish-source, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- verify single-attestation-policy --network <network> | localhost, sepolia, arbitrum | none |
Status (1)
Read-only reports; no mode needed.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- status --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |
Release (6)
Run a release session step by step with its transaction boundaries.
Options: --save-artifacts, --sender <value>, --salt <value>, --stage <value>, --step <value>, --expected-nonce <value>, --receipt <value>, --artifact <value>, --owner-phase <value>, --owner <value>, --genesis-hat-id <value>, --genesis-lock <value>, --first-work-lock <value>, --first-support-lock <value>, --genesis-metadata-uri <value>, --first-work-metadata-uri <value>, --first-support-metadata-uri <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- release manifest --network <network> | localhost, sepolia, arbitrum, celo, mainnet | preflight (optional) |
bun run contracts -- release core --network <network> | localhost, sepolia, arbitrum, celo, mainnet | preflight (optional) |
bun run contracts -- release recover --network <network> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate (optional) |
bun run contracts -- release verify --network <network> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate (optional) |
bun run contracts -- release indexer-handoff --network <network> | localhost, sepolia, arbitrum, celo, mainnet | preflight (optional) |
Options: --stage <value>, --commit <value> (required).
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- release operator --commit <value> | not network-scoped | none |
Settlement (23)
Operate the settlement lane.
Options: --plan <value>, --safe-plan <value>, --step <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-roles plan --network <network> | celo | none |
bun run contracts -- settlement garden-roles verify --network <network> | celo | none |
bun run contracts -- settlement garden-routes plan --network <network> | celo | none |
bun run contracts -- settlement garden-routes verify --network <network> | celo | none |
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement dual-chain up | not network-scoped | none |
bun run contracts -- settlement dual-chain down | not network-scoped | none |
bun run contracts -- settlement dual-chain courier | not network-scoped | none |
Options: --plan <value>, --safe-plan <value>, --step <value> (required).
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-roles deploy --network <network> --mode <mode> --step <value> | celo | broadcast |
bun run contracts -- settlement garden-roles enable --network <network> --mode <mode> --step <value> | celo | broadcast |
bun run contracts -- settlement garden-routes configure --network <network> --mode <mode> --step <value> | celo | broadcast |
Options: --plan <value>, --raw-bundle <value>, --step <value>, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-accounts plan --network <network> | celo | none |
bun run contracts -- settlement garden-accounts verify --network <network> | celo | none |
Options: --plan <value>, --safe-plan <value>, --step <value>, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-relay plan --network <network> | celo | none |
bun run contracts -- settlement garden-relay verify --network <network> | celo | none |
Options: --plan <value>, --inventory <value>, --step <value>, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-safes plan --network <network> | celo | none |
bun run contracts -- settlement garden-safes verify --network <network> | celo | none |
Options: --save-artifacts, --sender <value>, --salt <value>, --stage <value>, --step <value>, --expected-nonce <value>, --receipt <value>, --artifact <value>, --owner-phase <value>, --owner <value>, --genesis-hat-id <value>, --genesis-lock <value>, --first-work-lock <value>, --first-support-lock <value>, --genesis-metadata-uri <value>, --first-work-metadata-uri <value>, --first-support-metadata-uri <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement safe --network <network> | celo | preflight, simulate (optional) |
bun run contracts -- settlement peer --network <network> | arbitrum | preflight (optional) |
Options: --plan <value>, --raw-bundle <value>, --step <value> (required), --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-accounts deploy --network <network> --mode <mode> --step <value> | celo | broadcast |
Options: --plan <value>, --safe-plan <value>, --step <value> (required), --receipt <value> (required).
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-relay adopt --network <network> --step <value> --receipt <value> | celo | none |
Options: --plan <value>, --safe-plan <value>, --step <value> (required), --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-relay deploy --network <network> --mode <mode> --step <value> | celo | broadcast |
Options: --plan <value>, --inventory <value>, --step <value> (required), --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement garden-safes deploy --network <network> --mode <mode> --step <value> | celo | broadcast |
Options: --save-artifacts, --sender <value>, --salt <value>, --stage <value>, --step <value>, --expected-nonce <value>, --receipt <value> (required), --artifact <value>, --owner-phase <value>, --owner <value>, --genesis-hat-id <value>, --genesis-lock <value>, --first-work-lock <value>, --first-support-lock <value>, --genesis-metadata-uri <value>, --first-work-metadata-uri <value>, --first-support-metadata-uri <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- settlement peer-verify --network <network> --receipt <value> | arbitrum | none |
Commitment pooling (1)
Operate the commitment pooling module.
Options: --override-sepolia-gate, --authority <value>, --plan <value>, --step <value>, --expected-nonce <value>, --expected-safe-nonce <value>, --receipt <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- pooling backfill --network <network> --mode <mode> | arbitrum | simulate, broadcast |
Migrate (3)
Move recorded state to a newer contract version.
Options: --force, --rpc-url <value>, --chain-id <value>, --slug <value>, --uid <value>, --translations <value>, --preview-dir <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- migrate action-instructions-v2 --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, upload, broadcast |
Options: --rpc-url <value>, --chain-id <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- migrate action-instructions-v2 check --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate |
Options: --sender <value>, --rpc-url <value>, --chain-id <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- migrate vaults --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast |
Repair (1)
Reconcile a deployment with its artifact.
Options: --sender <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- repair octant-assets --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | preflight, simulate, broadcast |
ENS (7)
Manage garden names across the ENS registry and receiver.
Options: --new-receiver <value>, --sender <value>, --registrations-file <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- ens deploy-mainnet --network <network> --mode <mode> | mainnet | preflight, simulate, broadcast |
bun run contracts -- ens deploy-sepolia --network <network> --mode <mode> | sepolia | preflight, simulate, broadcast |
bun run contracts -- ens update-l1-receiver --network <network> --mode <mode> | arbitrum | preflight, simulate, broadcast |
Options: --account <value>, --amount <value>, --min-sponsored-claims <value>, --sample-owner <value>, --sample-slug <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- ens sponsor status --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |
bun run contracts -- ens sponsor monitor --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |
bun run contracts -- ens sponsor top-up --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | broadcast |
Options: --sender <value>, --registrations-file <value>, --new-receiver <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- ens migrate --network <network> --mode <mode> | mainnet | preflight, simulate, broadcast |
Hypercert marketplace (2)
Manage the marketplace adapter and its strategies.
Options: --rpc-url <value>, --chain-id <value>, --expected-owner <value>.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- marketplace status --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |
bun run contracts -- marketplace configure --network <network> --mode <mode> | localhost, sepolia, arbitrum, celo, mainnet | simulate, broadcast |
Minting (1)
Mint from approved work.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- minting open --network <network> --mode <mode> | sepolia, arbitrum | broadcast |
IPFS (2)
Upload content and record its identifiers.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- ipfs upload | not network-scoped | none |
bun run contracts -- ipfs cache | not network-scoped | none |
Indexer (4)
Coordinate the Envio indexer around a deployment.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- indexer update <input> | not network-scoped | none |
bun run contracts -- indexer watch <input> | not network-scoped | none |
bun run contracts -- indexer start | not network-scoped | none |
bun run contracts -- indexer restore | not network-scoped | none |
Fork (1)
Prepare a local Arbitrum fork for rehearsal.
No options beyond the command itself.
| Command | Networks | Modes |
|---|---|---|
bun run contracts -- fork --network <network> | localhost, sepolia, arbitrum, celo, mainnet | none |