Skip to content
An alternative full node bitcoin implementation written in Go (golang)
Go Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addrmgr addrmgr: store address' supported service bits Feb 6, 2019
blockchain netsync+blockchain: fix typos Jan 9, 2019
btcec txscript: handle variable length P2PKH signatures in ComputePkScript Jun 3, 2019
btcjson btcjson+rpc: match bitcoind's RPC error codes for rejected transactions May 22, 2019
chaincfg
cmd Read RPC username/pass from correct config file for btcctl defaults. Aug 14, 2017
connmgr connmgr: check for canceled connection before connect Apr 10, 2019
database multi: update to point to roasbeef forks May 23, 2018
docs docs: use go modules instead of glide Mar 15, 2019
integration integration/rpctest: make exec path compatible with modules Nov 29, 2018
limits Relicense to the btcsuite developers. May 1, 2015
mempool mempool: implement RBF signaling policy Jun 13, 2019
mining multi: Rework utxoset/view to use outpoints. May 27, 2018
netsync netsync/manager: add syncPeer stall detector Apr 27, 2019
peer Merge pull request #1315 from halseth/msgcfilter-string Oct 13, 2018
release readme: Remove mailing lists and include GPG key. Aug 25, 2017
rpcclient Merge pull request #1129 from gracenoah/fix-rescan Oct 13, 2018
txscript txscript: refactor ComputePkScript Jun 3, 2019
wire wire/msgcfcheckpt: add sanity check for cf checkpoint parsing Aug 24, 2018
.gitignore build: Convert project to use glide. (#689) May 6, 2016
.travis.yml travis: remove glide, only build 1.11.x, use modules Nov 30, 2018
CHANGES multi: correct all import paths May 23, 2018
LICENSE txscript: Significantly improve errors. Jan 12, 2017
README.md README: require go1.11, document module installation Nov 30, 2018
btcd.go btcd: pass user agent black and white lists to server Apr 17, 2019
config.go
config_test.go
doc.go
go.mod build: update to latest version of btcutil Apr 26, 2019
go.sum build: update to latest version of btcutil Apr 26, 2019
goclean.sh goclean: update for go modules Nov 30, 2018
log.go log: update to latest log rotator API May 23, 2018
params.go Change copyright date for code that was updated this year(2016). Jan 7, 2016
rpcadapters.go multi: correct all import paths May 23, 2018
rpcserver.go btcjson+rpc: match bitcoind's RPC error codes for rejected transactions May 22, 2019
rpcserverhelp.go rpc: remove extended fitler from help Jul 6, 2018
rpcserverhelp_test.go Relicense to the btcsuite developers. May 1, 2015
rpcwebsocket.go rpc: fix rescan bug if client disconnects Jul 8, 2019
sample-btcd.conf sampleconfig: Remove floating grave accent Sep 27, 2018
server.go mempool: implement RBF signaling policy Jun 13, 2019
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 ISC License GoDoc

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.11 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:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ GO111MODULE=on go install -v . ./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
$ GO111MODULE=on go install -v . ./cmd/...

Getting Started

btcd has several configuration options available 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.

You can’t perform that action at this time.