Go to file

StephenButtolph a7ea45ccef version constants		2020-05-25 23:09:31 -04:00
.ci	removed obsolete before_install_osx.sh	2020-05-23 12:46:11 -05:00
.github	build: Add ansible-lint exceptions for pre-existing lint	2020-04-30 21:54:09 +01:00
api	merged	2020-05-23 17:19:16 -04:00
cache	init repo	2020-03-10 15:20:34 -04:00
chains	Switched to a pure go networking stack	2020-05-17 23:47:43 -04:00
database	fixed iterator error message to report the correct function	2020-05-05 14:06:30 -04:00
genesis	Move Geth to a plugin connected at runtime	2020-04-16 11:39:20 -04:00
ids	testcase fix	2020-04-24 21:15:31 -07:00
main	added listAddresses API to the AVM	2020-05-25 22:29:36 -04:00
nat	Move Geth to a plugin connected at runtime	2020-04-16 11:39:20 -04:00
network	Added numPeers metric setting	2020-05-25 16:11:50 -04:00
node	added listAddresses API to the AVM	2020-05-25 22:29:36 -04:00
scripts	bumped timeout to 60s to support virtualized tests	2020-05-25 22:45:02 -04:00
snow	minor code cleanup	2020-05-25 22:18:43 -04:00
staking	generate staking key at ~/.gecko/staking/staker.key if no key given.	2020-05-07 14:34:32 -04:00
utils	Switched to a pure go networking stack	2020-05-17 23:47:43 -04:00
version	version constants	2020-05-25 23:09:31 -04:00
vms	added listAddresses API to the AVM	2020-05-25 22:29:36 -04:00
xputtest	removed xputtests to get the build to pass	2020-05-18 14:57:31 -04:00
.codecov.yml	init repo	2020-03-10 15:20:34 -04:00
.editorconfig	Standardise newline and trailing whitespace conventions	2020-05-11 20:31:59 +01:00
.gitignore	Move Geth to a plugin connected at runtime	2020-04-16 11:39:20 -04:00
.travis.yml	re-enable full build	2020-05-18 14:58:29 -05:00
Dockerfile	Removed C dependencies from the dockerfile	2020-05-23 17:28:16 -04:00
LICENSE	init repo	2020-03-10 15:20:34 -04:00
README.md	Removed warning	2020-04-17 03:04:35 -04:00

README.md

gecko

Installation

AVA is an incredibly lightweight protocol, so the minimum computer requirements are quite modest.

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

Native Install

Ubuntu users need the following libraries:

libssl-dev
libuv1-dev
cmake
make
curl
g++

Install the libraries:

sudo apt-get install libssl-dev libuv1-dev cmake make curl g++

Downloading Gecko Source Code

Clone the Gecko repository:

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

Building the Gecko Executable

Build Gecko using the build script:

./scripts/build.sh

The Gecko binary, named ava, 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 gecko branch by scripts/build_image.sh.
Check the built image by docker image ls, you should see some image tagged gecko-xxxxxxxx, where xxxxxxxx is the commit id of the Gecko source it was built from.
Test Gecko by docker run -ti -p 9650:9650 -p 9651:9651 gecko-xxxxxxxx /gecko/build/ava --public-ip=127.0.0.1 --snow-sample-size=1 --snow-quorum-size=1 --staking-tls-enabled=false. (For a production deployment, you may want to extend the docker image with required credentials for staking and TLS.)

Running Gecko and Creating a Local Test Network

To create your own local test network, run:

./build/ava --public-ip=127.0.0.1 --snow-sample-size=1 --snow-quorum-size=1 --staking-tls-enabled=false

This launches an AVA network with one node.

You should see some pretty ASCII art and log messages. You may see a few warnings. These are OK.

You can use Ctrl + C to kill the node.

If you want to specify your log level. You should set --log-level to one of the following values, in decreasing order of logging.

--log-level=verbo
--log-level=debug
--log-level=info
--log-level=warn
--log-level=error
--log-level=fatal
--log-level=off