An alternative full node bitcoin implementation written in Go (golang)
Go Shell
Latest commit c2af640 Dec 1, 2016 @stevenroose stevenroose blockchain: Allow adding additional checkpoints
Introduces a `--checkpoint` flag that allows the user to specify
additional checkpoints or override the default ones provided in the
chain params.
Permalink
Failed to load latest commit information.
addrmgr wire: Treat NetAddress more like immutable Dec 6, 2016
blockchain blockchain: Allow adding additional checkpoints Jan 18, 2017
btcec mining: drop getwork support. Jan 11, 2017
btcjson Port `getheaders` JSON-RPC command from dcrd Jan 11, 2017
chaincfg chaincfg: add testnet checkpoints Jan 12, 2017
cmd blockchain: TimeSource is required. Jan 12, 2017
connmgr server: Fix connections to onion nodes. Jan 18, 2017
database Drop btcsuite/go-flags in favor of upstream Jan 9, 2017
docs mining: drop getwork support. Jan 11, 2017
integration integration: Add BIP0009 state transition tests Dec 7, 2016
limits Relicense to the btcsuite developers. May 1, 2015
mempool btcd: support feefilter requests. Nov 3, 2016
mining Implement infrastructure for BIP0009. Nov 30, 2016
peer Add MerkleBlock deadline to CmdGetData Jan 10, 2017
release Update release script to correct btcctl location. Feb 28, 2015
rpctest rpctest: Prevent race during teardown. Dec 7, 2016
txscript txscript: Implement ScriptVerifyNullFail Jan 13, 2017
wire wire: Treat NetAddress more like immutable Dec 6, 2016
.gitignore build: Convert project to use glide. (#689) May 6, 2016
.travis.yml travis: test against latest patch release. Jan 11, 2017
CHANGES Fix typos in changelog. Dec 29, 2015
LICENSE txscript: Significantly improve errors. Jan 12, 2017
README.md blockchain: Add block validation infrastructure. Oct 17, 2016
blocklogger.go Add support for an optional address-based transaction index. Feb 5, 2015
blockmanager.go blockchain: Allow adding additional checkpoints Jan 18, 2017
btcd.go Unassign some TODO's Nov 15, 2016
config.go blockchain: Allow adding additional checkpoints Jan 18, 2017
config_test.go Reconcile differences between btcd/dcrd. Oct 21, 2016
doc.go blockchain: Allow adding additional checkpoints Jan 18, 2017
glide.lock travis: test against latest patch release. Jan 11, 2017
glide.yaml travis: test against latest patch release. Jan 11, 2017
goclean.sh goclean.sh: Make it more robust Dec 9, 2016
log.go multi: Remove unused code found by deadcode. Nov 2, 2016
params.go Change copyright date for code that was updated this year(2016). Jan 7, 2016
rpcserver.go server: Fix connections to onion nodes. Jan 18, 2017
rpcserverhelp.go mining: drop getwork support. Jan 11, 2017
rpcserverhelp_test.go Relicense to the btcsuite developers. May 1, 2015
rpcwebsocket.go mining: drop getwork support. Jan 11, 2017
sample-btcd.conf blockchain: Allow adding additional checkpoints Jan 18, 2017
server.go server: Fix connections to onion nodes. Jan 18, 2017
service_windows.go multi: Simplify code per gosimple linter. Nov 3, 2016
signal.go btcd: Simplify shutdown signal handling logic. (#733) Aug 11, 2016
signalsigterm.go btcd: Simplify shutdown signal handling logic. (#733) Aug 11, 2016
upgrade.go multi: Simplify code per gosimple linter. Nov 3, 2016
upnp.go multi: Simplify code per gosimple linter. Nov 3, 2016
version.go Prepare for release 0.12.0. Nov 21, 2015

README.md

btcd

Build Status

btcd is an alternative full node bitcoin implementation written in Go (golang).

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

It properly downloads, validates, and serves the block chain using the exact rules (including consensus bugs) for block acceptance as Bitcoin Core. We have taken great care to avoid btcd causing a fork to the block chain. It includes a full block validation testing framework which contains all of the 'official' block acceptance tests (and some additional ones) that is run on every pull request to help ensure it properly follows consensus. Also, it passes all of the JSON test data in the Bitcoin Core code.

It also properly relays newly mined blocks, maintains a transaction pool, and relays individual transactions that have not yet made it into a block. It ensures all individual transactions admitted to the pool follow the rules required by the block chain and also includes more strict checks which filter transactions based on miner requirements ("standard" transactions).

One key difference between btcd and Bitcoin Core is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the blog entry here for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the btcwallet and Paymetheus (Windows-only) projects which are both under active development.

Requirements

Go 1.6 or newer.

Installation

Windows - MSI Available

https://github.com/btcsuite/btcd/releases

Linux/BSD/MacOSX/POSIX - Build from Source

  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Ensure Go was installed properly and is a supported version:

$ go version
$ go env GOROOT GOPATH

NOTE: The GOROOT and GOPATH above must not be the same path. It is recommended that GOPATH is set to a directory in your home directory such as ~/goprojects to avoid write permission issues. It is also recommended to add $GOPATH/bin to your PATH at this point.

  • Run the following commands to obtain btcd, all dependencies, and install it:
$ go get -u github.com/Masterminds/glide
$ git clone https://github.com/btcsuite/btcd $GOPATH/src/github.com/btcsuite/btcd
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ glide install
$ go install . ./cmd/...
  • btcd (and utilities) will now be installed in $GOPATH/bin. 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

  • Run the following commands to update btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ git pull && glide install
$ go install . ./cmd/...

Getting Started

btcd has several configuration options avilable to tweak how it runs, but all of the basic operations described in the intro section work with zero configuration.

Windows (Installed from MSI)

Launch btcd from your Start menu.

Linux/BSD/POSIX/Source

$ ./btcd

IRC

  • irc.freenode.net
  • channel #btcd
  • webchat

Mailing lists

  • btcd: discussion of btcd and its packages.
  • btcd-commits: readonly mail-out of source code changes.

To subscribe to a given list, send email to list+subscribe@opensource.conformal.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.

GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from the btcsuite developers. To verify the signature perform the following:

  • Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

  • Import the public key into your GPG keyring:

    gpg --import GIT-GPG-KEY-conformal.txt
  • Verify the release tag with the following command where TAG_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME

License

btcd is licensed under the copyfree ISC License.