7d59dd3b69
This bumps the go directive for all of the modules provided by the repository to 1.17 which will allow the new module graph pruning and lazy loading capabilities introduced in Go 1.17 to be used once the updated modules are released. This means that, as described by the documentation, the go.mod files for each module now include a separate require block that includes all of the indirect dependencies |
||
|---|---|---|
| .. | ||
| bench_test.go | ||
| doc.go | ||
| error_test.go | ||
| error.go | ||
| example_test.go | ||
| go.mod | ||
| go.sum | ||
| inclusionproof_test.go | ||
| inclusionproof.go | ||
| merkle_test.go | ||
| merkle.go | ||
| pow_test.go | ||
| pow.go | ||
| README.md | ||
| subsidy_test.go | ||
| subsidy.go | ||
| treasury_test.go | ||
| treasury.go | ||
| tx_test.go | ||
| tx.go | ||
standalone
Package standalone provides standalone functions useful for working with the Decred blockchain consensus rules.
The primary goal of offering these functions via a separate module is to reduce the required dependencies to a minimum as compared to the blockchain module.
It is ideal for applications such as lightweight clients that need to ensure basic security properties hold and calculate appropriate vote subsidies and block explorers.
For example, some things an SPV wallet needs to prove are that the block headers all connect together, that they satisfy the proof of work requirements, and that a given transaction tree is valid for a given header.
The provided functions fall into the following categories:
- Proof-of-work
- Converting to and from the compact target difficulty representation
- Calculating work values based on the compact target difficulty
- Checking a block hash satisfies a target difficulty and that target difficulty is within a valid range
- Merkle root calculation
- Calculation from individual leaf hashes
- Calculation from a slice of transactions
- Subsidy calculation
- Proof-of-work subsidy for a given height and number of votes
- Stake vote subsidy for a given height
- Treasury subsidy for a given height and number of votes
- Coinbase transaction identification
Installation and Updating
This package is part of the github.com/decred/dcrd/blockchain/standalone/v2
module. Use the standard go tooling for working with modules to incorporate it.
Examples
-
CompactToBig Example Demonstrates how to convert the compact "bits" in a block header which represent the target difficulty to a big integer and display it using the typical hex notation.
-
BigToCompact Example Demonstrates how to convert a target difficulty into the compact "bits" in a block header which represent that target difficulty.
-
CheckProofOfWork Example Demonstrates checking the proof of work of a block hash against a target difficulty.
-
CalcMerkleRoot Example Demonstrates calculating a merkle root from a slice of leaf hashes.
License
Package standalone is licensed under the copyfree ISC License.