History

jangko 9a1c8fc779 refactor genesis.nim		2022-03-03 08:28:00 +07:00
..
common	Add cli option to start fluffy with a netkey file (#974 )	2022-02-17 14:13:39 +01:00
docs	Update local_testnet.md (#976 )	2022-02-22 15:55:47 +01:00
network	Add basic validation of history network (#983 )	2022-03-02 15:29:12 +01:00
rpc	Add basic validation of history network (#983 )	2022-03-02 15:29:12 +01:00
scripts	Add block bodies to the propagation and lookups (#975 )	2022-02-22 11:52:44 +01:00
tests	refactor genesis.nim	2022-03-03 08:28:00 +07:00
tools	Sharing block header data around in a Portal history network (PoC) (#960 )	2022-02-11 14:43:10 +01:00
README.md	Sharing block header data around in a Portal history network (PoC) (#960 )	2022-02-11 14:43:10 +01:00
conf.nim	Add cli option to start fluffy with a netkey file (#974 )	2022-02-17 14:13:39 +01:00
content_db.nim	Add a basic ContentDB for portal networks (#848 )	2021-09-28 19:58:41 +02:00
fluffy.nim	Add cli option to start fluffy with a netkey file (#974 )	2022-02-17 14:13:39 +01:00
fluffy.nim.cfg	Fix runtime loglevel selection for Fluffy (#980 )	2022-02-24 22:50:59 +01:00
populate_db.nim	Add block bodies to the propagation and lookups (#975 )	2022-02-22 11:52:44 +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

Find more details on the usage and workings of the local testnet script here.

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.