An alternative full node bitcoin implementation written in Go (golang)
Go to file
Dave Collins e7ddaa468e wire: Don't allocate new readers in benchmarks. (#679)
This modifies the benchmarks in the wire package to avoid creating a new
reader for each iteration.  This is useful since it means that showing
the memory allocations will only show the function under test instead of
the allocation for the benchmark setup as well.

The following is a before and after comparison of the allocations
with the benchmarks that did not change removed:

benchmark              old allocs     new allocs     delta
------------------------------------------------------------
ReadVarInt1            2              1              -50.00%
ReadVarInt3            2              1              -50.00%
ReadVarInt5            2              1              -50.00%
ReadVarInt9            2              1              -50.00%
ReadVarStr4            4              3              -25.00%
ReadVarStr10           4              3              -25.00%
ReadOutPoint           2              1              -50.00%
ReadTxOut              4              3              -25.00%
ReadTxIn               6              5              -16.67%
DeserializeTxSmall     16             15             -6.25%
DeserializeTxLarge     33430          33428          -0.01%
ReadBlockHeader        8              7              -12.50%
2016-04-25 16:57:44 -05:00
addrmgr multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
blockchain blockchain: Remove unused root field. (#680) 2016-04-25 16:17:29 -05:00
btcec txscript: optimize sigcache lookup (#598) 2016-04-13 21:56:10 -05:00
btcjson multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
chaincfg chaincfg: Consolidate tests into the chaincfg pkg. (#662) 2016-04-11 14:21:40 -05:00
cmd database: Replace with new version. 2016-04-12 14:55:15 -05:00
database database: Replace with new version. 2016-04-12 14:55:15 -05:00
docs docs: Update READMEs with current details. 2016-03-11 14:53:15 -06:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mining mining: Create skeleton package. 2015-11-30 12:23:50 -06:00
peer config: New option --blocksonly (#553) 2016-04-07 18:16:46 -05:00
release Update release script to correct btcctl location. 2015-02-28 03:39:20 -06:00
txscript txscript: Reduce script parse opcode allocs. (#677) 2016-04-25 16:17:07 -05:00
wire wire: Don't allocate new readers in benchmarks. (#679) 2016-04-25 16:57:44 -05:00
.gitignore Convert .gitignore line endings to unix. 2013-08-07 15:00:20 -05:00
.travis.yml travis: run tests on latest golang (1.5.4 and 1.6.1) (#669) 2016-04-14 13:38:25 -05:00
blocklogger.go Add support for an optional address-based transaction index. 2015-02-05 14:48:19 -08:00
blockmanager.go mempool: Have ProcessTransaction return accepted transactions. (#547) 2016-04-14 12:58:09 -05:00
btcd.go indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
CHANGES Fix typos in changelog. 2015-12-29 09:43:44 -07:00
config.go txscript: optimize sigcache lookup (#598) 2016-04-13 21:56:10 -05:00
cpuminer.go mining: Export block template fields. (#659) 2016-04-11 10:27:29 -05:00
deps.txt Add 0.12.0 deps to deps.txt. 2015-11-20 17:35:07 -06:00
discovery.go multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
doc.go blockchain: Rework to use new db interface. 2016-04-11 16:47:27 -05:00
dynamicbanscore_test.go Implement banning based on dynamic ban scores 2016-02-16 10:10:29 +01:00
dynamicbanscore.go multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
goclean.sh Correct a few style related issues found by golint. 2015-10-20 10:34:14 -05:00
LICENSE Update LICENSE 2016-01-23 16:06:10 -05:00
log.go btcd: Remove peer-specific logging funcs. (#675) 2016-04-20 23:58:31 -05:00
mempool.go mempool: Have ProcessTransaction return accepted transactions. (#547) 2016-04-14 12:58:09 -05:00
mempoolerror.go multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
mining_test.go mining: Improve tests for prio queue. (#667) 2016-04-14 00:19:23 -05:00
mining.go blockchain: Rework to use new db interface. 2016-04-11 16:47:27 -05:00
params.go Change copyright date for code that was updated this year(2016). 2016-01-07 09:01:51 -07:00
policy_test.go Do not use unkeyed fields. 2016-02-08 17:50:38 -05:00
policy.go blockchain: Rework to use new db interface. 2016-04-11 16:47:27 -05:00
README.md docs: Update READMEs with current details. 2016-03-11 14:53:15 -06:00
rpcserver.go mempool: Have ProcessTransaction return accepted transactions. (#547) 2016-04-14 12:58:09 -05:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcserverhelp.go multi: Update with result of gofmt -s. 2016-02-25 13:02:54 -06:00
rpcwebsocket.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
sample-btcd.conf indexers: Implement optional tx/address indexes. 2016-04-11 17:16:42 -05:00
server.go mempool: Have ProcessTransaction return accepted transactions. (#547) 2016-04-14 12:58:09 -05:00
service_windows.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
signal.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
upgrade.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -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 bugs) for block acceptance as Bitcoin Core. We have taken great care to avoid btcd causing a fork to the block chain. It passes all of the 'official' block acceptance tests (https://github.com/TheBlueMatt/test-scripts) as well as all of the JSON test data in the Bitcoin Core code.

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

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.5 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.

  • Run the following command to obtain btcd, all dependencies, and install it:
$ go get -u github.com/btcsuite/btcd/...
  • btcd (and utilities) will now be installed in either $GOROOT/bin or $GOPATH/bin depending on your configuration. 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 command to update btcd, all dependencies, and install it:
$ go get -u -v github.com/btcsuite/btcd/...

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.