History

Kim De Mey 0ba3c682e4 Use SSZ code from nim-ssz-serialization module (#875 )		2021-10-23 14:28:12 +02:00
..
common	Use SSZ code from nim-ssz-serialization module (#875 )	2021-10-23 14:28:12 +02:00
network	Use SSZ code from nim-ssz-serialization module (#875 )	2021-10-23 14:28:12 +02:00
rpc	Add rpc for local node info (#810 )	2021-08-27 18:04:55 +02:00
tests	Use SSZ code from nim-ssz-serialization module (#875 )	2021-10-23 14:28:12 +02:00
tools	Use ByteList.init instead of List 2048 (#876 )	2021-10-22 17:49:23 +02:00
README.md	Move tools and add common types (#846 )	2021-09-24 17:18:54 +02:00
conf.nim	Set config default descriptions (#852 )	2021-09-29 13:58:55 +02:00
content_db.nim	Add a basic ContentDB for portal networks (#848 )	2021-09-28 19:58:41 +02:00
fluffy.nim	Add HistoryNetwork that uses Portal wire protocol (#856 )	2021-10-09 13:22:03 +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 portal-network-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

Run fluffy test suite

# From the nimbus-eth1 repository
make fluffy-test

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.