No description
Find a file
Olaoluwa Osuntokun 90bf88486f integration: add comprehensive BIP 431 TRUC policy tests
This commit adds end-to-end integration tests for BIP 431 (TRUC) policy
enforcement using the rpctest harness. The tests verify all six TRUC rules
plus security properties using real btcd nodes and transaction submission.

The test infrastructure enhancements to rpctest include v3 transaction
creation helpers (CreateV3Transaction, CreateV3Child) that properly handle
transaction version selection through functional options. The AddUnconfirmedTx
method on MemWallet now tracks outputs by keyIndex to enable proper UTXO
management for test scenarios involving multiple children spending different
outputs from the same parent.

The TRUC policy test suite covers:

Rule 1 (replaceability): Verifies v3 transactions signal RBF even without
BIP 125 sequence numbers, enabling reliable replacement for fee-bumping.

Rule 2 (all-or-none): Tests that v3 transactions correctly reject unconfirmed
v2 parents while accepting confirmed v2 parents, enforcing the all-or-none
TRUC requirement.

Rule 3 (topology): Validates the 1-parent-1-child constraint by testing both
valid 1P1C acceptance and rejection of long v3 chains (grandparent→parent→
child) that violate the ancestor limit.

Rules 4-5 (size limits): Confirms transactions within the size limits are
accepted. Precise size testing is deferred to unit tests where exact byte
control is easier.

Rule 6 (zero-fee): Marked as pending future package relay RPC support.

Security tests verify the topology restrictions prevent common pinning
vectors, specifically that multiple children and long chains are both
rejected.

These integration tests complement the unit tests by exercising the full
mempool acceptance pipeline with real transactions, RPC submission, and
multi-node scenarios. All tests pass, confirming the TRUC implementation is
correct and ready for production use.
2025-10-28 16:47:28 -07:00
.gemini .gemini: add styleguide.md 2025-07-16 11:46:18 +00:00
.github Makefile+workflows: fallback to GOPATH/bin on non-existent GOBIN 2025-08-20 16:02:15 +00:00
addrmgr multi: deprecation gocov 2025-03-19 09:45:48 +08:00
blockchain blockchain: implement AlwaysActiveHeight for forced deployment activation 2025-03-18 11:18:39 -05:00
btcec ellswift: introduce ElligatorSwift encoding and decoding funcs 2025-05-26 13:46:25 -07:00
btcjson Merge pull request #2366 from bhandras/submitpackage 2025-07-28 18:00:03 -05:00
btcutil Merge pull request #2320 from gosunuts/feature/fix-ci 2025-08-19 18:09:43 -07:00
chaincfg blockchain: implement AlwaysActiveHeight for forced deployment activation 2025-03-18 11:18:39 -05:00
cmd Print a readable error before os.Exit(1) in btcctl 2025-07-01 15:17:21 -04:00
connmgr multi: refactor v2 -> v1 downgrade logic 2025-05-26 13:46:25 -07:00
database Merge pull request #2358 from kcalvinalvin/2025-02-17-exit-when-running-out-of-disk-space 2025-05-06 16:31:09 -07:00
docs docs: update contribution guidelines and links 2025-03-07 13:29:28 +08:00
integration integration: add comprehensive BIP 431 TRUC policy tests 2025-10-28 16:47:28 -07:00
limits multi: Run gofmt on the entire repository 2023-06-21 22:31:09 +09:00
mempool mempool: integrate package validation into PolicyEnforcer 2025-10-28 16:47:28 -07:00
mining chore: fix some comments for struct field (#2214) 2024-07-16 09:02:23 -04:00
netsync mempool+netsync: extend TxMempool interface for unified abstraction 2025-10-27 16:10:43 -07:00
ossec harden btcd on OpenBSD 2022-04-09 07:22:22 -04:00
peer p2p: remove alert msg 2025-07-10 13:07:50 -03:00
release release: add darwin-arm64 to target binaries (#2173) 2024-04-22 15:30:25 -04:00
rpcclient Merge pull request #2320 from gosunuts/feature/fix-ci 2025-08-19 18:09:43 -07:00
scripts gomod: run go mod tidy for all modules 2024-01-15 17:22:42 +08:00
txscript txscript: add new ScriptTemplate DSL for writing Scripts 2025-07-11 12:20:05 -07:00
v2transport v2transport: fix module path 2025-06-06 15:33:49 -07:00
wire wire: optimize parsing for CFCheckpkt message, reduce allocs by 96% 2025-07-14 18:36:27 -07:00
.gitignore gitignore: exclude task management directory 2025-10-27 16:11:51 -07:00
.golangci.yml golangci: add configuration file for linting 2025-08-05 18:39:30 +09:00
btcd.go main: add flag to write execution traces 2024-11-20 17:50:51 +09:00
CHANGES fix typos (#2100) 2024-03-25 09:44:25 -04:00
config.go config+server: add feature flag to toggle between mempool implementations 2025-10-27 16:10:56 -07:00
config_test.go multi:use t.TempDir replace os.MkdirTemp 2025-03-07 16:54:47 +08:00
doc.go doc: correct comments 2023-12-20 11:41:55 -05:00
Dockerfile Dockerfile: update go base image 2025-08-20 10:29:16 +09:00
go.mod deps+log: upgrade to btclog/v2 with dual logger support 2025-10-27 16:10:29 -07:00
go.sum deps+log: upgrade to btclog/v2 with dual logger support 2025-10-27 16:10:29 -07:00
LICENSE Update license 2025-01-14 19:58:46 -08:00
log.go deps+log: upgrade to btclog/v2 with dual logger support 2025-10-27 16:10:29 -07:00
Makefile Makefile+workflows: fallback to GOPATH/bin on non-existent GOBIN 2025-08-20 16:02:15 +00:00
params.go btcd: add TestNet4 config param 2025-03-18 11:18:38 -05:00
README.md bump go mod versions 2025-02-10 16:37:15 +09:00
rpcadapters.go chore: fix some comments 2024-08-09 16:51:11 +08:00
rpcserver.go rpcserver: expose v2 connection status in getpeerinfo 2025-05-26 13:46:25 -07:00
rpcserver_test.go rpcserver+mempool: implement gettxspendingprevout for btcd 2024-02-27 22:58:33 +08:00
rpcserverhelp.go rpcserver: expose v2 connection status in getpeerinfo 2025-05-26 13:46:25 -07:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcwebsocket.go chore: fix some comments (#2146) 2024-03-27 09:45:48 -04:00
sample-btcd.conf config: add new --v2transport option to gate BIP 324 2025-05-26 13:46:25 -07:00
SECURITY.md btcd: add SECURITY.md 2023-12-30 16:24:59 -08:00
server.go server: wire up package validation in mempool v2 transaction acceptance 2025-10-28 16:47:28 -07:00
service_windows.go fix typos (#2100) 2024-03-25 09:44:25 -04: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 chore: fix some comments 2024-08-09 16:51:11 +08:00
version.go build: bump version to v0.24.2-beta 2024-06-20 15:35:00 -07: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.22 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.