REI-Network

Nodejs implementation of REI-Network protocols

This project is under continuous development, all protocols and modules may be changed in the future, use it at your own risk

| package | npm | issues | | --------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------- | | [@rei-network/structure][structure-package] | [![NPM Version][structure-npm-version]][structure-npm-url] | [![Block Issues][structure-issues]][structure-issues-url] | | [@rei-network/blockchain][blockchain-package] | [![NPM Version][blockchain-npm-version]][blockchain-npm-url] | [![Blockchain Issues][blockchain-issues]][blockchain-issues-url] | | [@rei-network/cli][cli-package] | [![NPM Version][cli-npm-version]][cli-npm-url] | [![Cli Issues][cli-issues]][cli-issues-url] | | [@rei-network/contracts][contracts-package] | [![NPM Version][contracts-npm-version]][contracts-npm-url] | [![Contracts Issues][contracts-issues]][contracts-issues-url] | | [@rei-network/utils][utils-package] | [![NPM Version][utils-npm-version]][utils-npm-url] | [![Utils Issues][utils-issues]][utils-issues-url] | | [@rei-network/core][core-package] | [![NPM Version][core-npm-version]][core-npm-url] | [![Core Issues][core-issues]][core-issues-url] | | [@rei-network/common][common-package] | [![NPM Version][common-npm-version]][common-npm-url] | [![Common Issues][common-issues]][common-issues-url] | | [@rei-network/database][database-package] | [![NPM Version][database-npm-version]][database-npm-url] | [![Database Issues][database-issues]][database-issues-url] | | [@rei-network/network][network-package] | [![NPM Version][network-npm-version]][network-npm-url] | [![Network Issues][network-issues]][network-issues-url] | | [@rei-network/rpc][rpc-package] | [![NPM Version][rpc-npm-version]][rpc-npm-url] | [![Rpc Issues][rpc-issues]][rpc-issues-url] | | [@rei-network/wallet][wallet-package] | [![NPM Version][wallet-npm-version]][wallet-npm-url] | [![Wallet Issues][wallet-issues]][wallet-issues-url] | | [@rei-network/api][api-package] | [![NPM Version][api-npm-version]][api-npm-url] | [![Api Issues][api-issues]][api-issues-url] | | [@rei-network/ipc][ipc-package] | [![NPM Version][ipc-npm-version]][ipc-npm-url] | [![Ipc Issues][ipc-issues]][ipc-issues-url] |

Requirements

• node >= 16.0.0
• npm >= 7.0.0
• supported system:
  • MacOS 12+
  • Any Linux with glibc >= 2.28 and glibcxx >= 3.4.25

Quick start

Install

npm install @rei-network/cli --global

Usage

Usage: rei [options] [command]

Options:
  -V, --version                              output the version number
  --rpc                                      open rpc server
  --rpc-port <port>                          rpc server port
  --rpc-host <port>                          rpc server host
  --rpc-api <apis>                           rpc server apis: debug, eth, net, txpool, web3, rei
  --p2p-tcp-port <port>                      p2p server tcp port
  --p2p-udp-port <port>                      p2p server udp port
  --p2p-nat <ip>                             p2p server nat ip
  --max-peers <peers>                        max p2p peers count
  --max-dials <dials>                        max p2p dials count
  --bootnodes <bootnodes...>                 comma separated list of bootnodes
  --sync <sync>                              sync mode: full, snap (default: "full")
  --snap-trusted-height <trustedHeight>      snap sync trusted height.
                                             this value and trustedHash are specified at the same time to take effect.
                                             snap sync will start from the specified block to verify the legitimacy.
                                             e.g. 100
  --snap-trusted-hash <trustedHash>          snap sync trusted hash.
                                             this value and trustedHeight are specified at the same time to take effect.
                                             snap sync will start from the specified block to verify the legitimacy.
                                             e.g. 0x123...
  --snap-min-td <minTD>                      minimum total difficulty difference for snap sync
  --skip-verify-snap                         whether skip verifing snapshot
  --datadir <path>                           chain data dir path (default: "~/.rei")
  --keystore <keystore>                      the datadir for keystore (default: "keystore")
  --unlock <unlock>                          comma separated list of accounts to unlock
  --password <password>                      password file to use for non-interactive password input
  --chain <chain>                            chain name: rei-mainnet, rei-testnet, rei-devnet
  --mine                                     mine block
  --coinbase <address>                       miner address
  --verbosity <verbosity>                    logging verbosity: silent, error, warn, info, debug, detail (default: "info")
  --receipts-cache-size <receiptsCacheSize>  receipts cache size
  --evm <evm>                                evm implementation type, "js" or "binding"
  --bls <bls>                                the datadir for bls (default: "bls")
  --bls-password <blsPassword>               bls password file to use for non-interactive password input
  --bls-file <blsFile>                       bls file name
  -h, --help                                 display help for command

