poanetwork
/
gecko
mirror of https://github.com/poanetwork/gecko.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
202 Commits 8 Branches 6 Tags 16 MiB
Go 99.7%
Shell 0.2%
Go to file
StephenButtolph a26f76de91 Allow fees to be paid with the imported balance in the ImportTx 2020-04-01 12:53:33 -04:00
.ci init repo 2020-03-10 15:20:34 -04:00
.github/ISSUE_TEMPLATE Update issue templates 2020-03-11 00:22:40 -04:00
api fix spelling typo 2020-03-18 07:53:25 +13:00
cache init repo 2020-03-10 15:20:34 -04:00
chains merged 2020-03-30 22:06:29 -04:00
database Added CommitBatch to the versionDB 2020-03-19 14:35:17 -04:00
genesis Added testnet defaults 2020-03-31 18:32:10 -04:00
ids Removed redundent filter in unaryNode and added test for filtering in binaryNode 2020-03-17 23:29:38 -04:00
keys removed old keys 2020-03-31 20:51:55 -04:00
main removed old keys 2020-03-31 20:51:55 -04:00
networking Perf (#13) 2020-03-13 17:31:23 -04:00
node Added sanity check to the database on startup 2020-03-31 18:56:05 -04:00
scripts Finished adding snowball tests 2020-04-01 02:19:43 -04:00
snow Finished adding snowball tests 2020-04-01 02:19:43 -04:00
utils merged 2020-03-30 21:16:32 -04:00
vms Allow fees to be paid with the imported balance in the ImportTx 2020-04-01 12:53:33 -04:00
xputtest Set up genesis for public testnet 2020-03-31 02:54:12 -04:00
.codecov.yml init repo 2020-03-10 15:20:34 -04:00
.gitignore removed old keys 2020-03-31 20:51:55 -04:00
.travis.yml remove ssh flag from public repo 2020-03-11 13:57:11 -04:00
Dockerfile init repo 2020-03-10 15:20:34 -04:00
LICENSE init repo 2020-03-10 15:20:34 -04:00
README.md Fixing docker container example command 2020-03-26 16:02:30 -07: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:

cd $GOPATH
mkdir -p src/github.com/ava-labs
cd src/github.com/ava-labs
git clone https://github.com/ava-labs/gecko.git
cd 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