mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-21 01:41:03 +00:00
Markdown linter (#1309)
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
This commit is contained in:
@@ -1,25 +1,27 @@
|
||||
# DO NOT USE IN PRODUCTION
|
||||
|
||||
The produced values do not fulfill the cryptographic requirements for random numbers. Should not be used for high-stake production use-cases.
|
||||
The produced values do not fulfill the cryptographic requirements for random numbers. Should not be used for high-stake
|
||||
production use-cases.
|
||||
|
||||
# Randomness Module
|
||||
|
||||
The Randomness Collective Flip module provides a [`random`](https://docs.rs/pallet-insecure-randomness-collective-flip/latest/pallet_insecure_randomness_collective_flip/struct.Module.html#method.random)
|
||||
function that generates low-influence random values based on the block hashes from the previous
|
||||
`81` blocks. Low-influence randomness can be useful when defending against relatively weak
|
||||
adversaries. Using this pallet as a randomness source is advisable primarily in low-security
|
||||
situations like testing.
|
||||
The Randomness Collective Flip module provides a
|
||||
[`random`](https://docs.rs/pallet-insecure-randomness-collective-flip/latest/pallet_insecure_randomness_collective_flip/struct.Module.html#method.random)
|
||||
function that generates low-influence random values based on the block hashes from the previous `81` blocks.
|
||||
Low-influence randomness can be useful when defending against relatively weak adversaries. Using this pallet as a
|
||||
randomness source is advisable primarily in low-security situations like testing.
|
||||
|
||||
## Public Functions
|
||||
|
||||
See the [`Module`](https://docs.rs/pallet-insecure-randomness-collective-flip/latest/pallet_insecure_randomness_collective_flip/struct.Module.html) struct for details of publicly available functions.
|
||||
See the
|
||||
[`Module`](https://docs.rs/pallet-insecure-randomness-collective-flip/latest/pallet_insecure_randomness_collective_flip/struct.Module.html)
|
||||
struct for details of publicly available functions.
|
||||
|
||||
## Usage
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Import the Randomness Collective Flip module and derive your module's configuration trait from
|
||||
the system trait.
|
||||
Import the Randomness Collective Flip module and derive your module's configuration trait from the system trait.
|
||||
|
||||
### Example - Get random seed for the current block
|
||||
|
||||
|
||||
Reference in New Issue
Block a user