flare

Flare

Node implementation for the Flare network.

Installation

Flare uses a relatively lightweight consensus protocol, so the minimum computer requirements are modest. Note that as network usage increases, hardware requirements may change.

The minimum recommended hardware specification for nodes connected to Mainnet is:

• CPU: Equivalent of 8 AWS vCPU
• RAM: 16 GiB
• Storage: 512 GiB
• OS: Ubuntu 18.04/20.04 or macOS >= 10.15 (Catalina)
• Network: Reliable IPv4 or IPv6 network connection, with an open public port.

If you plan to build Flare from source, you will also need the following software:

• Go version >= 1.16.8
• gcc
• g++

Native Install

Clone the Flare repository:

git clone git@github.com:flare-foundation/flare.git
cd flare

This will clone and checkout to master branch.

Building the Flare Executable

Build Flare using the build script:

./scripts/build.sh

The Flare binary, named flare, is in the build directory.

Running Flare

Connecting to Songbird

To connect to the Coston test network, run:

./build/flare --network-id=coston \
  --bootstrap-ips="$(curl -m 10 -sX POST --data '{ "jsonrpc":"2.0", "id":1, "method":"info.getNodeIP" }' -H 'content-type:application/json;' https://coston.flare.network/ext/info | jq -r ".result.ip")" \
  --bootstrap-ids="$(curl -m 10 -sX POST --data '{ "jsonrpc":"2.0", "id":1, "method":"info.getNodeID" }' -H 'content-type:application/json;' https://coston.flare.network/ext/info | jq -r ".result.nodeID")"

You should see some fire ASCII art and log messages.

You can use Ctrl+C to kill the node.

Connecting to Songbird

To connect to the Songbird canary network, run:

./build/flare --network-id=songbird \
  --bootstrap-ips="$(curl -m 10 -sX POST --data '{ "jsonrpc":"2.0", "id":1, "method":"info.getNodeIP" }' -H 'content-type:application/json;' https://songbird.flare.network/ext/info | jq -r ".result.ip")" \
  --bootstrap-ids="$(curl -m 10 -sX POST --data '{ "jsonrpc":"2.0", "id":1, "method":"info.getNodeID" }' -H 'content-type:application/json;' https://songbird.flare.network/ext/info | jq -r ".result.nodeID")"

You should see some fire ASCII art and log messages.

You can use Ctrl+C to kill the node.

Please note that you currently need to be whitelisted to connect to the Songbird validators.

Pruning & APIs

The configuration for the chain is loaded from a configuration file, located at {chain-config-dir}/C/config.json:

{
  "snowman-api-enabled": false,
  "coreth-admin-api-enabled": false,
  "net-api-enabled": true,
  "eth-api-enabled": true,
  "personal-api-enabled": false,
  "tx-pool-api-enabled": true,
  "debug-api-enabled": true,
  "web3-api-enabled": true,
  "local-txs-enabled": true,
  "pruning-enabled": false
}

The directory for configuration files defaults to HOME/.flare/configs and can be changed using the --chain-config-dir flag.

In order to disable pruning and run a full archival node, pruning-enabled should be set to false.

The various node APIs can also be enabled and disabled by setting the respective parameters.

Launching Flare locally

In order to run a local network, the validator set needs to be defined locally. This can be done by setting the path to a validator set in a environment variable.

You can use ./scripts/launch_localnet.sh as an easy way to spin up a 5-node local network. All funds are controlled by the private key under /.scripts/keys/6b0dd034a2fd67b932f10e3dba1d2bbd39348695.json.

Generating Code

Flare uses multiple tools to generate boilerplate code.

Running protobuf codegen

To regenerate the protobuf go code, run scripts/protobuf_codegen.sh from the root of the repo.

This should only be necessary when upgrading protobuf versions or modifying .proto definition files.

To use this script, you must have buf (v1.0.0-rc12), protoc-gen-go (v1.27.1) and protoc-gen-go-grpc (v1.2.0) installed.

To install the buf dependencies:

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.27.1
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0

If you have not already, you may need to add $GOPATH/bin to your $PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

If you extract buf to ~/software/buf/bin, the following should work:

export PATH=$PATH:~/software/buf/bin/:~/go/bin
go get google.golang.org/protobuf/cmd/protoc-gen-go
go get google.golang.org/protobuf/cmd/protoc-gen-go-grpc
scripts/protobuf_codegen.sh

For more information, refer to the GRPC Golang Quick Start Guide. |

Security Bugs

We and our community welcome responsible disclosures.

If you've discovered a security vulnerability, please report it via our contact form. Valid reports will be eligible for a reward (terms and conditions apply).