dcrd/blockchain
Ryan Staudt 73d1b5f7de multi: Migrate to UTXO database.
This migrates the UTXO set and state from the block database to the new
UTXO database.  The benefit of doing this is that it will allow the
reading and writing to the UTXO set in the database to be optimized
specifically for use with the UTXO set.

An overview of the changes is as follows:

- Introduce upgrade code to migrate UTXO data from the block database to
  the new UTXO database
- Update all references to use the UTXO database rather than the block
  database where appropriate
2021-04-28 10:27:55 -05:00
..
chaingen chaingen: Remove unused PurchaseCommitmentScript. 2021-04-09 13:39:17 -05:00
fullblocktests blockchain: Convert to use new stdaddr package. 2021-04-09 13:39:17 -05:00
indexers txscript: Convert to use new stdaddr package. 2021-04-12 01:38:08 -05:00
internal/progresslog blockchain: Remove internal dbnamespace package. 2020-07-28 15:46:06 -05:00
stake dcrutil: Convert to use new stdaddr package. 2021-04-15 16:58:25 -05:00
standalone multi: Update README.md files for go modules. 2021-01-22 14:39:23 -06:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
agendas_test.go blockchain: Simplify TestFixedSequenceLocks. 2021-01-02 12:47:40 -06:00
bench_test.go blockchain: Use skip list for ancestor traversal. 2019-11-23 04:17:55 -06:00
blockindex_test.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
blockindex.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
chain_test.go blockchain: Convert to use new stdaddr package. 2021-04-09 13:39:17 -05:00
chain.go blockchain: Decouple stxo and utxo migrations. 2021-04-28 10:27:55 -05:00
chainio_test.go blockchain: Move UTXO DB tests to separate file. 2021-04-28 10:27:55 -05:00
chainio.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
chainquery.go multi: Add chain verify progress percentage. 2021-01-21 23:30:35 -06:00
chainview_test.go blockchain: removed unused params 2019-10-28 11:49:54 -05:00
chainview.go blockchain: Use skip list for ancestor traversal. 2019-11-23 04:17:55 -06:00
checkpoints.go netsync: Add header sync progress log. 2021-01-21 23:30:33 -06:00
common_test.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
compress_test.go blockchain: Remove compression version param. 2021-01-14 22:21:35 -06:00
compress.go blockchain: Remove compression version param. 2021-01-14 22:21:35 -06:00
difficulty_test.go blockchain: Remove unused error returns. 2020-12-07 18:32:27 -06:00
difficulty.go blockchain: Explicit hash in estimate stake diff. 2021-01-07 10:57:58 -06:00
doc.go blockchain: Update README.md and doc.go. 2021-01-07 10:44:25 -06:00
error_test.go multi: Rework utxoset/view to use outpoints. 2021-01-14 17:25:06 -06:00
error.go multi: Rework utxoset/view to use outpoints. 2021-01-14 17:25:06 -06:00
example_test.go multi: Add UtxoCache. 2021-02-22 12:16:31 -06:00
fullblocks_test.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
fullblocksstakeversion_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
go.mod blockchain: Prerel module release ver updates. 2021-04-15 17:59:37 -05:00
go.sum multi: Update to siphash v1.2.2. 2021-01-30 18:32:35 -06:00
headercmt_test.go multi: Implement header commitments and vote. 2019-10-12 12:06:02 -05:00
headercmt.go multi: Add UtxoCache. 2021-02-22 12:16:31 -06:00
log.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
mediantime_test.go blockchain: Consolidate tests into the main package. 2018-02-25 19:01:57 -06:00
mediantime.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
notifications.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
process_test.go multi: Fix various typos. 2021-03-01 10:57:51 -06:00
process.go blockchain: Add invalidate/reconsider infrastruct. 2021-01-07 17:48:11 -06:00
prune.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
README.md multi: Update README.md files for go modules. 2021-01-22 14:39:23 -06:00
scriptval.go multi: Rework utxoset/view to use outpoints. 2021-01-14 17:25:06 -06:00
sequencelock_test.go multi: Add UtxoCache. 2021-02-22 12:16:31 -06:00
sequencelock.go multi: Rework utxoset/view to use outpoints. 2021-01-14 17:25:06 -06:00
stakeext.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
stakenode.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
stakeversion_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
stakeversion.go blockchain: Decouple processing and download logic. 2021-01-07 10:43:49 -06:00
subsidy.go multi: Start dcrutil v4 module dev cycle. 2020-12-16 16:30:24 -06:00
thresholdstate_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
thresholdstate.go blockchain: Trsy always inactive for genesis blk. 2021-04-22 12:26:12 -05:00
timesorter_test.go blockchain: Consolidate tests into the main package. 2018-02-25 19:01:57 -06:00
timesorter.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
treasury_test.go blockchain: Convert to use new stdaddr package. 2021-04-09 13:39:17 -05:00
treasury.go multi: Fix various typos. 2021-03-01 10:57:51 -06:00
upgrade_test.go blockchain: Whitelist DCP0005 violations. 2020-12-30 16:55:33 -06:00
upgrade.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
utxocache_test.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
utxocache.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
utxodb.go multi: Introduce UTXO database. 2021-04-28 10:27:55 -05:00
utxoentry_test.go blockchain: Add size method to UtxoEntry. 2021-02-22 12:16:31 -06:00
utxoentry.go blockchain: Add size method to UtxoEntry. 2021-02-22 12:16:31 -06:00
utxoio_test.go blockchain: Add utxoDatabaseInfo. 2021-04-28 10:27:55 -05:00
utxoio.go blockchain: Decouple stxo and utxo migrations. 2021-04-28 10:27:55 -05:00
utxoviewpoint_test.go blockchain: Use ReplaceVoteBits in utxoview tests. 2021-01-18 13:12:44 -06:00
utxoviewpoint.go blockchain: Add UtxoCacher interface. 2021-03-01 10:59:27 -06:00
validate_test.go multi: Migrate to UTXO database. 2021-04-28 10:27:55 -05:00
validate.go blockchain: Use agenda flags for tx check context. 2021-04-27 05:33:24 -05:00
votebits_test.go multi: Start blockchain/stake v4 module dev cycle. 2020-12-16 16:30:24 -06:00
votebits.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00

