abcd

abcd is a Aero full node implementation written in Go (golang).

This acts as a chain daemon for the Aero cryptocurrency. abcd maintains the entire past transactional ledger of Aero and allows relaying of transactions to other Aero nodes across the world. To read more about Aero please see the project documentation.

Note: To send or receive funds and join Proof-of-Stake mining, you will also need Abcwallet.

This project is currently under active development and is in a Beta state. It is extremely stable and has been in production use since February 2016.

It is forked from btcd which is a bitcoin full node implementation written in Go. btcd is a ongoing project under active development. Because abcd is constantly synced with btcd codebase, it will get the benefit of btcd's ongoing upgrades to peer and connection handling, database optimization and other blockchain related technology improvements.

Requirements

Go 1.7 or newer.

Getting Started

• abcd (and utilities) will now be installed in either $GOROOT/bin or $GOPATH/bin depending on your configuration. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.

Updating

Windows

Install a newer MSI

Linux/BSD/MacOSX/POSIX - Build from Source

• Glide

  Glide is used to manage project dependencies and provide reproducible builds. To install:

  go get -u github.com/Masterminds/glide

Unfortunately, the use of glide prevents a handy tool such as go get from automatically downloading, building, and installing the source in a single command. Instead, the latest project and dependency sources must be first obtained manually with git and glide, and then go is used to build and install the project.

Getting the source:

For a first time installation, the project and dependency sources can be obtained manually with git and glide (create directories as needed):

git clone https://github.com/abcsuite/abcd $GOPATH/src/github.com/abcsuite/abcd
cd $GOPATH/src/github.com/abcsuite/abcd
glide install
go install $(glide nv)

To update an existing source tree, pull the latest changes and install the matching dependencies:

cd $GOPATH/src/github.com/abcsuite/abcd
git pull
glide install
go install $(glide nv)

For more information about abcd and how to set up your software please go to our docs page at docs.abcd.org.

Docker

All tests and linters may be run in a docker container using the script run_tests.sh. This script defaults to using the current supported version of go. You can run it with the major version of go you would like to use as the only arguement to test a previous on a previous version of go (generally abcd supports the current version of go and the previous one).

./run_tests.sh 1.7

To run the tests locally without docker:

./run_tests.sh local

Updating docker go versions

When a new minor version of go is released, the docker images must be updated and rebuilt to support it. For example, when go1.8.3 was released, the file Dockerfile-1.8 was edited by changing FROM golang:1.8.2 to FROM golang:1.8.3. Then the image was rebuilt and pushed to docker hub:

GOVERSION=1.8
DOCKER_IMAGE_TAG=abcd-golang-builder-$GOVERSION
docker build -t $DOCKER_IMAGE_TAG -f ./Dockerfile-$GOVERSION .
docker tag $DOCKER_IMAGE_TAG abcd/$DOCKER_IMAGE_TAG
docker push abcd/$DOCKER_IMAGE_TAG

For a new major version, a new file Dockerfile-VERSION must be created and then the previous steps can be followed. That new version must be added to the travis build matrix to run the tests in travis.

Contact

If you have any further questions you can find us at:

• irc.freenode.net (channel #abcd)
• webchat
• forum.abcd.org
• abcd.slack.com

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation is a work-in-progress. It is located in the docs folder.

License

abcd is licensed under the copyfree ISC License.