btcd/blockchain
Olaoluwa Osuntokun e781b66e2f
txscript: implement BIP 341+342 segwit v1 taproot+tapscript
In this commit, we implement the new BIP 341+342 taproot sighash digest
computation. The digest is similar, but re-orders some fragments and
also starts to commit to the input values of all the transactions in the
SIGHASH_ALL case. A new implicit sighash flag, SIGHASH_DEFAULT has been
added that allows signatures to always be 64-bytes for the common case.

The hashcache has been updated as well to store both the v0 and v1 mid
state hashes. The v0 hashes are a double-sha of the contents, while the
v1 hash is a single sha. As a result, if a transaction spends both v0
and v1 inputs, then we 're able to re-use all the intermediate hashes.

As the sighash computation needs the input values and scripts, we create
an abstraction: the PrevOutFetcher to give the caller flexibility w.r.t
how this is done. We also create a `CannedPrevOutputFetcher` that holds
the information in a map for a single input.

A series of function options are also added to allow re-use of the same
base sig hash calculation for both BIP 341 and 342.
2022-03-15 18:22:43 -07:00
..
fullblocktests multi: switch project over to using btcec/v2 2022-01-26 16:10:17 -08:00
indexers multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
testdata multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
accept.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
bench_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
blockindex.go blockchain: Persist block status changes to disk. 2018-01-28 23:34:56 -06:00
chain_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
chain.go blockchain: update version bits logic to use HasStarted/HasEnded for deployments 2022-01-25 15:27:40 -08:00
chainio_test.go blockchain: publicly export spentTxOut and all attributes 2018-05-30 20:46:12 -07:00
chainio.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
chainview_test.go multi: correct all import paths 2018-05-23 16:46:15 -07:00
chainview.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
checkpoints.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
common_test.go blockchain: update version bits logic to use HasStarted/HasEnded for deployments 2022-01-25 15:27:40 -08:00
compress_test.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
compress.go multi: switch project over to using btcec/v2 2022-01-26 16:10:17 -08:00
difficulty_test.go build: clean linter warnings 2020-05-13 08:58:39 -04:00
difficulty.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
error_test.go blockchain: Track block validation status in block index. 2017-10-23 04:33:15 -05:00
error.go blockchain: Track block validation status in block index. 2017-10-23 04:33:15 -05:00
example_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
fullblocks_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
mediantime_test.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
mediantime.go netsync+blockchain: fix typos 2019-01-08 20:07:09 -08:00
merkle_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
merkle.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
notifications_test.go multi: correct all import paths 2018-05-23 16:46:15 -07:00
notifications.go blockchain: Consistency pass on subscribe code. 2017-08-15 11:12:56 -05:00
process.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
README.md docs: update shields 2021-03-05 07:45:19 -05:00
scriptval_test.go removed unnecessary GOMAXPROCS function calls 2020-09-14 09:57:30 -04:00
scriptval.go txscript: implement BIP 341+342 segwit v1 taproot+tapscript 2022-03-15 18:22:43 -07:00
thresholdstate_test.go blockchain: refactor new thresholdState method, test BIP9 transitions 2022-01-25 15:27:48 -08:00
thresholdstate.go blockchain: refactor new thresholdState method, test BIP9 transitions 2022-01-25 15:27:48 -08:00
timesorter_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
timesorter.go blockchain: Use int64 timestamps in block nodes. 2017-01-31 17:51:29 -06:00
upgrade_test.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
upgrade.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
utxoviewpoint.go txscript: implement BIP 341+342 segwit v1 taproot+tapscript 2022-03-15 18:22:43 -07:00
validate_test.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
validate.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
versionbits.go blockchain+integration: add support for min activation height and custom thresholds 2022-01-25 15:27:46 -08:00
weight.go multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00

blockchain

Build Status ISC License GoDoc

Package blockchain implements bitcoin block handling and chain selection rules. The test coverage is currently only around 60%, but will be increasing over time. See test_coverage.txt for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report. Package blockchain is licensed under the liberal ISC license.

There is an associated blog post about the release of this package here.

This package has intentionally been designed so it can be used as a standalone package for any projects needing to handle processing of blocks into the bitcoin block chain.

Installation and Updating

$ go get -u github.com/btcsuite/btcd/blockchain

Bitcoin Chain Processing Overview

Before a block is allowed into the block chain, it must go through an intensive series of validation rules. The following list serves as a general outline of those rules to provide some intuition into what is going on under the hood, but is by no means exhaustive:

  • Reject duplicate blocks
  • Perform a series of sanity checks on the block and its transactions such as verifying proof of work, timestamps, number and character of transactions, transaction amounts, script complexity, and merkle root calculations
  • Compare the block against predetermined checkpoints for expected timestamps and difficulty based on elapsed time since the checkpoint
  • Save the most recent orphan blocks for a limited time in case their parent blocks become available
  • Stop processing if the block is an orphan as the rest of the processing depends on the block's position within the block chain
  • Perform a series of more thorough checks that depend on the block's position within the block chain such as verifying block difficulties adhere to difficulty retarget rules, timestamps are after the median of the last several blocks, all transactions are finalized, checkpoint blocks match, and block versions are in line with the previous blocks
  • Determine how the block fits into the chain and perform different actions accordingly in order to ensure any side chains which have higher difficulty than the main chain become the new main chain
  • When a block is being connected to the main chain (either through reorganization of a side chain to the main chain or just extending the main chain), perform further checks on the block's transactions such as verifying transaction duplicates, script complexity for the combination of connected scripts, coinbase maturity, double spends, and connected transaction values
  • Run the transaction scripts to verify the spender is allowed to spend the coins
  • Insert the block into the block database

Examples

  • ProcessBlock Example
    Demonstrates how to create a new chain instance and use ProcessBlock to attempt to add a block to the chain. This example intentionally attempts to insert a duplicate genesis block to illustrate how an invalid block is handled.

  • CompactToBig Example
    Demonstrates how to convert the compact "bits" in a block header which represent the target difficulty to a big integer and display it using the typical hex notation.

  • BigToCompact Example
    Demonstrates how to convert a target difficulty into the compact "bits" in a block header which represent that target difficulty.

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

Package blockchain is licensed under the copyfree ISC License.