History

Kim De Mey 7a42d037f2 Disable the custom distance functions for Portal Protocol (#832 ) The Portal Network tests fail with the custom functions, on one part due to the fact that the portal tests still uses the xor functions, but also because the `neighboursAtDistances` call appears to filter them out. The reverse calculation might be off.		2021-09-20 12:55:03 +02:00
..
network	Disable the custom distance functions for Portal Protocol (#832 )	2021-09-20 12:55:03 +02:00
rpc	Add rpc for local node info (#810 )	2021-08-27 18:04:55 +02:00
tests	config: fix new config based on input from jamie and zahary	2021-09-18 17:34:51 +07:00
README.md	Add monthly development updates link (#776 )	2021-08-09 16:10:58 +02:00
conf.nim	Use websockets in proxy (#779 )	2021-08-05 08:14:25 +02:00
fluffy.nim	Generalize network layer for portal (#814 )	2021-09-03 10:57:19 +02:00

README.md

Fluffy: The Nimbus Portal Network Client

Introduction

This folder holds the development of the Nimbus client implementation supporting the Portal Network: fluffy. 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 fluffy client

git clone git@github.com:status-im/nimbus-eth1.git
cd nimbus-eth1
make fluffy

# See available command line options
./build/fluffy --help

# Example command: Run the client and connect to a bootnode.
./build/fluffy --log-level:debug --bootnode:enr:<base64 encoding of ENR>

Update and rebuild fluffy client

# From the nimbus-eth1 repository
git pull
# To bring the git submodules up to date
make update

make fluffy

Windows support

Follow the steps outlined here to build fluffy 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

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.