blockchain

Build Status ISC License Doc

Package blockchain implements Decred block handling and chain selection rules.

The Decred block handling and chain selection rules are an integral, and quite likely the most important, part of Decred. At its core, Decred is a distributed consensus of which blocks are valid and which ones will comprise the main block chain (public ledger) that ultimately determines accepted transactions, so it is extremely important that fully validating nodes agree on all rules.

At a high level, this package provides support for inserting new blocks into the block chain according to the aforementioned rules. It includes functionality such as rejecting duplicate blocks, ensuring blocks and transactions follow all rules, and best chain selection along with reorganization.

Since this package does not deal with other Decred specifics such as network communication or wallets, it provides a notification system which gives the caller a high level of flexibility in how they want to react to certain events such as newly connected main chain blocks which might result in wallet updates.

A comprehensive suite of tests is provided to ensure proper functionality.

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

Processing Order

This package supports headers-first semantics such that block data can be processed out of order so long as the associated header is already known.

The headers themselves, however, must be processed in the correct order since headers that do not properly connect are rejected. In other words, orphan headers are not allowed.

The processing code always maintains the best chain as the branch tip that has the most cumulative proof of work, so it is important to keep that in mind when considering errors returned from processing blocks.

Notably, due to the ability to process blocks out of order, and the fact blocks can only be fully validated once all of their ancestors have the block data available, it is to be expected that no error is returned immediately for blocks that are valid enough to make it to the point they require the remaining ancestor block data to be fully validated even though they might ultimately end up failing validation. Similarly, because the data for a block becoming available makes any of its direct descendants that already have their data available eligible for validation, an error being returned does not necessarily mean the block being processed is the one that failed validation.

Installation and Updating

This package is part of the github.com/decred/dcrd/blockchain/v3 module. Use the standard go tooling for working with modules to incorporate it.

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.

License

Package blockchain is licensed under the copyfree ISC License.