Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.24 KB

README.md

File metadata and controls

76 lines (50 loc) · 2.24 KB
Raw

AvalancheGo

Avalanche

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.

  • Hardware: 2 GHz or faster CPU, 4 GB RAM, 2 GB hard disk.
  • OS: Ubuntu >= 18.04 or Mac OS X >= Catalina.
  • Software: Go version >= 1.15.5 and set up $GOPATH.
  • Network: IPv4 or IPv6 network connection, with an open public port.

Native Install

Clone the AvalancheGo repository:

go get -v -d github.com/corpetty/avalanchego/...
cd $GOPATH/src/github.com/corpetty/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 you have docker installed on your machine (so commands like docker run etc. are available).
  • Build the docker image of latest avalanchego branch by ./scripts/build_image.sh.
  • Check the built image by docker image ls, you should see some image tagged avalanchego-xxxxxxxx, where xxxxxxxx is the commit id of the Avalanche source it was built from.
  • Test Avalanche by docker run -ti -p 9650:9650 -p 9651:9651 avalanchego-xxxxxxxx /avalanchego/build/avalanchego --network-id=local --staking-enabled=false --snow-sample-size=1 --snow-quorum-size=1. (For a production deployment, you may want to extend the docker image with required credentials for staking and TLS.)

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.