Node implementation for 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.
- CPU: Equivalent of 8 AWS vCPU
- RAM: 16 GB
- Storage: 200 GB
- OS: Ubuntu 18.04/20.04 or macOS >= 10.15 (Catalina)
- Network: Reliable IPv4 or IPv6 network connection, with an open public port.
- Software Dependencies:
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.
Binary Repository
Install AvalancheGo using an apt repository.
Adding the APT Repository
If you have already added the APT repository, you do not need to add it again.
To add the repository on Ubuntu 18.04 (Bionic), run:
sudo su -
wget -O - https://downloads.avax.network/avalanchego.gpg.key | apt-key add -
echo "deb https://downloads.avax.network/apt bionic main" > /etc/apt/sources.list.d/avalanche.list
exit
To add the repository on Ubuntu 20.04 (Focal), run:
sudo su -
wget -O - https://downloads.avax.network/avalanchego.gpg.key | apt-key add -
echo "deb https://downloads.avax.network/apt focal main" > /etc/apt/sources.list.d/avalanche.list
exit
Installing the Latest Version
After adding the APT repository, install avalanchego by running:
sudo apt update
sudo apt install avalanchego
Binary Install
Download the latest build for your operating system and architecture.
The Avalanche binary to be executed is named avalanchego.
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.
Generating Code
Avalanchego uses multiple tools to generate efficient and 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 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/[email protected]
go install google.golang.org/grpc/cmd/[email protected]
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.
Running protobuf codegen from docker
docker build -t avalanche:protobuf_codegen -f Dockerfile.protoc .
docker run -t -i -v $(pwd):/opt/avalanche -w/opt/avalanche avalanche:protobuf_codegen bash -c "scripts/protobuf_codegen.sh"
Security Bugs
We and our community welcome responsible disclosures.
If you've discovered a security vulnerability, please report it via our bug bounty program. Valid reports will be eligible for a reward (terms and conditions apply).
