An alternative full node bitcoin implementation written in Go (golang)
Go to file
John C. Vernaleo 1e38d7fd4b Switch to gometalint in goclean
This switches `goclean` to use `gometalint` instead of running each checking tool one at a time.  The `gometalint` tool runs them concurrently.

More importantly it will allow us to easily add additional linters as desired.
2016-11-02 17:36:32 -05:00
addrmgr addrmgr: Fix AddressCache to not include nils 2016-09-26 12:16:40 -05:00
blockchain multi: Correct misspellings detected by misspell. 2016-10-28 09:43:38 -05:00
btcec btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
btcjson rpc: Add localaddr and relaytxes to getpeerinfo 2016-10-19 19:58:50 -04:00
chaincfg chaincfg: Introduce new type DNSSeed 2016-10-23 15:59:15 -05:00
cmd Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
connmgr connmgr: unexport the DynamicBanScore mutex. 2016-11-01 14:53:15 -05:00
database chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
docs docs: Add mempool entry to developer tools section. 2016-10-23 20:47:05 -05:00
integration integration: Initial implementation. 2016-10-25 14:36:23 -05:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mempool mempool: Modify default orphan tx policy. 2016-10-28 15:41:59 -05:00
mining cpuminer: Refactor code to its own package. 2016-10-28 11:06:11 -05:00
peer peer: Separate ping ticker functionality from outHandler. 2016-10-29 23:28:12 +01:00
release Update release script to correct btcctl location. 2015-02-28 03:39:20 -06:00
rpctest wire: Make NewMsgTx accept the tx version. 2016-10-27 14:09:29 -05:00
txscript multi: Correct misspellings detected by misspell. 2016-10-28 09:43:38 -05:00
wire multi: Correct misspellings detected by misspell. 2016-10-28 09:43:38 -05:00
.gitignore build: Convert project to use glide. (#689) 2016-05-06 10:47:53 -05:00
.travis.yml Switch to gometalint in goclean 2016-11-02 17:36:32 -05:00
blocklogger.go Add support for an optional address-based transaction index. 2015-02-05 14:48:19 -08:00
blockmanager.go mempool: Associated tag with orphan txns. 2016-10-28 15:27:57 -05:00
btcd.go btcd: Simplify shutdown signal handling logic. (#733) 2016-08-11 13:39:23 -05:00
CHANGES Fix typos in changelog. 2015-12-29 09:43:44 -07:00
config_test.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
config.go mempool: Modify default orphan tx policy. 2016-10-28 15:41:59 -05:00
doc.go mempool: Modify default orphan tx policy. 2016-10-28 15:41:59 -05:00
glide.lock wire: Make NewMsgTx accept the tx version. 2016-10-27 14:09:29 -05:00
glide.yaml build: update dependancies required by rpctest 2016-08-19 17:42:25 -05:00
goclean.sh Switch to gometalint in goclean 2016-11-02 17:36:32 -05:00
LICENSE add license title (#717) 2016-08-11 16:58:15 -05:00
log.go server/mempool: Evict orphans on peer disconnect. 2016-10-28 15:27:57 -05:00
params.go Change copyright date for code that was updated this year(2016). 2016-01-07 09:01:51 -07:00
README.md blockchain: Add block validation infrastructure. 2016-10-17 12:16:53 -05:00
rpcserver.go mempool: Associated tag with orphan txns. 2016-10-28 15:27:57 -05:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcserverhelp.go rpc: Add localaddr and relaytxes to getpeerinfo 2016-10-19 19:58:50 -04:00
rpcwebsocket.go multi: Correct misspellings detected by misspell. 2016-10-28 09:43:38 -05:00
sample-btcd.conf mempool: Modify default orphan tx policy. 2016-10-28 15:41:59 -05:00
server.go server: Cap max outbound in connmgr cfg at max peers 2016-11-02 15:10:14 -05:00
service_windows.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
signal.go btcd: Simplify shutdown signal handling logic. (#733) 2016-08-11 13:39:23 -05:00
signalsigterm.go btcd: Simplify shutdown signal handling logic. (#733) 2016-08-11 13:39:23 -05:00
upgrade.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
upnp.go Fixed DeletePortMapping documentation typo 2015-01-01 21:59:57 +01:00
version.go Prepare for release 0.12.0. 2015-11-20 19:33:17 -06:00

btcd

[Build Status] (https://travis-ci.org/btcsuite/btcd)

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.