bchd is an alternative full node bitcoin cash implementation written in Go (golang).
This project is a port of the btcd codebase to Bitcoin Cash. It provides a high powered and reliable blockchain server which makes it a suitable backend to serve blockchain data to lite clients and block explorers or to power your local wallet.
bchd does not include any wallet functionality by design as it makes the codebase more modular and easy to maintain. The bchwallet is a separate application that provides a secure Bitcoin Cash wallet that communicates with your running bchd instance via the API.
Go 1.8 or newer.
The easiest way to run the server is to download a pre-built binary. You can find binaries of our latest release for each operating system at the releases page.
If you prefer to install from source do the following:
-
Install Go according to the installation instructions here: http://golang.org/doc/install
-
Run the following commands to obtain btcd, all dependencies, and install it:
$ go get github.com/gcash/bchdThis will download and compile bchd and put it in your path.
To start bchd with default options just run:
$ ./bchdYou'll find a large number of runtime options on the help menu. All of which can also be set in a config file. See the sample config file for an example of how to use it.
Building and running bchd in docker is quite painless. To build the image:
docker build . -t bchd
To run the image:
docker run bchd
To run bchctl and connect to your bchd instance:
# Find the running bchd container.
docker ps
# Exec bchctl.
docker exec <container> bchctl <command>
The documentation is a work-in-progress. It is located in the docs folder.
Contributions are definitely welcome! Please read the contributing guidelines before starting.
bchd is licensed under the copyfree ISC License.