184 lines
6.9 KiB
Markdown
184 lines
6.9 KiB
Markdown
# Fluffy: The Nimbus Portal Network Client
|
|
|
|
[](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml)
|
|
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
[](https://discord.gg/XRxWahP)
|
|
[](https://join.status.im/nimbus-general)
|
|
|
|
## 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](https://github.com/ethereum/portal-network-specs/blob/master/portal-network.md).
|
|
|
|
|
|
## Development Updates
|
|
|
|
Monthly development updates are shared
|
|
[here](https://hackmd.io/jRpxY4WBQJ-hnsKaPDYqTw).
|
|
|
|
To keep up to date with changes and development progress, follow the
|
|
[Nimbus blog](https://our.status.im/tag/nimbus/).
|
|
|
|
## How to Build & Run
|
|
|
|
### Prerequisites
|
|
- GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer.
|
|
|
|
### Build the Fluffy client
|
|
```bash
|
|
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 the Fluffy client
|
|
```bash
|
|
# From the nimbus-eth1 repository
|
|
git pull
|
|
# To bring the git submodules up to date
|
|
make update
|
|
|
|
make fluffy
|
|
```
|
|
|
|
### Run a Fluffy client on the public testnet
|
|
|
|
```bash
|
|
# Connect to the Portal testnet bootstrap nodes and enable the JSON-RPC APIs
|
|
./build/fluffy --rpc --table-ip-limit:1024 --bucket-ip-limit:24
|
|
```
|
|
|
|
The `table-ip-limit` and `bucket-ip-limit` options are needed to allow more
|
|
nodes with the same IPs in the routing tables. The default limits are there
|
|
as security measure. It is currently needed to increase the limits for the testnet
|
|
because the fleet of Fluffy nodes runs on only 2 machines / network interfaces.
|
|
|
|
There is a public [Portal testnet](https://github.com/ethereum/portal-network-specs/blob/master/testnet.md#portal-network-testnet)
|
|
which contains nodes of different clients.
|
|
|
|
Fluffy will default join the network through these bootstrap nodes.
|
|
You can also explicitly provide the `--network:testnet0` option to join this
|
|
network, or `--network:none` to not connect to any of these bootstrapn odes.
|
|
|
|
> **_Note:_** The `--network` option selects automatically a static set of
|
|
specific bootstrap nodes belonging to a "testnet". Currently `testnet0` is the
|
|
only option, which results in connecting to the
|
|
[testnet bootstrap nodes](https://github.com/ethereum/portal-network-specs/blob/master/testnet.md#bootnodes).
|
|
It should be noted that there is currently no real way to distinguish a "specific" Portal
|
|
network, and as long as the same Portal protocols are supported, nodes can
|
|
simply connect to it and no real separation can be made.
|
|
|
|
<!-- TODO: Update this once we have the headersWithProof type merged and data on the network -->
|
|
|
|
The testnet is currently storing only the first 25000 mainnet blocks. This can
|
|
be tested by using the JSON-RPC call `eth_getBlockByHash`:
|
|
```
|
|
# Get the hash of a block from your favorite block explorer, e.g.:
|
|
# 0x8dda3a641653c0454569c3b5be529f58b14d2a5b5d87956664c746ce1e367c21
|
|
# Run command to get this block:
|
|
curl -s -X POST -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0","id":"1","method":"eth_getBlockByHash","params":["0x8dda3a641653c0454569c3b5be529f58b14d2a5b5d87956664c746ce1e367c21", false]}' http://localhost:8545 | jq
|
|
```
|
|
|
|
One can also use the `blockwalk` tool to walk down the blocks one by one, e.g:
|
|
```bash
|
|
make fluffy-tools
|
|
|
|
./build/blockwalk --block-hash:0xf6bfad56d1a45d1661506343dd1e511b5d7e17565b3ec293125ff0890b9709e5
|
|
```
|
|
|
|
### Run Fluffy test suite
|
|
```bash
|
|
# From the nimbus-eth1 repository
|
|
make fluffy-test
|
|
```
|
|
|
|
### Run Fluffy local testnet script
|
|
```bash
|
|
./fluffy/scripts/launch_local_testnet.sh
|
|
```
|
|
|
|
Find more details on the usage and workings of the local testnet script
|
|
[here](./docs/local_testnet.md).
|
|
|
|
### Windows support
|
|
|
|
Follow the steps outlined [here](../README.md#windows) to build fluffy on Windows.
|
|
|
|
|
|
## Development tools and documentation
|
|
|
|
- [Content seeding](./docs/content_seeding.md): Documentation on how to retrieve & generate history data and how to seed it into the network
|
|
- [Manual protocol interop testing](./docs/protocol_interop.md): commands on how to manually test the discv5 and Portal protocol request and responses
|
|
- [Local testnet script](./docs/local_testnet.md): Documentation on the local testnet script and how to use it
|
|
|
|
|
|
## The basics 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.:
|
|
|
|
```bash
|
|
# start a new interactive shell with the right env vars set
|
|
./env.sh bash
|
|
```
|
|
|
|
More [development tips](../README.md#devel-tips)
|
|
can be found on the general nimbus-eth1 readme.
|
|
|
|
The code follows the
|
|
[Status Nim Style Guide](https://status-im.github.io/nim-style-guide/).
|
|
|
|
|
|
## Metrics and their visualisation
|
|
|
|
To enable metrics run Fluffy with the `--metrics` flag:
|
|
```bash
|
|
./build/fluffy --metrics
|
|
```
|
|
Default the metrics are available at http://127.0.0.1:8008/metrics.
|
|
|
|
The address can be changed with the `--metrics-address` and `--metrics-port` options.
|
|
|
|
This provides only a snapshot of the current metrics. In order track the metrics over
|
|
time and to also visualise them one can use for example Prometheus and Grafana.
|
|
|
|
The steps on how to set up such system is explained in [this guide](https://nimbus.guide/metrics-pretty-pictures.html#prometheus-and-grafana).
|
|
|
|
A Fluffy specific dashboard can be found [here](./grafana/fluffy_grafana_dashboard.json).
|
|
|
|
This is the dashboard used for our Fluffy testnet fleet.
|
|
In order to use it locally, you will have to remove the
|
|
`{job="nimbus-fluffy-metrics"}` part from the `instance` and `container`
|
|
variables queries in the dashboard settings. Or they can also be changed to a
|
|
constant value.
|
|
|
|
The other option would be to remove those variables and remove their usage in
|
|
each panel query.
|
|
|
|
## License
|
|
|
|
Licensed and distributed under either of
|
|
|
|
* MIT license: [LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT
|
|
|
|
or
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHEv2](../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.
|