An alternative full node bitcoin implementation written in Go (golang)
Go to file
Calvin Kim 5a91ea23ca blockchain_test, fullblocktests: add test to check for utxo
existance/non-existance

New test instance BlockDisconnectExpectUTXO tests that a utxo
exists/doesn't exist after a specific block has been disconnected.
2024-02-21 19:09:03 +09:00
.github/workflows Upgrade go docker builder image 2022-04-11 09:22:36 -04:00
addrmgr multi: remove repetitive the 2023-06-26 15:40:51 +08:00
blockchain blockchain_test, fullblocktests: add test to check for utxo 2024-02-21 19:09:03 +09:00
btcec btcec: fix typo 2024-01-09 17:12:36 +08:00
btcjson rpcclient: support testmempoolaccept for bitcoind 2024-01-15 17:22:41 +08:00
btcutil gomod: run go mod tidy for all modules 2024-01-15 17:22:42 +08:00
chaincfg chaincfg: update mainnet block hashes 2023-12-30 16:25:02 -08:00
cmd doc: correct comments 2023-12-20 11:41:55 -05:00
connmgr multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
database database: fix typo 2024-01-09 17:12:09 +08:00
docs docs: fix typo 2024-01-09 17:11:59 +08:00
integration integration: print logs to console 2024-01-15 17:22:42 +08:00
limits multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
mempool multi: map btcd mempool acceptance errors to bitcoind's testmempoolaccept 2024-01-15 17:22:41 +08:00
mining fix: enhance code comments (#2074) 2023-12-19 10:40:37 -05:00
netsync blockchain, netsync, main, cmd/addblock: Use utxocache 2023-12-16 16:53:17 +09:00
ossec harden btcd on OpenBSD 2022-04-09 07:22:22 -04:00
peer multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
release ci: add go 1.15 to tests 2020-09-17 01:38:18 -04:00
rpcclient rpcclient: make sure batch requests are GCed 2024-01-19 18:56:22 +08:00
scripts gomod: run go mod tidy for all modules 2024-01-15 17:22:42 +08:00
txscript Fix some typos (#2085) 2024-01-03 16:36:49 -05:00
wire wire: add Copy method to MsgBlock 2024-01-21 18:43:15 +08:00
.gitignore gitignore: ignore vim files 2024-01-15 17:22:40 +08:00
btcd.go main: cfindex related sanity checks when enabled with pruning 2023-08-23 00:46:53 +09:00
CHANGES Update release date for v0.22.0-beta in CHANGES file 2021-06-01 13:16:51 -04:00
config_test.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
config.go doc: correct comments 2023-12-20 11:41:55 -05:00
doc.go doc: correct comments 2023-12-20 11:41:55 -05:00
Dockerfile Fix some typos (#2085) 2024-01-03 16:36:49 -05:00
go.mod gomod: run go mod tidy for all modules 2024-01-15 17:22:42 +08:00
go.sum gomod: run go mod tidy for all modules 2024-01-15 17:22:42 +08:00
LICENSE Update LICENSE 2023-10-20 15:24:16 -04:00
log.go log: update to latest log rotator API 2018-05-23 16:46:15 -07:00
Makefile refactor: add make help command that describes goals 2024-01-24 10:28:18 +08:00
params.go config+params: add signet config option 2021-04-22 13:10:45 +02:00
README.md multi: remove use of GO111MODULE 2023-12-11 09:16:27 -05:00
rpcadapters.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
rpcserver_test.go btcd: add new RPC method testmempoolaccept 2024-01-15 17:22:41 +08:00
rpcserver.go multi: map btcd mempool acceptance errors to bitcoind's testmempoolaccept 2024-01-15 17:22:41 +08:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcserverhelp.go btcd: add new RPC method testmempoolaccept 2024-01-15 17:22:41 +08:00
rpcwebsocket.go multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
sample-btcd.conf Fix some typos (#2085) 2024-01-03 16:36:49 -05:00
SECURITY.md btcd: add SECURITY.md 2023-12-30 16:24:59 -08:00
server.go Fix some typos (#2085) 2024-01-03 16:36:49 -05: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 multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09: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 build: bump version to btcd v0.24 2023-12-30 16:25:08 -08: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.17 or newer.

Installation

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
$ 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

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

Linux/BSD/POSIX/Source

$ ./btcd

IRC

  • irc.libera.chat
  • 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.