Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/base-std-docs-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ jobs:
# scripts/sync-from-base-std, then commits the result and opens a PR.
# --------------------------------------------------------------------------
apply:
# A streamed page edit takes seconds to a few minutes; a run that is still
# going after this long is stuck, not working.
timeout-minutes: 30
name: Open docs PR from base-std dispatch
needs: authorize
# Kill switch: see "Emit kill-switch notice" step in the authorize job
Expand Down
2 changes: 1 addition & 1 deletion docs/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ npx skills add base/base-skills
|Specifications/Specifications/Base Protocol/Execution:specifications/base-protocol/execution/l2-execution-engine,specifications/base-protocol/execution/precompiles,specifications/base-protocol/execution/predeploys,specifications/base-protocol/execution/preinstalls
|Specifications/Specifications/Base Protocol/Bridging:specifications/base-protocol/bridging/standard-bridges,specifications/base-protocol/bridging/deposits,specifications/base-protocol/bridging/withdrawals,specifications/base-protocol/bridging/cross-domain-messengers,specifications/base-protocol/bridging/base-solana-bridge
|Specifications/Specifications/Base Protocol/Proofs:specifications/base-protocol/proofs/overview,specifications/base-protocol/proofs/challenger,specifications/base-protocol/proofs/proposer,specifications/base-protocol/proofs/registrar,specifications/base-protocol/proofs/tee-prover,specifications/base-protocol/proofs/zk-prover,specifications/base-protocol/proofs/proof-contracts
|Specifications/Specifications/B20:specifications/b20/specification-overview,specifications/b20/launch-a-b20-token,specifications/b20/tokenized-stocks-on-base,specifications/b20/changelog
|Specifications/Specifications/B20:specifications/b20/specification-overview,specifications/b20/tokenized-stocks-on-base,specifications/b20/changelog
|Specifications/Specifications/B20/Reference:specifications/b20/reference/constants-addresses,specifications/b20/reference/errors-events,specifications/b20/reference/invariants-tests
|Specifications/Specifications/B20/Reference/Interfaces:specifications/b20/reference/interfaces/i-activation-registry,specifications/b20/reference/interfaces/ib20,specifications/b20/reference/interfaces/ib20-asset,specifications/b20/reference/interfaces/ib20-factory,specifications/b20/reference/interfaces/ib20-stablecoin,specifications/b20/reference/interfaces/i-policy-registry
|Specifications/Specifications/Transactions:specifications/transactions/transaction-ordering,specifications/transactions/transaction-finality,specifications/transactions/network-fees,specifications/transactions/throughput-and-limits,specifications/transactions/troubleshooting-transactions
Expand Down
2 changes: 1 addition & 1 deletion docs/base-chain/quickstart/connecting-to-base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Base is an EVM-compatible Layer 2 network. Use the details below to connect your
| Block Explorer | [sepolia.basescan.org](https://sepolia.basescan.org) |
</Tab>
<Tab title="Vibenet">
Vibenet is Base's experimental preview network where new chain-level features are available before they roll out to Sepolia or Mainnet. It currently hosts [B20 tokens](/specifications/b20/launch-a-b20-token) — an ERC-20 superset with built-in roles, supply caps, pausing, policy gating, and `permit` implemented as a native precompile.
Vibenet is Base's experimental preview network where new chain-level features are available before they roll out to Sepolia or Mainnet. It currently hosts [B20 tokens](/build-on-base/issue-rwa/create-an-asset-token) — an ERC-20 superset with built-in roles, supply caps, pausing, policy gating, and `permit` implemented as a native precompile.

Use Vibenet to build against cutting-edge Base features. It is not intended for production or user-facing applications. Learn more at [chain.base.org/vibenet](https://chain.base.org/vibenet).

Expand Down
2 changes: 1 addition & 1 deletion docs/build-on-base/accept-payments/request-a-payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ function pay(bytes32 orderId, uint256 amount) external {
</Tab>
</Tabs>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete B20 interface and memo details.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete B20 interface and memo details.

## Verify Before Fulfillment

Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/announce-a-distribution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Announce and Distribute the Stock Dividend
Expand Down Expand Up @@ -66,7 +66,7 @@ export async function announceStockDividend(token: Address, holders: Address[])
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
The unique announcement ID is marked used and the batch mint executes between `Announcement` and `EndAnnouncement`.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/apply-a-multiplier.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Apply and Verify the Split Multiplier
Expand Down Expand Up @@ -57,7 +57,7 @@ base-cast call "$TOKEN_ADDRESS" "scaledBalanceOf(address)(uint256)" "$HOLDER" --
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
`multiplier()` returns `2e18`; raw balances remain unchanged while scaled balances double.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/cancel-blocked-units.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Cancel and Verify Blocked Shares
Expand Down Expand Up @@ -53,7 +53,7 @@ base-cast call "$TOKEN_ADDRESS" "balanceOf(address)(uint256)" "$BLOCKED_HOLDER"
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
The holder balance and total supply each fall by 100 EXM.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/create-an-asset-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Create and Verify the Stock Token
Expand Down Expand Up @@ -71,7 +71,7 @@ export async function createStockToken() {
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
The factory emits `B20Created` for the Asset variant and returns the deterministic token address.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/issue-units.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Issue and Verify the Shares
Expand Down Expand Up @@ -60,7 +60,7 @@ base-cast call "$TOKEN_ADDRESS" "balanceOf(address)(uint256)" "$ALICE" --rpc-url
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
Alice holds 600 EXM and Bob holds 400 EXM after the all-or-nothing batch.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/pause-transfers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Pause and Resume Stock Transfers
Expand Down Expand Up @@ -49,7 +49,7 @@ base-cast send "$TOKEN_ADDRESS" "unpause(uint8[])" "[0]" \
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
Transfer pause state changes without pausing mint or burn.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-rwa/restrict-eligible-holders.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/build-on-base/issue-rwa/create-an-asset-token) 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`.
</Note>

## Create and Bind the Eligibility Policy
Expand Down Expand Up @@ -67,7 +67,7 @@ done
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/build-on-base/issue-rwa/create-an-asset-token) for the complete interface, roles, and policies.

<Check>
The same allowlist policy gates mint recipients, transfer senders, and transfer recipients.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/block-an-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Block and Verify an Account
Expand Down Expand Up @@ -64,7 +64,7 @@ base-cast call "$POLICY_REGISTRY" "isAuthorized(uint64,address)(bool)" \
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
`isAuthorized(policyId, account)` returns `false` while the account is blocked.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/burn-supply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Burn and Verify Supply
Expand Down Expand Up @@ -54,7 +54,7 @@ base-cast call "$TOKEN_ADDRESS" "totalSupply()(uint256)" --rpc-url "$RPC_URL"
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
`totalSupply()` decreases by exactly 400 MUSD.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Create and Verify the Stablecoin
Expand Down Expand Up @@ -84,7 +84,7 @@ export async function createStablecoin() {
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
The factory emits `B20Created`, and the returned token address is ready for minting.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/mint-supply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Mint and Verify Supply
Expand Down Expand Up @@ -53,7 +53,7 @@ base-cast call "$TOKEN_ADDRESS" "balanceOf(address)(uint256)" "$HOLDER" --rpc-ur
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
The holder balance increases by `1,000,000,000` base units, or 1,000 MUSD.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/pause-activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Pause and Resume Transfers
Expand Down Expand Up @@ -51,7 +51,7 @@ base-cast send "$TOKEN_ADDRESS" "unpause(uint8[])" "[0]" \
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
`isPaused(0)` returns `true` after pausing and `false` after resuming.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/reconcile-with-memos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Attach and Read an Invoice Memo
Expand Down Expand Up @@ -52,7 +52,7 @@ base-cast receipt "$TX" --rpc-url "$RPC_URL"
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
The receipt contains `Transfer` followed immediately by `Memo`, with `invoice-8842` encoded as `bytes32`.
Expand Down
4 changes: 2 additions & 2 deletions docs/build-on-base/issue-stablecoins/recover-funds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Burn and Reissue the Blocked Balance
Expand Down Expand Up @@ -56,7 +56,7 @@ base-cast call "$TOKEN_ADDRESS" "balanceOf(address)(uint256)" "$REPLACEMENT" --r
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
The blocked balance falls and the replacement address receives the same amount, leaving circulating supply unchanged.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The demo uses a local browser-generated account to submit real transactions on *
</Tip>

<Note>
New to B20? See the [B20 Token Standard](/specifications/b20/launch-a-b20-token) 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`.
New to B20? See the [B20 Token Standard](/specifications/b20/specification-overview) 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`.
</Note>

## Create and Bind a Holder Allowlist
Expand Down Expand Up @@ -73,7 +73,7 @@ done
```
</CodeGroup>

See the [B20 token standard](/specifications/b20/launch-a-b20-token) for the complete interface, roles, and policies.
See the [B20 token standard](/specifications/b20/specification-overview) for the complete interface, roles, and policies.

<Check>
The token returns the new policy ID for both transfer policy scopes.
Expand Down
Loading
Loading