Skip to content

Commit e548c58

Browse files
updated docs (#1363)
* updated docs * updated agents * updated agents * updated links * updated links --------- Co-authored-by: Eric Brown <eric.brown@coinbase.com>
1 parent 91cf0c6 commit e548c58

16 files changed

Lines changed: 176 additions & 546 deletions

docs/agents.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Base is an Ethereum L2 by Coinbase. Docs for: Base Chain, Smart Wallet, OnchainK
1111
|ai-agents/skills/trading:alchemy-agentic-gateway,coingecko,swap-execution
1212
|ai-agents/skills/wallets:bankr,cdp-agentic-wallet,sponge-wallet
1313
|ai-agents/trading:data-fetching,trade-execution
14+
|apps/builder-codes:agent-developers,app-developers,builder-codes,wallet-developers
1415
|apps/growth:rewards
15-
|apps/quality-and-publishing:overview,quality-bar,submission-guidelines
16-
|apps/quickstart:build-checklist,building-for-the-base-app,create-new-app,migrate-existing-apps,migrate-to-standard-web-app,template
17-
|apps/technical-guides:accept-payments,base-notifications,building-chat-agents,neynar-notifications,sharing-and-social-graph,sign-manifest
18-
|base-account/basenames:basename-transfer,basenames-faq,basenames-wagmi-tutorial
16+
|apps/guides:migrate-to-standard-web-app
17+
|apps/quickstart:build-app
18+
|apps/resources:design-resources,templates
19+
|apps/technical-guides:base-notifications
20+
|base-account/basenames:basename-transfer,basenames-faq
1921
|base-account/contribute:contribute-to-base-account-docs,security-and-bug-bounty
2022
|base-account/framework-integrations:cdp,rainbowkit,reown,thirdweb
2123
|base-account/framework-integrations/privy:authentication,setup,spend-permissions,sub-accounts,wallet-actions
@@ -40,12 +42,11 @@ Base is an Ethereum L2 by Coinbase. Docs for: Base Chain, Smart Wallet, OnchainK
4042
|base-chain/api-reference/debug-api:debug_traceBlockByHash,debug_traceBlockByNumber,debug_traceTransaction
4143
|base-chain/api-reference/ethereum-json-rpc-api:eth_blockNumber,eth_call,eth_chainId,eth_estimateGas,eth_feeHistory,eth_gasPrice,eth_getBalance,eth_getBlockByHash,eth_getBlockByNumber,eth_getBlockReceipts,eth_getBlockTransactionCountByHash,eth_getBlockTransactionCountByNumber,eth_getCode,eth_getLogs,eth_getStorageAt,eth_getTransactionByBlockHashAndIndex,eth_getTransactionByBlockNumberAndIndex,eth_getTransactionByHash,eth_getTransactionCount,eth_getTransactionReceipt,eth_maxPriorityFeePerGas,eth_sendRawTransaction,eth_subscribe,eth_syncing,eth_unsubscribe,net_version,web3_clientVersion
4244
|base-chain/api-reference/flashblocks-api:base_transactionStatus,eth_simulateV1,flashblocks-api-overview,newFlashblockTransactions,newFlashblocks,pendingLogs
43-
|base-chain/builder-codes:agent-developers,app-developers,builder-codes,wallet-developers
44-
|base-chain/flashblocks:app-integration,architecture,faq,overview,run-a-flashblocks-node
45+
|base-chain/flashblocks:app-integration,architecture,faq,overview
4546
|base-chain/network-information:base-contracts,block-building,bridges,configuration-changelog,diffs-ethereum-base,ecosystem-contracts,network-faucets,network-fees,transaction-finality,troubleshooting-transactions
46-
|base-chain/node-operators:node-providers,performance-tuning,run-a-base-node,snapshots,troubleshooting
47+
|base-chain/node-operators:base-v1-upgrade,node-providers,performance-tuning,run-a-base-node,snapshots,troubleshooting
4748
|base-chain/quickstart:base-solana-bridge,connecting-to-base,deploy-on-base,why-base
4849
|base-chain/security:avoid-malicious-flags,bug-bounty,report-vulnerability,security-council
49-
|get-started:base-mentorship-program,base-services-hub,base,block-explorers,build-app,concepts,country-leads-and-ambassadors,data-indexers,deploy-smart-contracts,docs-llms,docs-mcp,get-funded,launch-token,learning-resources,mistakes,prompt-library,resources-for-ai-agents
50+
|get-started:base-mentorship-program,base-services-hub,base,block-explorers,concepts,country-leads-and-ambassadors,data-indexers,deploy-smart-contracts,docs-llms,docs-mcp,get-funded,launch-token,learning-resources,mistakes,prompt-library,resources-for-ai-agents
5051
|onchainkit:migrate-from-onchainkit
5152
|root:agents,changes,cookie-policy,privacy-policy,terms-of-service,tone_of_voice

docs/apps/quickstart/migrate-to-standard-web-app.mdx renamed to docs/apps/guides/migrate-to-standard-web-app.mdx

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Migrate to a Standard Web App"
33
description: "Migrate your Farcaster mini-app to work in the Base App. Covers replacing deprecated SDK methods, and registering on Base.dev."
4-
tag: "NEW"
54
---
65

76
<Warning>
@@ -20,7 +19,7 @@ The Base App is moving from the Farcaster mini-app spec to a single model: **sta
2019
| --- | --- |
2120
| Farcaster manifest (`/.well-known/farcaster.json`) | App metadata on [Base.dev](https://www.base.dev) projects. Already registered apps do not need to update metadata. |
2221
| Neynar webhooks for add/remove events | Base-owned backends (Base Account / address preferences) |
23-
| FID-based notifications via Neynar | Wallet-address notifications via Base.dev notifications API *(coming soon)* |
22+
| FID-based notifications via Neynar | Wallet-address notifications through the [Notifications API](/apps/technical-guides/base-notifications) |
2423
| Farcaster SDK for auth and actions | wagmi + viem + Sign-In with Ethereum (SIWE) |
2524
| Search and discovery via Farcaster | Base.dev app metadata + [builder codes](https://docs.base.org/apps/builder-codes/builder-codes) |
2625

@@ -166,10 +165,7 @@ Your app uses the Farcaster SDK. The migration replaces Farcaster-specific auth,
166165
</Step>
167166

168167
<Step title="Migrate notifications to Base.dev">
169-
<Warning>
170-
Notifications migration will be available in Base.dev soon.
171-
</Warning>
172-
Farcaster-based notifications (via Neynar, FIDs, or tokens) will not reach Base App users. Replace them with the Base.dev notifications API, which sends by wallet address.
168+
Farcaster-based notifications (via Neynar, FIDs, or tokens) will not reach Base App users. Follow the [Notifications guide](/apps/technical-guides/base-notifications) to fetch opted-in wallet addresses and send notifications through the Base Dashboard API.
173169
</Step>
174170

175171
<Step title="Register on Base.dev">
@@ -197,10 +193,7 @@ Your app is already a standard web app. You're mostly done — just verify your
197193
</Step>
198194

199195
<Step title="Integrate notifications (optional)">
200-
<Warning>
201-
Notifications migration will be available in Base.dev soon.
202-
</Warning>
203-
Use the Base.dev notifications API to send wallet-address notifications to users who installed your app and opted in.
196+
Follow the [Notifications guide](/apps/technical-guides/base-notifications) to send wallet-address notifications to users who installed your app and opted in.
204197
</Step>
205198
</Steps>
206199

@@ -250,10 +243,7 @@ Before considering your app migrated, verify the following:
250243
</Step>
251244

252245
<Step title="Notifications use Base.dev API (if applicable)">
253-
<Warning>
254-
Notifications migration will be available in Base.dev soon.
255-
</Warning>
256-
Notifications are sent via the Base.dev notifications API by wallet address — not via Neynar, FIDs, or tokens.
246+
Notifications are sent by wallet address using the [Notifications guide](/apps/technical-guides/base-notifications), not through Neynar, FIDs, or tokens.
257247
</Step>
258248

259249
</Steps>

docs/apps/llms-full.txt

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,43 @@
55
> The Base App now treats all apps as standard web apps. Migrate from Farcaster-specific SDKs to wagmi + SIWE, register on Base.dev, and earn rewards for driving onchain activity.
66

77
### What you can do here
8+
- Build a Next.js app on Base with wagmi, viem, wallet connection, contract reads, contract writes, and batch transactions
89
- Migrate an existing Farcaster-embedded app to a standard web app compatible with the Base App
910
- Register your app on Base.dev for search, discovery, and rewards eligibility
1011
- Replace deprecated Farcaster SDK methods with standard web equivalents (wagmi, viem, SIWE)
1112
- Earn financial rewards for building apps that drive user engagement and onchain transactions
13+
- Attribute onchain transactions to your app using Builder Codes (ERC-8021)
14+
- Send in-app push notifications to opted-in users via the Base Dashboard Notifications API
1215

1316
## Navigation (with brief descriptions)
1417

1518
### Quickstart
16-
- [Migrate to a Standard Web App](https://docs.base.org/apps/quickstart/migrate-to-standard-web-app.md) — Step-by-step migration guide: replace Farcaster SDK, update auth and wallet logic, register on Base.dev
19+
- [Build an App](https://docs.base.org/apps/quickstart/build-app.md) — Step-by-step guide to build a Next.js app on Base with wagmi and viem
20+
21+
### Guides
22+
- [Add notifications](https://docs.base.org/apps/technical-guides/base-notifications.md) — REST API (via Base Dashboard) to fetch opted-in users and send in-app notifications; Base App only
23+
- [Migrate to a Standard Web App](https://docs.base.org/apps/guides/migrate-to-standard-web-app.md) — Step-by-step migration guide: replace Farcaster SDK, update auth and wallet logic, register on Base.dev
1724

1825
### Growth
1926
- [Rewards](https://docs.base.org/apps/growth/rewards.md) — Verification programs, competitions, and partner opportunities for earning rewards
2027

28+
### Builder Codes
29+
- [Builder Codes overview](https://docs.base.org/apps/builder-codes/builder-codes.md) — ERC-8021 NFT codes that attribute onchain transactions to your app; register on base.dev under Settings → Builder Code
30+
- [For App Developers](https://docs.base.org/apps/builder-codes/app-developers.md) — Append a dataSuffix to transactions using wagmi or viem; no contract changes required
31+
- [For Wallet Developers](https://docs.base.org/apps/builder-codes/wallet-developers.md) — Implement the ERC-5792 DataSuffixCapability so wallets pass through attribution suffixes
32+
- [For Agent Developers](https://docs.base.org/apps/builder-codes/agent-developers.md) — Attribute AI agent transactions via the Builder Codes API
2133

2234
## Key Concepts (excerpts)
2335

24-
Source: `https://docs.base.org/apps/quickstart/migrate-to-standard-web-app.md`
36+
Source: `https://docs.base.org/apps/guides/migrate-to-standard-web-app.md`
2537

2638
After April 9, 2026, the Base App treats all apps as standard web apps regardless of Farcaster manifests. Key changes:
2739

2840
| Before | After |
2941
| --- | --- |
3042
| Farcaster manifest (`/.well-known/farcaster.json`) | App metadata on Base.dev |
3143
| Neynar webhooks for add/remove events | Base-owned backends (Base Account / address preferences) |
32-
| FID-based notifications via Neynar | Wallet-address notifications via Base.dev notifications API |
44+
| FID-based notifications via Neynar | Wallet-address notifications through the Notifications API |
3345
| Farcaster SDK for auth and actions | wagmi + viem + Sign-In with Ethereum (SIWE) |
3446
| Search and discovery via Farcaster | Base.dev app metadata + builder codes |
3547

@@ -43,6 +55,25 @@ Base.dev rewards developers who build apps that deliver real value and drive mea
4355
1. Submit your app for verification on Base.dev — validates ownership by adding a Base builder address in the manifest
4456
2. Access earning opportunities — partner programs, competitions, and special campaigns
4557

58+
Source: `https://docs.base.org/apps/builder-codes/builder-codes.md`
59+
60+
Builder Codes are ERC-721 NFTs (unique strings like "abc123") that tag transactions with your app identity using ERC-8021 calldata suffixes. No contract changes are required — attribution is extracted offchain. Benefits: automatic reward attribution, analytics on base.dev, and discovery surface visibility. The suffix adds 16 gas per non-zero byte. Works with EOAs, smart wallets (ERC-5792 `dataSuffix` capability), and embedded wallets (Privy, Turnkey).
61+
62+
Source: `https://docs.base.org/apps/technical-guides/base-notifications.md`
63+
64+
The Notifications API sends in-app push notifications to Base App users who have pinned your app and opted in. Requires a Base Dashboard project and API key.
65+
66+
Key constraints:
67+
- Notifications delivered in the **Base App only** — not other platforms
68+
- Rate limit: **20 requests/minute per IP** shared across both endpoints
69+
- `POST /send`: up to 1,000 addresses per request; title ≤30 chars, message ≤200 chars
70+
- Deduplication: identical notifications within 24 hours are suppressed automatically
71+
- Failure reasons: `user has not saved this app`, `user has notifications disabled`
72+
73+
Workflow:
74+
1. `GET /v1/notifications/app/users?app_url=<url>&notification_enabled=true` — fetch opted-in wallet addresses (paginated, cursor-based)
75+
2. `POST /v1/notifications/send` — send title + message + optional `target_path` to up to 1,000 addresses
76+
4677

4778
## Related indexes
4879
- Root index: `../llms.txt`

docs/apps/llms.txt

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,18 @@
55
> Build apps that run in the Base App as standard web apps — no Farcaster SDK required. Register on Base.dev, use wagmi + SIWE for auth, and earn rewards for driving onchain activity.
66

77
## Quickstart
8-
- [Migrate to a Standard Web App](https://docs.base.org/apps/quickstart/migrate-to-standard-web-app.md) — Replace deprecated Farcaster SDK methods and register your app on Base.dev
8+
- [Build an App](https://docs.base.org/apps/quickstart/build-app.md) — End-to-end guide to ship your first app on Base
9+
10+
## Guides
11+
- [Add notifications](https://docs.base.org/apps/technical-guides/base-notifications.md) — Send in-app notifications to users via the Base Dashboard REST API
12+
- [Migrate to a Standard Web App](https://docs.base.org/apps/guides/migrate-to-standard-web-app.md) — Replace deprecated Farcaster SDK methods and register your app on Base.dev
913

1014
## Growth
1115
- [Rewards](https://docs.base.org/apps/growth/rewards.md) — Earn financial incentives for building apps that drive user engagement and onchain transactions
16+
17+
## Builder Codes
18+
- [Builder Codes overview](https://docs.base.org/apps/builder-codes/builder-codes.md) — Attribute onchain activity to your app using ERC-8021 NFT codes; register on base.dev
19+
- [For App Developers](https://docs.base.org/apps/builder-codes/app-developers.md) — Integrate Builder Codes using wagmi or viem
20+
- [For Wallet Developers](https://docs.base.org/apps/builder-codes/wallet-developers.md) — Implement the dataSuffix ERC-5792 capability
21+
- [For Agent Developers](https://docs.base.org/apps/builder-codes/agent-developers.md) — Attribute AI agent transactions via the API
22+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ Base is a fast, low-cost Ethereum L2 built to bring the next billion users oncha
541541

542542
- **Go to mainnet** — add `base` to your `chains` array and transports in `config/wagmi.ts`, redeploy your contract to Base mainnet, and update `COUNTER_ADDRESS`.
543543
- **Sponsor gas** — use the `paymasterService` capability with `useSendCalls` to cover your users' transaction fees. See [Sponsor Gas](/base-account/improve-ux/sponsor-gas/paymasters).
544+
- **Send notifications** — use the [Notifications guide](/apps/technical-guides/base-notifications) to fetch opted-in wallet addresses and send in-app notifications.
544545
- **Batch read calls** — reduce RPC round trips by batching reads via viem's `multicall`.
545546
- **Optimistic updates** — update the UI before confirmation using TanStack Query's `onMutate` callback.
546547
- **Wagmi setup reference** — review the full [Wagmi setup guide](/base-account/framework-integrations/wagmi/setup) for additional configuration options.

docs/apps/technical-guides/base-notifications.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Notifications"
2+
title: "Add notifications"
33
description: "Send in-app notifications to your app's users through the Base Dashboard REST API."
44
---
55

@@ -19,7 +19,7 @@ The Notifications API lets you send in-app notifications to users who have pinne
1919
Both endpoints require your API key in the `x-api-key` header.
2020

2121
<Info>
22-
The notification endpoints share a rate limit of **10 requests per minute per IP**. Requests to either endpoint count toward the same limit. Exceeding it returns a `429 Too Many Requests` response.
22+
The notification endpoints share a rate limit of **20 requests per minute per IP**. Requests to either endpoint count toward the same limit. Exceeding it returns a `429 Too Many Requests` response.
2323
</Info>
2424

2525
Fetch the wallet addresses of users who have opted in to notifications for your app:
@@ -90,7 +90,7 @@ GET https://dashboard.base.org/api/v1/notifications/app/users
9090
</ParamField>
9191

9292
<ParamField query="limit" type="integer">
93-
Maximum users per page. Capped at 100.
93+
Maximum users per page. Capped at 500.
9494
</ParamField>
9595

9696
#### Response

docs/base-chain/llms-full.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848

4949
### Node Operators
5050
- [Run a Base Node](https://docs.base.org/base-chain/node-operators/run-a-base-node.md) — Node setup
51+
- [Base Azul Upgrade](https://docs.base.org/base-chain/node-operators/base-v1-upgrade.md) — Migrate to base-reth-node and base-consensus for Azul
5152
- [Performance Tuning](https://docs.base.org/base-chain/node-operators/performance-tuning.md) — Optimization
5253
- [Snapshots](https://docs.base.org/base-chain/node-operators/snapshots.md) — Snapshot sync
5354
- [Troubleshooting](https://docs.base.org/base-chain/node-operators/troubleshooting.md) — Common fixes

docs/base-chain/llms.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,18 @@
1313
## Network Information
1414
- [Network Fees](https://docs.base.org/base-chain/network-information/network-fees.md) — L2 execution and L1 data costs on Base
1515
- [Base Contracts](https://docs.base.org/base-chain/network-information/base-contracts.md) — Core contracts and addresses
16+
- [Block Building](https://docs.base.org/base-chain/network-information/block-building.md) — How blocks are ordered and built on Base
1617
- [Bridges](https://docs.base.org/base-chain/network-information/bridges.md) — Official and third-party bridge options
18+
- [Differences: Ethereum & Base](https://docs.base.org/base-chain/network-information/diffs-ethereum-base.md) — Behavioral differences between Base and Ethereum
19+
- [Transaction Finality](https://docs.base.org/base-chain/network-information/transaction-finality.md) — When transactions become irreversible on Base
1720
- [Troubleshooting Transactions](https://docs.base.org/base-chain/network-information/troubleshooting-transactions.md) — Diagnose and fix common transaction issues
21+
- [Configuration Changelog](https://docs.base.org/base-chain/network-information/configuration-changelog.md) — Log of network configuration changes
1822
- [Network Faucets](https://docs.base.org/base-chain/network-information/network-faucets.md) — Obtain testnet ETH for Base Sepolia
1923

2024
## Flashblocks
2125
- [Overview](https://docs.base.org/base-chain/flashblocks/overview.md) — What Flashblocks is and how it works
2226
- [App Integration](https://docs.base.org/base-chain/flashblocks/app-integration.md) — How apps integrate with Flashblocks
27+
- [Architecture](https://docs.base.org/base-chain/flashblocks/architecture.md) — Sequencer architecture and infrastructure components
2328
- [FAQ](https://docs.base.org/base-chain/flashblocks/faq.md) — Frequently asked questions about Flashblocks
2429

2530
## API Reference
@@ -30,7 +35,10 @@
3035

3136
## Node Operators
3237
- [Run a Base Node](https://docs.base.org/base-chain/node-operators/run-a-base-node.md) — Setup and operations guide
38+
- [Base Azul Upgrade](https://docs.base.org/base-chain/node-operators/base-v1-upgrade.md) — Migrate to base-reth-node and base-consensus for Azul
3339
- [Performance Tuning](https://docs.base.org/base-chain/node-operators/performance-tuning.md) — Optimize node performance
40+
- [Snapshots](https://docs.base.org/base-chain/node-operators/snapshots.md) — Snapshot sync to speed up initial node setup
41+
- [Troubleshooting](https://docs.base.org/base-chain/node-operators/troubleshooting.md) — Diagnose and fix common node issues
3442
- [Node Providers](https://docs.base.org/base-chain/node-operators/node-providers.md) — RPC node providers for Base
3543

3644
## Protocol Specs
@@ -59,6 +67,7 @@
5967
## Security
6068
- [Report a Vulnerability](https://docs.base.org/base-chain/security/report-vulnerability.md) — Security contact and disclosure
6169
- [Security Council](https://docs.base.org/base-chain/security/security-council.md) — Governance and process overview
70+
- [Avoid Malicious Flags](https://docs.base.org/base-chain/security/avoid-malicious-flags.md) — How to avoid app-blocklist flags
6271

6372
## Builder Codes
6473
- [Builder Codes](https://docs.base.org/apps/builder-codes/builder-codes.md) — Overview of the Builder Codes program

0 commit comments

Comments
 (0)