Skip to content

docs: add supported networks section to README #2641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schoolkamsergj wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add supported networks section to README #2641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions packages/onchainkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,34 @@ Run `npm create onchain` to bootstrap an example onchain app with all the batter

For documentation and guides, visit [onchainkit.xyz](https://onchainkit.xyz/).

## 🌐 Supported Networks

OnchainKit is optimized for the **Base ecosystem** and officially supports:

| Network | Chain ID | Type |
|---|---|---|
| Base Mainnet | 8453 | Production |
| Base Sepolia | 84532 | Testnet |

While OnchainKit components work on any EVM-compatible chain, full feature support — including gasless transactions, Coinbase Smart Wallet, and paymaster integration — is only available on Base and Base Sepolia.

To configure your app for Base networks:

```ts
import { base, baseSepolia } from 'viem/chains';
import { OnchainKitProvider } from '@coinbase/onchainkit';

// Production (Base Mainnet)
<OnchainKitProvider chain={base} apiKey={process.env.PUBLIC_ONCHAINKIT_API_KEY}>
{children}
</OnchainKitProvider>

// Development (Base Sepolia testnet)
<OnchainKitProvider chain={baseSepolia} apiKey={process.env.PUBLIC_ONCHAINKIT_API_KEY}>
{children}
</OnchainKitProvider>
```

## 🛠️ Contributing

### Overview
Expand Down