An alternative full node bitcoin implementation written in Go (golang)
Clone or download
#29 Compare This branch is 137 commits ahead, 220 commits behind btcsuite:master.
Permalink
Failed to load latest commit information.
addrmgr multi: update imports to roasbeef's Nov 17, 2017
blockchain blockchain/indexers: Add methods on CfIndex for batch retrieval. Mar 31, 2018
btcec multi: update imports to roasbeef's Nov 17, 2017
btcjson multi: use hidden varint for cftypes count; make filter type enum, no… Nov 17, 2017
chaincfg chaincfg: change hrp prefix for regtest network Apr 18, 2018
cmd multi: update imports to roasbeef's Nov 17, 2017
connmgr connmgr: adds cancellation of pending requests Dec 13, 2017
database multi: update to point to roasbeef forks Nov 17, 2017
docs multi: update to point to roasbeef forks Nov 17, 2017
integration integration/rpctest: if unable to build btcd, use one in PATH Nov 24, 2017
limits Relicense to the btcsuite developers. May 1, 2015
mempool mempool_test: add TestCheckSpend Mar 23, 2018
mining multi: update to point to roasbeef forks Nov 17, 2017
netsync FeeEstimator added to server. Mempool alerts the fee estimator of Nov 17, 2017
peer wire: Define CFCheckpt message. Mar 31, 2018
release readme: Remove mailing lists and include GPG key. Aug 25, 2017
rpcclient rpcclient: Put CFHeader in PrevFilterHeader field in RPC response. Mar 31, 2018
txscript multi: update to point to roasbeef forks Nov 17, 2017
wire wire: increase MaxGetCFiltersReqRange from 100 to 1000 Mar 31, 2018
.gitignore build: Convert project to use glide. (#689) May 6, 2016
.travis.yml travis: Update to go 1.8 and 1.9. Aug 30, 2017
CHANGES multi: update to point to roasbeef forks Nov 17, 2017
LICENSE txscript: Significantly improve errors. Jan 12, 2017
README.md multi: update imports to roasbeef's Nov 17, 2017
btcd.go multi: rebase to upstream, update API's Nov 17, 2017
config.go multi: update imports to roasbeef's Nov 17, 2017
config_test.go Reconcile differences between btcd/dcrd. Oct 21, 2016
doc.go CBFilter -> CFilter, discussed with davec@ Nov 17, 2017
glide.lock build: update to point to latest btcutil with BIP-158 updates Apr 6, 2018
glide.yaml build: update to point to latest btcutil with BIP-158 updates Apr 6, 2018
goclean.sh TravisCI: Don't run tests with race. Jul 1, 2017
log.go log: update to latest log rotator API Nov 17, 2017
params.go multi: update imports to roasbeef's Nov 17, 2017
rpcadapters.go multi: rebase to upstream, update API's Nov 17, 2017
rpcserver.go It is now possible to save and restore the state of the FeeEstimator Nov 17, 2017
rpcserverhelp.go Enable estimatefee rpc command. Nov 17, 2017
rpcserverhelp_test.go Relicense to the btcsuite developers. May 1, 2015
rpcwebsocket.go rpcwebsocket: notify spends already in the mempool Mar 23, 2018
sample-btcd.conf CBFilter -> CFilter, discussed with davec@ Nov 17, 2017
server.go server: Handler for getcfcheckpt messages. Mar 31, 2018
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 Fix a ton of typos accumulated over time May 30, 2017
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.8 or newer.

Installation

Windows - MSI Available

https://github.com/roasbeef/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/roasbeef/btcd $GOPATH/src/github.com/roasbeef/btcd
$ cd $GOPATH/src/github.com/roasbeef/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/roasbeef/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

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:

License

btcd is licensed under the copyfree ISC License.