dcrd/blockchain
Dave Collins f5e253f41a
blockchain: Remove unused error returns.
This removes the error returns from calcNextRequiredDifficulty and
calcNextRequiredStakeDifficultyV2 since they no longer return any
errors.

It also updates all the caller and tests accordingly.
2020-12-07 18:32:27 -06:00
..
chaingen multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
fullblocktests blockchain: Move sigop-related contextual checks. 2020-12-05 20:02:22 -06:00
indexers multi: Start gcs v3 module dev cycle. 2020-11-10 16:51:38 -06:00
internal/progresslog blockchain: Remove internal dbnamespace package. 2020-07-28 15:46:06 -05:00
stake blockchain: Move {coin,trsy}base contextual checks. 2020-12-05 20:02:21 -06:00
standalone blockchain/standalone: Prepare v2.0.0. 2020-09-30 11:23:35 -05:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
accept.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
agendas_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
bench_test.go blockchain: Use skip list for ancestor traversal. 2019-11-23 04:17:55 -06:00
blockindex_test.go blockchain: Optimize chain tip tracking. 2020-07-29 19:25:03 -05:00
blockindex.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
chain_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
chain.go blockchain: Convert to LRU block cache. 2020-12-07 18:30:12 -06:00
chainio_test.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
chainio.go blockchain: Convert to LRU block cache. 2020-12-07 18:30:12 -06:00
chainquery.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05: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 multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
common_test.go blockchain: Convert to LRU block cache. 2020-12-07 18:30:12 -06:00
compress_test.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
compress.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
difficulty_test.go blockchain: Remove unused error returns. 2020-12-07 18:32:27 -06:00
difficulty.go blockchain: Remove unused error returns. 2020-12-07 18:32:27 -06:00
doc.go multi: Decouple orphan handling from blockchain. 2019-12-05 21:38:29 -06:00
error_test.go blockchain: Consolidate no treasury bal errors. 2020-12-07 17:45:13 -06:00
error.go blockchain: Consolidate no treasury bal errors. 2020-12-07 17:45:13 -06:00
example_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
fullblocks_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
fullblocksstakeversion_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
go.mod blockchain: Convert to LRU block cache. 2020-12-07 18:30:12 -06:00
go.sum multi: Start gcs v3 module dev cycle. 2020-11-10 16:51:38 -06:00
headercmt_test.go multi: Implement header commitments and vote. 2019-10-12 12:06:02 -05:00
headercmt.go blockchain: Consolidate no filter errors. 2020-12-07 17:45:05 -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: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
process_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
process.go blockchain: Make CheckBlockSanity context free. 2020-12-05 20:02:22 -06:00
prune.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
README.md multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
scriptval.go blockchain: replace scriptval quit channel with context 2019-10-30 20:21:48 -05:00
sequencelock_test.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
sequencelock.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
stakeext.go blockchain: Consolidate unknown block errors. 2020-12-07 17:42:58 -06:00
stakenode.go stake: Start v3 module dev cycle. 2019-10-24 22:10:39 -05:00
stakeversion_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
stakeversion.go mining: Move block chain functions to Config. 2020-10-23 05:54:23 -05:00
subsidy.go multi: Add decentralized treasury support. 2020-09-21 12:15:31 -05:00
thresholdstate_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
thresholdstate.go blockchain: Consolidate unknown block errors. 2020-12-07 17:42:58 -06: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 LRU block cache. 2020-12-07 18:30:12 -06:00
treasury.go blockchain: Consolidate no treasury bal errors. 2020-12-07 17:45:13 -06:00
upgrade_test.go blockchain: Migration for v3 block index. 2020-08-06 09:46:13 -05:00
upgrade.go blockchain: Use new batch logic for clr failed. 2020-11-30 12:00:19 -06:00
utxoviewpoint_test.go multi: Start blockchain v4 module dev cycle. 2020-11-10 16:51:38 -06:00
utxoviewpoint.go blockchain: Prepare v3.0.0. 2020-10-15 15:33:44 -05:00
validate_test.go blockchain: Context free CheckTransactionSanity. 2020-12-05 20:02:23 -06:00
validate.go blockchain: Remove unused error returns. 2020-12-07 18:32:27 -06:00
votebits_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -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 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
  • 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.

License

Package blockchain is licensed under the copyfree ISC License.