History

KonradStaniec a20917a547 Add docker file for fluffy (#954 )		2022-02-07 09:03:19 +01:00
..
common	Allow access to contentDB from portal wire protocol (#920 )	2022-01-06 09:06:05 +01:00
docs	Some version of the findContent JSON-RPC proc (#918 )	2021-12-20 11:57:55 +01:00
network	Bump nim-ssz-serialization and clean-up fromSszBytes raises (#948 )	2022-01-31 21:57:34 +01:00
rpc	Improve the tests of the local testnet (#953 )	2022-02-02 22:48:33 +01:00
scripts	Improve the tests of the local testnet (#953 )	2022-02-02 22:48:33 +01:00
tests	Improve the tests of the local testnet (#953 )	2022-02-02 22:48:33 +01:00
tools	Add docker file for fluffy (#954 )	2022-02-07 09:03:19 +01:00
README.md	Add Portal protocol testing docs and more (#912 )	2021-12-13 14:12:51 +01:00
conf.nim	Add populate history db option to fluffy (#929 )	2022-01-18 15:08:02 +01:00
content_db.nim	Add a basic ContentDB for portal networks (#848 )	2021-09-28 19:58:41 +02:00
fluffy.nim	Improve the tests of the local testnet (#953 )	2022-02-02 22:48:33 +01:00
populate_db.nim	Add populate history db option to fluffy (#929 )	2022-01-18 15:08:02 +01: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 portal-network-specs repository.

Development Updates

To keep up to date with changes and development progress, follow the Nimbus blog.

Monthly development updates are shared here.

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 bootstrap node.
./build/fluffy --bootstrap-node: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

Run fluffy test suite

# From the nimbus-eth1 repository
make fluffy-test

Run fluffy local testnet

./fluffy/scripts/launch_local_testnet.sh

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.

Detailed document showing commands to test client protocol interoperability.

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.