Practical overview
When it fits
Use Neuron when a Nervos CKB workflow needs a desktop wallet together with local node operation and indexed cell or transaction data. Its documented development configuration is relevant when testing CKB applications against devnet.
Who it is for
- Nervos CKB users seeking a desktop wallet
- Developers building or testing Nervos CKB applications
- Teams evaluating a TypeScript-based CKB wallet implementation
Documented uses
- Manage a Nervos CKB wallet from a desktop application
- Run a local CKB node for Mainnet or development use
- Create cell and transaction indexes through CKB Indexer
- Prepare a wallet environment for CKB devnet development
- Build a customized CKB wallet from the separated UI and core wallet layers
Requirements & limits
Pre-built binaries are offered for Windows, Linux and macOS. Building from source requires Node.js 18.12.0 or newer, Yarn 1.14 or newer and Lerna.
- Neuron can bundle and start a CKB binary for Mainnet, while the README also documents using a separately operated local node.
- CKB Indexer must be downloaded separately and placed in the platform-specific wallet binary directory for source setup.
- The repository separates the React UI layer from the core wallet layer, which is relevant to developers considering customization.
- The project is released under the MIT license and is publicly available on GitHub.
- Devnet configuration is explicitly documented through the wallet environment file.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up Neuron from source for development
Install the documented dependencies, add CKB Indexer and start Neuron in development mode.
Before you start
- Node.js 18.12.0 or newer
- Yarn 1.14 or newer
- Lerna installed globally
- A CKB Indexer binary placed in packages/neuron-wallet/bin/{win/linux/mac}/
Steps
Install Lerna globally with yarn global add lerna.
Install and link project dependencies with yarn, then run lerna run rebuild:nativemodules.
Download the CKB binary for the platform with ./scripts/download-ckb.sh.
Start Neuron with yarn start, or start the UI and wallet layers independently with yarn start:ui and yarn start:wallet.
Expected outcome
The React UI layer and core wallet layer start in development mode with the downloaded CKB binary available to Neuron.
Guide limitations
- The source instructions mention proxy and CDN configuration for stalled or slow downloads.
- The guide documents development startup, not a completed wallet transaction or deployment.
- The Windows CKB node may require the Microsoft Visual C++ Redistributable if it fails to start.
Configure Neuron for CKB devnet development
Change the documented network script configuration so the wallet development environment uses devnet.
Before you start
- A source checkout of Neuron
- The packages/neuron-wallet/.env file
- The project development environment
Steps
Open packages/neuron-wallet/.env.
Replace the testnet script with the dev script as described in the project README.
Start the development environment using the documented Neuron development commands.
Expected outcome
The wallet development environment is configured for CKB devnet operation.
Guide limitations
- The source documents the configuration change but does not provide a complete devnet application workflow.
- The guide does not establish transaction success or compatibility with a particular application.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 3 October 2026
- Original website title
- nervosnetwork/neuron · Official homepage title · retained in its source language