dcrd/blockchain
Dave Collins ea1d3750ba
blockchain: Remove dry run flag.
This switches block template proposal checks over to use
CheckConnectBlock now that all of the core checks needed for block
templates is included there, and, more importantly, removes the the
BFDryRun flag since it was only used to test block template proposals
and it is much simpler to allow the main chain processing paths to run
without the complication of selectively processing code for dry run
behavior.
2018-02-24 12:53:05 -06:00
..
chaingen multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
fullblocktests blockchain: Combine ErrDoubleSpend & ErrMissingTx. 2018-02-21 14:01:05 -06:00
indexers multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
internal blockchain: Migrate to new block index and use it. 2018-02-22 13:57:23 -06:00
stake stake: optimize FindSpentTicketsInBlock slightly 2018-02-18 19:07:49 -06:00
testdata blockchain: Use chaingen for forced reorg tests. 2018-02-23 21:01:02 -06:00
accept.go blockchain: Remove dry run flag. 2018-02-24 12:53:05 -06:00
agendas_test.go blockchain: Switch to FindSpentTicketsInBlock. 2018-01-28 21:21:10 -06:00
bench_test.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
blockindex_test.go blockchain: Accept parent in blockNode constructor. 2018-02-18 20:45:22 -06:00
blockindex.go blockchain: Refactor block idx entry serialization. 2018-02-23 14:36:08 -06:00
blocklocator.go blockchain: Refactor main block index logic. 2018-01-30 13:21:57 -06:00
chain_test.go blockchain: Use chaingen for forced reorg tests. 2018-02-23 21:01:02 -06:00
chain.go blockchain: Remove dry run flag. 2018-02-24 12:53:05 -06:00
chainio_test.go blockchain: Refactor block idx entry serialization. 2018-02-23 14:36:08 -06:00
chainio.go blockchain: Refactor block idx entry serialization. 2018-02-23 14:36:08 -06:00
checkpoints.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
common_test.go blockchain: removed unused funcs and vars 2017-10-17 17:52:21 -05:00
compress_test.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
compress.go blockchain: Make func definition style consistent. 2018-01-27 21:55:49 -06:00
difficulty_test.go blockchain: Accept parent in blockNode constructor. 2018-02-18 20:45:22 -06:00
difficulty.go blockchain: Accept parent in blockNode constructor. 2018-02-18 20:45:22 -06:00
doc.go Initial Decred Commit. 2016-02-07 14:00:12 -05:00
error_test.go blockchain: Add block validation status to index. 2018-02-22 13:57:15 -06:00
error.go blockchain: Add block validation status to index. 2018-02-22 13:57:15 -06:00
example_test.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
fullblocks_test.go blockchain: Use hash values in structs. 2018-01-30 13:37:26 -06:00
fullblocksstakeversion_test.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
internal_test.go blockchain: Accept parent in blockNode constructor. 2018-02-18 20:45:22 -06:00
log.go all: Remove seelog logger. 2017-06-20 10:58:10 -04:00
mediantime_test.go multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
mediantime.go Initial Decred Commit. 2016-02-07 14:00:12 -05:00
merkle_test.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
merkle.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
notifications.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
process.go blockchain: Remove dry run flag. 2018-02-24 12:53:05 -06:00
prune.go chain: Remove memory block node pruning. 2017-09-18 13:43:48 -05:00
README.md multi: Update markdown in README files to match change in github parser. 2017-05-26 12:06:19 -04:00
scriptval.go blockchain: Combine ErrDoubleSpend & ErrMissingTx. 2018-02-21 14:01:05 -06:00
sequencelock_test.go blockchain: Refactor main block index logic. 2018-01-30 13:21:57 -06:00
sequencelock.go blockchain: Combine ErrDoubleSpend & ErrMissingTx. 2018-02-21 14:01:05 -06:00
stakeext.go blockchain: Refactor main block index logic. 2018-01-30 13:21:57 -06:00
stakenode.go blockchain: Calculate the lottery IV on demand. 2018-02-21 16:44:54 -06:00
stakeversion_test.go blockchain: Accept parent in blockNode constructor. 2018-02-18 20:45:22 -06:00
stakeversion.go blockchain: Refactor main block index logic. 2018-01-30 13:21:57 -06:00
subsidy_test.go multi: Upstream parameter abstraction sync 2016-11-16 19:34:01 -06:00
subsidy.go blockchain: Improve readability of parent approval. 2018-02-02 18:33:41 -06:00
thresholdstate_test.go Merge remaining dcrutil code into a dcrd package. 2017-10-11 22:06:36 -04:00
thresholdstate.go multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
timesorter_test.go blockchain: Don't store full header in block node. 2018-01-29 11:35:06 -06:00
timesorter.go blockchain: Don't store full header in block node. 2018-01-29 11:35:06 -06:00
upgrade.go blockchain: Refactor block idx entry serialization. 2018-02-23 14:36:08 -06:00
utxoviewpoint.go multi: fix some maligned linter warnings 2018-02-13 14:50:33 -06:00
validate_test.go blockchain: Remove superfluous test checks. 2018-02-24 02:58:27 -06:00
validate.go blockchain: Combine ErrDoubleSpend & ErrMissingTx. 2018-02-21 14:01:05 -06:00
votebits_test.go blockchain: Correct a few log statements. 2018-02-16 17:07:22 -06:00
votebits.go blockchain: Don't store full header in block node. 2018-01-29 11:35:06 -06:00

blockchain

Build Status ISC License GoDoc

Package blockchain implements decred 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 decred block chain.

Installation and Updating

$ go get -u github.com/decred/dcrd/blockchain

Decred 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 attempt 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 how to convert a target difficulty into the compact "bits" in a block header which represent that target difficulty.

License

Package blockchain is licensed under the copyfree ISC License.