Neuron

Nervos CKB Full-Node Desktop Wallet

Quick Start

Prerequisites

You will need node >= 18.12.0 and yarn >= 1.14 to build and run Neuron.

Lerna

This project uses lerna for package management.

$ yarn global add lerna # install lerna globally

Install Dependencies

Notes:

Please set proxy if you are using a proxy locally and find the downloading is halted

Please set CDN if the downloading is slow

After lerna has been installed, run this to install and link dependencies:

$ yarn
$ lerna run rebuild:nativemodules

Add CKB Indexer

CKB Indexer is a service to create cell and transaction indexes.

Download CKB Indexer and move the binary into packages/neuron-wallet/bin/{win/linux/mac}/.

Start Neuron

As of v0.26.0, Neuron bundles a CKB binary and starts it for Mainnet automatically. If you prefer to run a local CKB node yourself instead, please follow the Nervos CKB doc to get it up and running before launching Neuron.

Note: If you run CKB node on Windows but it fails to start, you may need to download and install the latest Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019.

Start Neuron in Development Mode

$ ./scripts/download-ckb.sh # Download CKB binary for your platform. Neuron will starts it automatically.
$ yarn start

This command starts neuron-ui, the React UI layer and neuron-wallet, the core wallet layer.

You can also start them independently:

# start neuron-ui at `http://localhost:3000`
$ yarn start:ui

# start neuron-wallet
$ yarn start:wallet

If you want to develop with devnet, replace the testnet script with the dev script in the packages/neuron-wallet/.env file.

Here is a script env example, it is constructed by network、script name and filed name.

TESTNET_SUDT_DEP_TXHASH=0xe12877ebd2c3c364dc46c5c992bcfaf4fee33fa13eebdf82c591fc9825aab769
TESTNET_SUDT_DEP_INDEX=0
TESTNET_SUDT_DEP_TYPE=code
TESTNET_SUDT_SCRIPT_CODEHASH=0xc5e5dcf215925f7ef4dfaf5f4b4f105bc321c02776d6e7d52a1db3fcd9d011a4
TESTNET_SUDT_SCRIPT_HASHTYPE=type

Test

$ yarn test

Download Neuron Binary

If you don't want to bother building from source, you can download a binary from releases. We offer pre-built binaries for Windows, Linux and macOS.

License

Neuron is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

nervosnetwork/neuron