sbellem/avalanchego

Official node implementation of the Avalanche network - a blockchains platform with high throughput, and blazing fast transactions.

Installation

Avalanche 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

Native Install

Clone the AvalancheGo repository:

go get -v -d github.com/ava-labs/avalanchego/...
cd $GOPATH/src/github.com/ava-labs/avalanchego

Building the Avalanche Executable

Build Avalanche using the build script:

./scripts/build.sh

The Avalanche binary, named avalanchego, is in the build directory.

Docker Install

Make sure docker is installed on the machine - so commands like docker run etc. are available.

Building the docker image of latest avalanchego branch can be done by running:

./scripts/build_image.sh

To check the built image, run:

docker image ls

The image should be tagged as avaplatform/avalanchego:xxxxxxxx, where xxxxxxxx is the shortened commit of the Avalanche source it was built from. To run the avalanche node, run:

docker run -ti -p 9650:9650 -p 9651:9651 avaplatform/avalanchego:xxxxxxxx /avalanchego/build/avalanchego

Running Avalanche

Connecting to Mainnet

To connect to the Avalanche Mainnet, run:

./build/avalanchego

You should see some pretty ASCII art and log messages.

You can use Ctrl+C to kill the node.

Connecting to Fuji

To connect to the Fuji Testnet, run:

./build/avalanchego --network-id=fuji

Creating a Local Testnet

To create a single node testnet, run:

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

This launches an Avalanche 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 and protoc-gen-go installed. protoc must be on your $PATH.

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
scripts/protobuf_codegen.sh

sbellem / avalanchego