avalanchego-1.7.3

module
v0.0.0-...-7be9c83 Latest Latest
Warning

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

Go to latest
Published: Jan 30, 2022 License: BSD-3-Clause

README


Node implementation for the Dijets network - a blockchains platform with high throughput, and blazing fast transactions.

Installation

Dijets 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 DijetsNetGo repository:

git clone git@github.com:lasthyphen/dijetsnetgo.git
cd dijetsnetgo

This will clone and checkout to master branch.

Building the Dijets Executable

Build Dijets using the build script:

./scripts/build.sh

The Dijets binary, named dijetsnetgo, is in the build directory.

Binary Repository

Install DijetsGo 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.djtx.network/dijetsnetgo.gpg.key | apt-key add -
echo "deb https://downloads.djtx.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.djtx.network/dijetsnetgo.gpg.key | apt-key add -
echo "deb https://downloads.djtx.network/apt focal main" > /etc/apt/sources.list.d/avalanche.list
exit
Installing the Latest Version

After adding the APT repository, install dijetsnetgo by running:

sudo apt update
sudo apt install dijetsnetgo

Binary Install

Download the latest build for your operating system and architecture.

The Dijets binary to be executed is named dijetsnetgo.

Docker Install

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

Building the docker image of latest dijetsnetgo 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/dijetsnetgo:xxxxxxxx, where xxxxxxxx is the shortened commit of the Dijets source it was built from. To run the avalanche node, run:

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

Running Dijets

Connecting to Mainnet

To connect to the Dijets Mainnet, run:

./build/dijetsnetgo

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/dijetsnetgo --network-id=fuji

Creating a Local Testnet

To create a single node testnet, run:

./build/dijetsnetgo --network-id=mainnet --staking-enabled=false --snow-sample-size=1 --snow-quorum-size=1

This launches an Dijets network with one node.

Generating Code

DijetsNetGo 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/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.

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"

Supported Platforms

DijetsNetGo 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 DijetsNetGo 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:

DijetsNetGo 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
app
rocksdb
^ Only build this file if this computer is not Linux OR it's not AMD64 OR rocksdb is not allowed Copyright (C) 2019-2021, Ava Labs, Inc.
^ Only build this file if this computer is not Linux OR it's not AMD64 OR rocksdb is not allowed Copyright (C) 2019-2021, Ava Labs, Inc.
ids
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.
rpc
vms
avm
evm

Jump to

Keyboard shortcuts

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