f68cd7422d
This introduces a new binary free list which provides a concurrent safe list of unused buffers for the purpose of serializing and deserializing primitive integers to their raw binary bytes. For convenience, the type also provides functions for each of the primitive unsigned integers that automatically obtain a buffer from the free list, perform the necessary binary conversion, read from or write to the given io.Reader or io.Writer, and return the buffer to the free list. A global instance of the type has been introduced with a maximum number of 1024 items. Since each buffer is 8 bytes, it will consume a maximum of 8KB. Theoretically, this value would only allow up to 1024 peers simultaneously reading and writing without having to resort to burdening the garbage collector with additional allocations. However, due to the fact the code is designed in such a way that the buffers are quickly used and returned to the free list, in practice it can support much more than 1024 peers without involving the garbage collector since it is highly unlikely every peer would need a buffer at the exact same time. 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 ------------------------------------------------------------- WriteVarInt1 1 0 -100.00% WriteVarInt3 1 0 -100.00% WriteVarInt5 1 0 -100.00% WriteVarInt9 1 0 -100.00% ReadVarInt1 1 0 -100.00% ReadVarInt3 1 0 -100.00% ReadVarInt5 1 0 -100.00% ReadVarInt9 1 0 -100.00% ReadVarStr4 3 2 -33.33% ReadVarStr10 3 2 -33.33% WriteVarStr4 2 1 -50.00% WriteVarStr10 2 1 -50.00% ReadOutPoint 1 0 -100.00% WriteOutPoint 1 0 -100.00% ReadTxOut 3 1 -66.67% WriteTxOut 2 0 -100.00% ReadTxIn 5 2 -60.00% WriteTxIn 3 0 -100.00% DeserializeTxSmall 15 7 -53.33% DeserializeTxLarge 33428 16715 -50.00% SerializeTx 8 0 -100.00% ReadBlockHeader 7 1 -85.71% WriteBlockHeader 10 4 -60.00% DecodeGetHeaders 1004 501 -50.10% DecodeHeaders 18002 4001 -77.77% DecodeGetBlocks 1004 501 -50.10% DecodeAddr 9002 4001 -55.55% DecodeInv 150005 50003 -66.67% DecodeNotFound 150004 50002 -66.67% DecodeMerkleBlock 222 108 -51.35% TxSha 10 2 -80.00% |
||
|---|---|---|
| addrmgr | ||
| blockchain | ||
| btcec | ||
| btcjson | ||
| chaincfg | ||
| cmd | ||
| database | ||
| docs | ||
| limits | ||
| mining | ||
| peer | ||
| release | ||
| txscript | ||
| wire | ||
| .gitignore | ||
| .travis.yml | ||
| blocklogger.go | ||
| blockmanager.go | ||
| btcd.go | ||
| CHANGES | ||
| config.go | ||
| cpuminer.go | ||
| deps.txt | ||
| discovery.go | ||
| doc.go | ||
| dynamicbanscore.go | ||
| dynamicbanscore_test.go | ||
| glide.lock | ||
| glide.yaml | ||
| goclean.sh | ||
| LICENSE | ||
| log.go | ||
| mempool.go | ||
| mempoolerror.go | ||
| mining.go | ||
| mining_test.go | ||
| params.go | ||
| policy.go | ||
| policy_test.go | ||
| README.md | ||
| rpcserver.go | ||
| rpcserverhelp.go | ||
| rpcserverhelp_test.go | ||
| rpcwebsocket.go | ||
| sample-btcd.conf | ||
| server.go | ||
| service_windows.go | ||
| signal.go | ||
| signalsigterm.go | ||
| upgrade.go | ||
| upnp.go | ||
| version.go | ||
btcd
[
]
(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. It is also recommended to add
$GOPATH/bin to your PATH at this point.
NOTE: If you are using Go 1.5, you must manually enable the vendor
experiment by setting the GO15VENDOREXPERIMENT environment variable to 1.
This step is not required for Go 1.6.
- 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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
btcd is licensed under the copyfree ISC License.