lbcd/blockchain
Olaoluwa Osuntokun be191ca111
blockchain/indexers: fix bug in indexer re-org catch up
In this commit, we fix an existing bug in the re-org catch up logic for
the `IndexManager`. Before this commit, we would assign the block to the
_local_ scope rather than the outer scope. As a result, we would never
properly bisect the chain to find the fork point to be able to reconcile
the index state to the main chain only after a re-org occurs.

Fixes #1261
2018-08-22 19:46:27 -07:00
..
fullblocktests btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
indexers blockchain/indexers: fix bug in indexer re-org catch up 2018-08-22 19:46:27 -07:00
testdata multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
accept.go blockchain: Persist block status changes to disk. 2018-01-28 23:34:56 -06:00
bench_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
blockindex.go blockchain: Persist block status changes to disk. 2018-01-28 23:34:56 -06:00
chain.go blockchain: during fastAdd or if block wasn't already valid, mark as valid in index 2018-08-09 16:57:01 -07:00
chain_test.go blockchain: Implement IntervalBlockHashes method. 2018-05-23 16:46:15 -07:00
chainio.go blockchain: in initChainState mark ancestors of best tip as valid if not marked 2018-08-08 17:50:00 -07:00
chainio_test.go blockchain: publicly export spentTxOut and all attributes 2018-05-30 20:46:12 -07:00
chainview.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
chainview_test.go multi: correct all import paths 2018-05-23 16:46:15 -07:00
checkpoints.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
common_test.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
compress.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
compress_test.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
difficulty.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
difficulty_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
error.go blockchain: Track block validation status in block index. 2017-10-23 04:33:15 -05:00
error_test.go blockchain: Track block validation status in block index. 2017-10-23 04:33:15 -05:00
example_test.go blockchain: Fix typo in example_test.go. 2018-01-31 02:40:46 -06:00
fullblocks_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
mediantime.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mediantime_test.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
merkle.go BIP0141+blockchain: add functions for extracting and validating witness commitment 2017-08-13 23:17:40 -05:00
merkle_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
notifications.go blockchain: Consistency pass on subscribe code. 2017-08-15 11:12:56 -05:00
notifications_test.go multi: correct all import paths 2018-05-23 16:46:15 -07:00
process.go blockchain: Remove BFDryRun behaviour flag. 2017-10-12 06:07:46 -05:00
README.md blockchain: Fix typos in README.md. 2018-01-25 22:40:42 -06:00
scriptval.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
scriptval_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
thresholdstate.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
thresholdstate_test.go blockchain: Remove threshold state db cache. 2017-08-15 16:55:40 -05:00
timesorter.go blockchain: Use int64 timestamps in block nodes. 2017-01-31 17:51:29 -06:00
timesorter_test.go blockchain: Consolidate tests into package. 2017-08-19 23:05:17 -05:00
upgrade.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
upgrade_test.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05:00
utxoviewpoint.go blockchain: publicly export spentTxOut and all attributes 2018-05-30 20:46:12 -07:00
validate.go blockchain: publicly export spentTxOut and all attributes 2018-05-30 20:46:12 -07:00
validate_test.go blockchain: Remove BFDryRun behaviour flag. 2017-10-12 06:07:46 -05:00
versionbits.go blockchain: Refactor to use new chain view. 2017-08-23 23:43:37 -05:00
weight.go multi: Rework utxoset/view to use outpoints. 2018-05-27 03:07:41 -05: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.