dcrd/blockchain/chaingen
Dave Collins 70b399c9e4
build: Add dupword linter.
This adds the dupword linter to the list of linters and addresses a few
false positives it complains about.
2023-08-25 12:35:55 -05:00
..
doc.go multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
example_test.go blockchain: Start v5 module dev cycle. 2022-03-24 12:44:05 -05:00
generator.go build: Add dupword linter. 2023-08-25 12:35:55 -05:00
README.md docs: Update for blockchain v5 module. 2023-06-08 14:28:23 -05:00

chaingen

Build Status ISC License Doc

Package chaingen provides facilities for generating a full chain of blocks.

Overview

Many consensus-related tests require a full chain of valid blocks with several pieces of contextual information such as versions and votes. Generating such a chain is not a trivial task due to things such as the fact that tickets must be purchased (at the correct ticket price), the appropriate winning votes must be cast (which implies keeping track of all live tickets and implementing the lottery selection algorithm), and all of the state-specific header fields such as the pool size and the proof-of-work and proof-of-stake difficulties must be set properly.

In order to simplify this complex process, this package provides a generator that keeps track of all of the necessary state and generates and solves blocks accordingly while allowing the caller to manipulate the blocks via munge functions.

Examples

  • Basic Usage Example
    Demonstrates creating a new generator instance and using it to generate the required first block and enough blocks to have mature coinbase outputs to work with along with asserting the generator state along the way.

Installation and Updating

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

License

Package chaingen is licensed under the copyfree ISC License.