An alternative full node implementation of LBRY's blockchain written in Go (golang)
Find a file
Wilmer Paulino fdb479f121
peer: allow external testing of peer.Peer
The previous use of allowSelfConns prevented this, as users aren't able
to invoke peer.TstAllowSelfConns themselves due to being part of a test
file, which aren't exported at the library level, leading to a
"disconnecting peer connected to self" error upon establishing a mock
connection between two peers. By including the option at the config
level instead (false by default, prevents connections to self) we enable
users of the peer library to properly test the behavior of the peer.Peer
struct externally.
2021-03-11 18:24:13 -08:00
.github/workflows Merge pull request #1621 from xplorfin/go1.15 2020-10-02 14:52:29 -07:00
addrmgr addrmgr: store address' supported service bits 2019-02-06 13:33:18 -08:00
blockchain docs: update shields 2021-03-05 07:45:19 -05:00
btcec docs: update shields 2021-03-05 07:45:19 -05:00
btcjson docs: update shields 2021-03-05 07:45:19 -05:00
chaincfg docs: update shields 2021-03-05 07:45:19 -05:00
cmd Add Batch JSON-RPC support (rpc client & server) 2021-02-09 09:47:46 -05:00
connmgr docs: update shields 2021-03-05 07:45:19 -05:00
database docs: update shields 2021-03-05 07:45:19 -05:00
docs docs: update shields 2021-03-05 07:45:19 -05:00
integration docs: update shields 2021-03-05 07:45:19 -05:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mempool docs: update shields 2021-03-05 07:45:19 -05:00
mining docs: update shields 2021-03-05 07:45:19 -05:00
netsync docs: update shields 2021-03-05 07:45:19 -05:00
peer peer: allow external testing of peer.Peer 2021-03-11 18:24:13 -08:00
release ci: add go 1.15 to tests 2020-09-17 01:38:18 -04:00
rpcclient docs: update shields 2021-03-05 07:45:19 -05:00
txscript docs: update shields 2021-03-05 07:45:19 -05:00
wire docs: update shields 2021-03-05 07:45:19 -05:00
.gitignore GitHub Actions: Enable Go Race detector and code coverage 2020-09-08 10:19:55 -04:00
btcd.go removed unnecessary GOMAXPROCS function calls 2020-09-14 09:57:30 -04:00
CHANGES Update CHANGES file for 0.21.0 release 2020-08-27 15:26:14 -04:00
config.go config+service_windows: add flag to disable win service 2020-07-22 12:57:09 +02:00
config_test.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
doc.go Alphabetize --help output; add missing options to doc.go 2020-04-14 05:09:43 -05:00
Dockerfile Add support for arm32v7 in Dockerfile 2021-01-18 13:50:30 -05:00
go.mod ci: add go 1.15 to tests 2020-09-17 01:38:18 -04:00
go.sum peer: knownInventory, sentNonces - use generic lru 2020-07-08 16:44:04 -04:00
goclean.sh GitHub Actions: Enable Go Race detector and code coverage 2020-09-08 10:19:55 -04:00
LICENSE txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
log.go log: update to latest log rotator API 2018-05-23 16:46:15 -07:00
params.go Change copyright date for code that was updated this year(2016). 2016-01-07 09:01:51 -07:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
rpcadapters.go rpc: Add getnodeaddresses JSON-RPC support 2020-09-14 09:36:05 -04:00
rpcserver.go rpcserver: Fix Error message returned by processRequest 2021-03-09 10:34:32 -05:00
rpcserverhelp.go btcjson: Update fields in GetBlockChainInfoResult 2021-01-26 09:52:38 -05:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcwebsocket.go Add Batch JSON-RPC support (rpc client & server) 2021-02-09 09:47:46 -05:00
sample-btcd.conf sample-btcd.conf: fix typo 2020-09-17 09:03:52 -04:00
server.go btcd+netsync: support witness tx and block in notfound msg 2020-09-03 18:53:16 +08:00
service_windows.go config+service_windows: add flag to disable win service 2020-07-22 12:57:09 +02: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 multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
upnp.go btcd: fix conversion of int to string failing in Go 1.15 2020-08-31 16:01:10 -04:00
version.go btcd: bump version to v0.21.0-beta 2020-08-28 08:13:36 -04:00

btcd

Build Status Coverage 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.14 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.

Release Verification

Please see our documentation on the current build/verification process for all our releases for information on how to verify the integrity of published releases using our reproducible build system.

License

btcd is licensed under the copyfree ISC License.