dcrd/blockchain
Dave Collins 6c6da6df18
blockchain: Optimize chain tip tracking.
Part of adding nodes to the block index involves updating the current
chain tip in order to be able to efficiently keep track of all known
chain tips.

Since there can be multiple tips at a given height, the current code
uses a slice for each height to track them.  However, this is wasteful
since it is extremely rare for there to be more than one chain tip at
the same height.

It is particularly notable at startup since the block index has to load
up hundreds of thousands of nodes.

Given that, this modifies the chain tip tracking logic to avoid creating
a slice unless it is actually needed by making use of an entry with a
static field for the normal case and a dynamic slice for the case when
more than 1 tip for the height actually exists.

It also keeps a running sum of the total number of known chips for use
as a hint to further reduce allocations when serving up related data and
updates the chain tip tests to ensure 100% branch coverage is maintained.

The end result is that  this reduces the total number of allocs at
startup by around 1%, which results in faster startup, and also reduces
the overall memory usage by a few MB for nodes that have a long running
history of side chains.
2020-07-29 19:25:03 -05:00
..
chaingen docs: Fix chaingen broken markdown link. 2020-06-16 13:28:40 -05:00
fullblocktests secp256k1: Make private key opaque. 2020-02-18 23:17:55 -06:00
indexers indexers: Fix existsaddridx description. 2020-07-01 00:56:08 -05:00
internal/progresslog blockchain: Remove internal dbnamespace package. 2020-07-28 15:46:06 -05:00
stake multi: go mod tidy cleanup and run in CI. 2020-06-15 08:49:38 -05:00
standalone standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
testdata multi: Only use module-scoped data in tests. 2018-08-16 15:08:07 -05:00
accept.go blockchain: Support hdr checkpoints and simplify. 2019-12-27 19:18:55 -06:00
agendas_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -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: Optimize chain tip tracking. 2020-07-29 19:25:03 -05:00
chain_test.go blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
chain.go blockchain: Optimize chain tip tracking. 2020-07-29 19:25:03 -05:00
chainio_test.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
chainio.go blockchain: Remove internal dbnamespace package. 2020-07-28 15:46:06 -05:00
chainquery.go blockchain: Optimize chain tip tracking. 2020-07-29 19:25:03 -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 chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
common_test.go blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
compress_test.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
compress.go secp256k1: Start v3 module dev cycle. 2020-01-29 13:45:59 -06:00
difficulty_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
difficulty.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
doc.go multi: Decouple orphan handling from blockchain. 2019-12-05 21:38:29 -06:00
error_test.go multi: Decouple orphan handling from blockchain. 2019-12-05 21:38:29 -06:00
error.go blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
example_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
fullblocks_test.go blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
fullblocksstakeversion_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
go.mod standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
go.sum standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
headercmt_test.go multi: Implement header commitments and vote. 2019-10-12 12:06:02 -05:00
headercmt.go dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
log.go blockchain: Remove deprecated code. 2019-08-08 13:10:21 -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 dcrutil: Start v3 module dev cycle. 2019-10-24 19:13:26 -05:00
process_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
process.go blockchain: Remove easiest diff checkpoint checks. 2019-12-05 21:43:39 -06:00
prune.go blockchain: Optimize stake node pruning. 2020-07-27 12:21:46 -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 chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
sequencelock.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
stakeext.go rpcserver: Create Chain and UtxoEntry interfaces. 2020-06-15 01:56:43 -05: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 blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
subsidy.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
thresholdstate_test.go chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
thresholdstate.go rpcserver: Create Chain and UtxoEntry interfaces. 2020-06-15 01:56:43 -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
upgrade.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05:00
utxoviewpoint_test.go blockchain: Correct mempool view construction. 2020-06-26 20:57:59 -05:00
utxoviewpoint.go blockchain: Correct mempool view construction. 2020-06-26 20:57:59 -05:00
validate_test.go blockchain: Use errors api and require go 1.13+. 2020-03-11 12:27:40 -05:00
validate.go standalone: Start v2 module dev cycle 2020-06-11 15:48:38 -05: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.