Skip to content

docs: add supported chains documentation to README #2588

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
devacc8 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add supported chains documentation to README #2588

Show file tree
Hide file tree
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
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,37 @@

<br />

## ⛓️ Supported Chains

OnchainKit is designed to work with **Base** and other EVM-compatible networks. Here's what you need to know:

### Full Support
| Chain | Chain ID | Features |
|-------|----------|----------|
| **Base** (mainnet) | 8453 | All features including Paymaster, CDP APIs, EAS attestations |
| **Base Sepolia** (testnet) | 84532 | All features for testing |

### Partial Support
| Chain | Features Available | Limitations |
|-------|-------------------|-------------|
| **Ethereum** | Identity, Wallet, Transaction components | No Paymaster support |
| **Optimism** | Identity (EAS attestations), Wallet | Limited CDP API support |
| **Other EVM chains** | Basic Wallet and Transaction components | No Paymaster, limited API features |

### Feature Availability by Chain

| Feature | Base | Base Sepolia | Ethereum | Other EVM |
|---------|------|--------------|----------|-----------|
| Wallet components | ✅ | ✅ | ✅ | ✅ |
| Transaction components | ✅ | ✅ | ✅ | ✅ |
| Paymaster (gas sponsorship) | ✅ | ✅ | ❌ | ❌ |
| CDP Node RPC | ✅ | ✅ | ✅ | ❌ |
| Swap API | ✅ | ✅ | ❌ | ❌ |
| EAS Attestations | ✅ | ✅ | ❌ | ❌ |
| Identity (ENS/Basenames) | ✅ | ✅ | ✅ | ❌ |

> **Note:** OnchainKit uses [viem](https://viem.sh/) under the hood. You can pass any chain from `viem/chains` to the configuration, but some features are optimized for Base.

## 🚀 Quickstart

Run `npm create onchain` to bootstrap an example onchain app with all the batteries included.
Expand Down
31 changes: 31 additions & 0 deletions packages/onchainkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,37 @@

<br />

## ⛓️ Supported Chains

OnchainKit is designed to work with **Base** and other EVM-compatible networks. Here's what you need to know:

### Full Support
| Chain | Chain ID | Features |
|-------|----------|----------|
| **Base** (mainnet) | 8453 | All features including Paymaster, CDP APIs, EAS attestations |
| **Base Sepolia** (testnet) | 84532 | All features for testing |

### Partial Support
| Chain | Features Available | Limitations |
|-------|-------------------|-------------|
| **Ethereum** | Identity, Wallet, Transaction components | No Paymaster support |
| **Optimism** | Identity (EAS attestations), Wallet | Limited CDP API support |
| **Other EVM chains** | Basic Wallet and Transaction components | No Paymaster, limited API features |

### Feature Availability by Chain

| Feature | Base | Base Sepolia | Ethereum | Other EVM |
|---------|------|--------------|----------|-----------|
| Wallet components | ✅ | ✅ | ✅ | ✅ |
| Transaction components | ✅ | ✅ | ✅ | ✅ |
| Paymaster (gas sponsorship) | ✅ | ✅ | ❌ | ❌ |
| CDP Node RPC | ✅ | ✅ | ✅ | ❌ |
| Swap API | ✅ | ✅ | ❌ | ❌ |
| EAS Attestations | ✅ | ✅ | ❌ | ❌ |
| Identity (ENS/Basenames) | ✅ | ✅ | ✅ | ❌ |

> **Note:** OnchainKit uses [viem](https://viem.sh/) under the hood. You can pass any chain from `viem/chains` to the configuration, but some features are optimized for Base.

## 🚀 Quickstart

Run `npm create onchain` to bootstrap an example onchain app with all the batteries included.
Expand Down