An alternative full node bitcoin implementation written in Go (golang)
Go to file
Javed Khan bff2ba70fd connmgr: Refactor connection management into pkg
This commit introduces package connmgr which contains connection
management related functionality.

The following is an overview of the features the package provides:

- Maintain fixed number of outbound connections
- Optional connect-only mode
- Retry persistent connections with increasing back-off
- Source peers from DNS seeds
- Use Tor to resolve DNS
- Dynamic ban scores
- Test coverage

In addition, btcd has been refactored to make use of the new package by
extending the connection manager to work with the server to source and
maintain peer connections. The following is a broad overview of the
changes to integrate the package:

- Simplify peer state by removing pending, retry peers
- Refactor to remove retries which are now handled by connmgr
- Use callback to add addresses sourced from the  DNS seed

Finally the following connection-related things have been improved as a
part of this refactor:

- Fixes 100% cpu usage when network is down (#129)
- Fixes issues with max peers (#577)
- Simplify outbound peer connections management
2016-10-22 01:11:57 -05:00
addrmgr addrmgr: Fix AddressCache to not include nils 2016-09-26 12:16:40 -05:00
blockchain blockchain: Support small coinbase block size 2016-10-20 12:09:09 -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/blockchain: Parameterize more chain consts. (#732) 2016-08-10 16:02:23 -05:00
cmd Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
connmgr connmgr: Refactor connection management into pkg 2016-10-22 01:11:57 -05:00
database chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
docs connmgr: Refactor connection management into pkg 2016-10-22 01:11:57 -05:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mempool mempool: transaction finality checks now use median-time-past 2016-10-19 11:13:34 -07:00
mining chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
peer peer: rename peer.Connect to AssociateConnection 2016-10-21 14:13:18 -05:00
release Update release script to correct btcctl location. 2015-02-28 03:39:20 -06:00
rpctest rpctest: Choose flags based on provided params. 2016-10-20 12:19:58 -05:00
txscript txscript: Remove OP_SMALLDATA 2016-10-21 15:18:42 -04:00
wire txscript: Implement CheckSequenceVerify (BIP0112) 2016-10-19 12:06:44 -04:00
.gitignore build: Convert project to use glide. (#689) 2016-05-06 10:47:53 -05:00
.travis.yml build: install btcd binary within Travis container 2016-08-19 17:43:42 -05:00
blocklogger.go Add support for an optional address-based transaction index. 2015-02-05 14:48:19 -08:00
blockmanager.go blockchain: Remove exported CalcPastTimeMedian func. 2016-10-17 10:41:25 -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 connmgr: Refactor connection management into pkg 2016-10-22 01:11:57 -05:00
cpuminer.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
deps.txt Add 0.12.0 deps to deps.txt. 2015-11-20 17:35:07 -06:00
doc.go config: introduce new flags to accept/reject non-std transactions 2016-08-24 15:43:26 -07:00
glide.lock Update dependencies and API usage. 2016-09-21 20:50:55 -04:00
glide.yaml build: update dependancies required by rpctest 2016-08-19 17:42:25 -05:00
goclean.sh btcec: Consolidate tests into the btcec package. 2016-10-19 00:55:23 -05:00
LICENSE add license title (#717) 2016-08-11 16:58:15 -05:00
log.go connmgr: Refactor connection management into pkg 2016-10-22 01:11:57 -05:00
mining_test.go mining: Improve tests for prio queue. (#667) 2016-04-14 00:19:23 -05:00
mining.go mempool: Refactor mempool code to its own package. (#737) 2016-08-19 11:08:37 -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_test.go rpctest: Gate rpctest-based behind a build tag. 2016-09-26 01:20:31 -05:00
rpcserver.go rpc: Add localaddr and relaytxes to getpeerinfo 2016-10-19 19:58:50 -04: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 Concurrently handle websocket client JSON-RPC requests. 2016-10-20 19:55:58 -04:00
sample-btcd.conf config: introduce new flags to accept/reject non-std transactions 2016-08-24 15:43:26 -07:00
server.go connmgr: Refactor connection management into pkg 2016-10-22 01:11:57 -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.