avalanchego

module
v1.9.0-rc.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 21, 2022 License: BSD-3-Clause

README


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.

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

  • CPU: Equivalent of 8 AWS vCPU
  • RAM: 16 GiB
  • Storage: 1 TiB
  • 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 AvalancheGo from source, you will also need the following software:

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

Native Install

Clone the AvalancheGo repository:

git clone git@github.com:ava-labs/avalanchego.git
cd avalanchego

This will clone and checkout to master branch.

Building the Avalanche Executable

Build Avalanche by running the build script:

./scripts/build.sh

The output of the script will be the Avalanche binary named avalanchego. It is located in the build directory:

./build/avalanchego

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

See this tutorial.

Bootstrapping

A node needs to catch up to the latest network state before it can participate in consensus and serve API calls. This process, called bootstrapping, currently takes several days for a new node connected to Mainnet.

A node will not report healthy until it is done bootstrapping.

Improvements that reduce the amount of time it takes to bootstrap are under development.

The bottleneck during bootstrapping is typically database IO. Using a more powerful CPU or increasing the database IOPS on the computer running a node will decrease the amount of time bootstrapping takes.

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 buf (v1.7.0), protoc-gen-go (v1.28.0) 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.28.0
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.

Running protobuf codegen from docker

docker build -t avalanche:protobuf_codegen -f api/Dockerfile.buf .
docker run -t -i -v $(pwd):/opt/avalanche -w/opt/avalanche avalanche:protobuf_codegen bash -c "scripts/protobuf_codegen.sh"

Running mock codegen

Going forward, AvalancheGo will use gomock for mocking in unit tests.

Example usage:

mockgen -destination vms/platformvm/state/mock_diff.go -package state github.com/ava-labs/avalanchego/vms/platformvm/state Diff

This makes a mock implementation of the Diff interface from github.com/ava-labs/avalanchego/vms/platformvm/stateand puts it at vms/platformvm/state/mock_diff.go. The struct implementing the mock will be in the state package.

See gomock documentation for more information.

Supported Platforms

AvalancheGo can run on different platforms, with different support tiers:

  • Tier 1: Fully supported by the maintainers, guaranteed to pass all tests including e2e and stress tests.
  • Tier 2: Passes all unit and integration tests but not necessarily e2e tests.
  • Tier 3: Builds but lightly tested (or not), considered experimental.
  • Not supported: May not build and not tested, considered unsafe. To be supported in the future.

The following table lists currently supported platforms and their corresponding AvalancheGo support tiers:

Architecture Operating system Support tier
amd64 Linux 1
arm64 Linux 2
amd64 Darwin 2
amd64 Windows 3
arm Linux Not supported
i386 Linux Not supported
arm64 Darwin Not supported

To officially support a new platform, one must satisfy the following requirements:

AvalancheGo continuous integration Tier 1 Tier 2 Tier 3
Build passes
Unit and integration tests pass
End-to-end and stress tests pass

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).

Directories

Path Synopsis
api
server
Package server is a generated GoMock package.
Package server is a generated GoMock package.
app
atomic
Package atomic is a generated GoMock package.
Package atomic is a generated GoMock package.
Package database is a generated GoMock package.
Package database is a generated GoMock package.
ids
proto
consensus/snowman
Package snowman is a generated GoMock package.
Package snowman is a generated GoMock package.
engine/avalanche/state
Package state manages the meta-data required by consensus for an avalanche dag.
Package state manages the meta-data required by consensus for an avalanche dag.
engine/snowman/block/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
networking/tracker
Package tracker is a generated GoMock package.
Package tracker is a generated GoMock package.
e2e
e2e implements the e2e tests.
e2e implements the e2e tests.
e2e/blueberry
Implements tests for the blueberry network upgrade.
Implements tests for the blueberry network upgrade.
e2e/ping
Implements ping tests, requires network-runner cluster.
Implements ping tests, requires network-runner cluster.
e2e/static-handlers
Implements static handlers tests for avm and platformvm
Implements static handlers tests for avm and platformvm
e2e/whitelist-vtx
Implements X-Chain whitelist vtx (stop vertex) tests.
Implements X-Chain whitelist vtx (stop vertex) tests.
e2e/x/transfer
Implements X-chain transfer tests.
Implements X-chain transfer tests.
hashing
Package sharding is a generated GoMock package.
Package sharding is a generated GoMock package.
ips
logging
Package logging is a generated GoMock package.
Package logging is a generated GoMock package.
resource
Package resource is a generated GoMock package.
Package resource is a generated GoMock package.
rpc
vms
Package vms is a generated GoMock package.
Package vms is a generated GoMock package.
avm
components/avax
Package avax is a generated GoMock package.
Package avax is a generated GoMock package.
components/verify
Package verify is a generated GoMock package.
Package verify is a generated GoMock package.
platformvm/blocks
Package blocks is a generated GoMock package.
Package blocks is a generated GoMock package.
platformvm/fx
Package fx is a generated GoMock package.
Package fx is a generated GoMock package.
platformvm/state
Package state is a generated GoMock package.
Package state is a generated GoMock package.
platformvm/txs
Package txs is a generated GoMock package.
Package txs is a generated GoMock package.
platformvm/txs/builder
Package builder is a generated GoMock package.
Package builder is a generated GoMock package.
platformvm/txs/mempool
Package mempool is a generated GoMock package.
Package mempool is a generated GoMock package.
platformvm/utxo
Package utxo is a generated GoMock package.
Package utxo is a generated GoMock package.
proposervm/state
Package state is a generated GoMock package.
Package state is a generated GoMock package.
registry
Package registry is a generated GoMock package.
Package registry is a generated GoMock package.
rpcchainvm
Package rpcchainvm is a generated GoMock package.
Package rpcchainvm is a generated GoMock package.
wallet

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL