dcrd/blockchain
Dave Collins ad02d8f300
multi: Go 1.19 doc comment formatting.
This modifies the entire repository to use the new formatting of doc
comments in the upcoming Go 1.19 release.

The primary motivating factors for this are:

- Builds check that files are formatted per gofmt and that will no
  longer be true as of Go 1.19 without these changes
- Separating all the updates into a single commit ensures these
  documentation only formatting changes do not clutter up diffs that
  actually change code

For the most part, the changes are just the automated changes suggested
by the Go 1.19 version of gofmt, but there are also a few cases where
the comments were reworded a bit to play nicely with the new formatting
requirements.

For example, the new version of gofmt reformats and collapses nested
lists where as the existing version does not.  Thus, instances of nested
lists have been changed to either eliminate them or use mixed markers
which produce expect results.
2022-07-30 04:08:58 -05:00
..
chaingen multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
fullblocktests fullblocktests: Decouple from blockchain. 2022-05-30 11:26:40 -05:00
stake multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
standalone multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
go.mod blockchain: Move package to internal. 2022-05-30 15:32:41 -05:00
go.sum blockchain: Move package to internal. 2022-05-30 15:32:41 -05:00
README.md blockchain: Move package to internal. 2022-05-30 15:32:41 -05:00

blockchain

Build Status ISC License Doc

The blockchain module provides a couple of packages useful for testing:

  • chaingen - Provides facilities for generating a full chain of blocks
  • fullblocktests - Provides a set of full block tests to be used for testing the consensus validation rules

Sub Modules

Note that the following separate sub modules that are not a part of the this module are also available:

  • standalone - Provides standalone functions useful for working with the Decred blockchain consensus rules.
  • stake - Contains code for all of dcrd's stake transaction chain handling and other portions related to the Proof-of-Stake (PoS) system.

Installation and Updating

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

License

Module blockchain is licensed under the copyfree ISC License.