flare

README

Flare

Node implementation for the Flare network.

Installation

Flare is an incredibly lightweight protocol, so the minimum computer requirements are quite modest. Note that as network usage increases, hardware requirements may change.

• Hardware: 2 GHz or faster CPU, 6 GB RAM, >= 200 GB storage.
• OS: Ubuntu >= 18.04 or Mac OS X >= Catalina.
• Network: IPv4 or IPv6 network connection, with an open public port.
• Software Dependencies:
  • Go version >= 1.15.5 and set up $GOPATH.
  • gcc
  • g++

Native Install

Clone the Flare repository:

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

Building the Flare Executable

Build Flare using the build script:

./scripts/build.sh

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

Binary Install

Download the latest build for your operating system and architecture.

The Flare binary to be executed is named flare.

Running Flare

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 pretty ASCII art and log messages.

You can use Ctrl+C to kill the node.

Creating a local test network

To create a single node testnet, run:

./build/flare --network-id=local \
  --staking-enabled=false \
  --snow-sample-size=1 \
  --snow-quorum-size=1

This launches a Flare network with one node.

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 protoc (v3.17.3), protoc-gen-go (v1.26.0) and protoc-gen-go-grpc (v1.1.0) installed. protoc must be on your $PATH.

To install the protoc dependencies:

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.26
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.1

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 protoc to ~/software/protobuf/, the following should work:

export PATH=$PATH:~/software/protobuf/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 vulnerabilitiy, please report it via our contarct form. Valid reports will be eligible for a reward (terms and conditions apply).