4ce9b5883c
* Bump nim-json-rpc module * Add eth json rpc stubs * Add portal content file |
||
|---|---|---|
| .. | ||
| rpc | ||
| README.md | ||
| conf.nim | ||
| content.nim | ||
| nlpn.nim | ||
README.md
Nimbus Light Portal Network Client
Introduction
This folder holds the development of the Nimbus client implementation supporting the Portal Network. The Portal Network is a project still heavily in research phase and fully in flux. This client is thus still highly experimental.
Current status of specifications can be found in the stateless-ethereum-specs repository.
Development Updates
To keep up to date with changes and development progress, follow the Nimbus blog.
How to Build & Run
Prerequisites
- GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
Build nlpn client
git clone git@github.com:status-im/nimbus-eth1.git
cd nimbus-eth1
make nlpn
# See available command line options
./build/nlpn --help
# Example command: Run the client and connect to a bootnode.
./build/nlpn --log-level:debug --bootnode:enr:<base64 encoding of ENR>
Update and rebuild nlpn client
# From the nimbus-eth1 repository
git pull
# To bring the git submodules up to date
make update
make nlpn
Windows support
Follow the steps outlined here to build nlpn on Windows.
For Developers
When working on this repository, you can run the env.sh script to run a
command with the right environment variables set. This means the vendored
Nim and Nim modules will be used, just as when you use make.
E.g.:
# start a new interactive shell with the right env vars set
./env.sh bash
More development tips can be found on the general nimbus-eth1 readme.
The code follows the Status Nim Style Guide.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (LICENSE-APACHEv2 or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.