Warning
OnchainKit and the packages in this repository are deprecated and no longer maintained. They will not receive further updates, bug fixes, or security patches. Do not use them for new projects. For wallet connectivity and Ethereum interactions, consider building directly with wagmi and viem.
Run npm create onchain to bootstrap an example onchain app with all the batteries included.
For documentation and guides, visit onchainkit.xyz.
This project is set up as a monorepo with pnpm workspaces.
- Node.js v20
- pnpm v10
- Clone the repository
git clone https://github.com/coinbase/onchainkit.git- Install dependencies
pnpm installTo run a script in a single package, use the following command:
pnpm [-F | --filter] <package-name> <script-name>To run a script in all packages, use the following command:
pnpm run <script-name>We provide shorthands to filter by project in the root package.json.
The following shorthands are available:
pnpm f:ock:pnpm --filter @coinbase/onchainkitpnpm f:play:pnpm --filter playgroundpnpm f:create:pnpm --filter create-onchainpnpm f:manifest:pnpm --filter miniapp-manifest-generator
When working on components, you can build OnchainKit in watch mode and start the playground to view your components with the following command:
pnpm f:play dev:watchThen, you can view the playground at http://localhost:3000.
- OnchainKit (X, Warpcast)
- Tina He (X)
- Mind Apivessa (X)
- Alissa Crane (X)
- Alec Chen (X)
- Paul Cramer (X)
- Shelley Lai (X, Warpcast)
- Léo Galley (X)
- Adam Lessey (X)
This project is licensed under the MIT License - see the LICENSE.md file for details