Commands:
  account                                    Manage accounts
  attach [ipcpath]                           Start an interactive JavaScript environment (connect to node)
  console                                    Start an interactive JavaScript environment
  bls                                        Manage bls signature key

Example

Block producer startup

rei --mine --coinbase 0x...abc --unlock 0x...abc --password ./password

Normal node startup

rei --rpc --rpc-host 0.0.0.0

Bootnode startup

rei --p2p-nat 1.2.3.4

Testnet node startup

rei --chain rei-testnet

Build

This monorepo uses npm workspaces. It links the local packages together, making development a lot easier.

Install:

npm install

Build:

npm run build -ws

Build docker

npm run build:docker -- -t tag .

ℹ️ Note for Windows users:

Windows users might run into the following error when trying to install the repo: '.' is not recognized as an internal or external command. To remediate for this, you can force Windows to use Git bash to run scripts (you'll need to install Git for Windows for this) with the following command:

npm config set script-shell "C:\\Program Files (x86)\\git\\bin\\bash.exe"

If you ever need to reset this change, you can do so with this command:

npm config delete script-shell

Project scripts — run from repository root

npm install (alias: npm i)

Adds dependencies listed in the root package.

npm run build -ws

Builds all monorepo packages.

To build a specific package, use npm run build -w @rei-network/contracts

npm run build:core, npm run build:contracts, ...

Only build single monorepo package.

npm run clean

Removes root and packages node_modules, dist directories, and other generated files.

npm run clean:build

Only remove dist directories for each monorepo packages.

npm run lint, npm run lint:fix

These scripts execute lint and lint:fix respectively, to all monorepo packages.

FAQ

• Q: Why do I get ModuleNotFoundError: No module named 'distutils' when I install @rei-network/cli?

  <details><summary> like this </summary>

  npm error gyp info spawn /usr/bin/python3
  npm error gyp info spawn args [
  npm error gyp info spawn args   '/app/node_modules/node-gyp/gyp/gyp_main.py',
  npm error gyp info spawn args   'binding.gyp',
  npm error gyp info spawn args   '-f',
  npm error gyp info spawn args   'make',
  npm error gyp info spawn args   '-I',
  npm error gyp info spawn args   '/app/node_modules/@chainsafe/blst/blst/bindings/node.js/build/config.gypi',
  npm error gyp info spawn args   '-I',
  npm error gyp info spawn args   '/app/node_modules/node-gyp/addon.gypi',
  npm error gyp info spawn args   '-I',
  npm error gyp info spawn args   '/root/.cache/node-gyp/22.16.0/include/node/common.gypi',
  npm error gyp info spawn args   '-Dlibrary=shared_library',
  npm error gyp info spawn args   '-Dvisibility=default',
  npm error gyp info spawn args   '-Dnode_root_dir=/root/.cache/node-gyp/22.16.0',
  npm error gyp info spawn args   '-Dnode_gyp_dir=/app/node_modules/node-gyp',
  npm error gyp info spawn args   '-Dnode_lib_file=/root/.cache/node-gyp/22.16.0/<(target_arch)/node.lib',
  npm error gyp info spawn args   '-Dmodule_root_dir=/app/node_modules/@chainsafe/blst/blst/bindings/node.js',
  npm error gyp info spawn args   '-Dnode_engine=v8',
  npm error gyp info spawn args   '--depth=.',
  npm error gyp info spawn args   '--no-parallel',
  npm error gyp info spawn args   '--generator-output',
  npm error gyp info spawn args   'build',
  npm error gyp in