mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 00:37:57 +00:00
Wei Tang
a5b2e7786e
* pow: fix docs on mining worker * typo: miner -> mining * Switch to proper Rust intra-doc link
25 lines
1.2 KiB
Markdown
25 lines
1.2 KiB
Markdown
Proof of work consensus for Substrate.
|
|
|
|
To use this engine, you can need to have a struct that implements
|
|
`PowAlgorithm`. After that, pass an instance of the struct, along
|
|
with other necessary client references to `import_queue` to setup
|
|
the queue.
|
|
|
|
This library also comes with an async mining worker, which can be
|
|
started via the `start_mining_worker` function. It returns a worker
|
|
handle together with a future. The future must be pulled. Through
|
|
the worker handle, you can pull the metadata needed to start the
|
|
mining process via `MiningWorker::metadata`, and then do the actual
|
|
mining on a standalone thread. Finally, when a seal is found, call
|
|
`MiningWorker::submit` to build the block.
|
|
|
|
The auxiliary storage for PoW engine only stores the total difficulty.
|
|
For other storage requirements for particular PoW algorithm (such as
|
|
the actual difficulty for each particular blocks), you can take a client
|
|
reference in your `PowAlgorithm` implementation, and use a separate prefix
|
|
for the auxiliary storage. It is also possible to just use the runtime
|
|
as the storage, but it is not recommended as it won't work well with light
|
|
clients.
|
|
|
|
License: GPL-3.0-or-later WITH Classpath-exception-2.0
|