pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-19 00:41:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

pow: fix docs on mining worker (#8759)

Browse Source 
* pow: fix docs on mining worker

* typo: miner -> mining

* Switch to proper Rust intra-doc link
This commit is contained in:
Wei Tang
2021-05-11 13:25:50 +02:00
committed by GitHub
parent d443a0b929
commit a5b2e7786e
2 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/client/consensus/pow/README.md
+10 -2
View File
@@ -3,7 +3,15 @@ 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. Use the `start_mine` function for basic CPU mining.
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
@@ -13,4 +21,4 @@ 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
License: GPL-3.0-or-later WITH Classpath-exception-2.0