Expand description
§Stratum V2 Mining Protocol Messages Crate
mining_sv2 is a Rust crate that implements a set of messages defined in the Mining protocol
of Stratum V2.
The Mining protocol enables the distribution of work to mining devices and the submission of proof-of-work results.
For further information about the messages, please refer to Stratum V2 documentation - Mining.
§Build Options
This crate can be built with the following features:
§Usage
To include this crate in your project, run:
$ cargo add mining_sv2For further information about the mining protocol, please refer to Stratum V2 documentation - Mining Protocol.
Structs§
- Close
Channel - Message used by a downstream to close a mining channel.
- NewExtended
Mining Job - Message used by an upstream to provide an updated mining job to the downstream through Extended or Group Channel only.
- NewMining
Job - Message used by an upstream to provide an updated mining job to downstream.
- Open
Extended Mining Channel - Message used by a downstream to request opening an Extended Channel with an upstream role.
- Open
Extended Mining Channel Success - Message used by upstream to accept [
OpenExtendedMiningChannelrequest from downstream. - Open
Mining Channel Error - Message used by upstream to reject
OpenExtendedMiningChannelor [OpenStandardMiningchannel] request from downstream. - Open
Standard Mining Channel - Message used by a downstream to request opening a Standard Channel.
- Open
Standard Mining Channel Success - Message used by upstream to accept
OpenStandardMiningChannelrequest from downstream. - SetCustom
Mining Job - Message used by downstream role to set a custom job to an upstream (Pool).
- SetCustom
Mining JobError - Message used by upstream to reject
SetCustomMiningJobrequest. - SetCustom
Mining JobSuccess - Message used by upstream to accept
SetCustomMiningJobrequest. - SetExtranonce
Prefix - Message used by upstream to change downstream node’s extranonce prefix.
- SetGroup
Channel - Message used by upstream to associate a set of Standard Channel(s) to a Group Channel.
- SetNew
Prev Hash - Message used by upstream to share or distribute the latest block hash.
- SetTarget
- Message used by upstream to control the downstream submission rate by adjusting the difficulty target on a specified channel.
- Submit
Shares Error - Message used by upstream to reject
SubmitSharesStandardorSubmitSharesExtended. - Submit
Shares Extended - Message used by downstream to send result of its hashing work to an upstream.
- Submit
Shares Standard - Message used by downstream to send result of its hashing work to an upstream.
- Submit
Shares Success - Message used by upstream to accept
SubmitSharesStandardorSubmitSharesExtended. - Update
Channel - Message used by downstream to notify an upstream about changes on a specified channel.
- Update
Channel Error - Message used by upstream to notify downstream about an error in the
UpdateChannelmessage.
Constants§
- CHANNEL_
BIT_ CLOSE_ CHANNEL - CHANNEL_
BIT_ MINING_ SET_ NEW_ PREV_ HASH - CHANNEL_
BIT_ NEW_ EXTENDED_ MINING_ JOB - CHANNEL_
BIT_ NEW_ MINING_ JOB - CHANNEL_
BIT_ OPEN_ EXTENDED_ MINING_ CHANNEL - CHANNEL_
BIT_ OPEN_ EXTENDED_ MINING_ CHANNEL_ SUCCESS - CHANNEL_
BIT_ OPEN_ MINING_ CHANNEL_ ERROR - CHANNEL_
BIT_ OPEN_ STANDARD_ MINING_ CHANNEL - CHANNEL_
BIT_ OPEN_ STANDARD_ MINING_ CHANNEL_ SUCCESS - CHANNEL_
BIT_ SET_ CUSTOM_ MINING_ JOB - CHANNEL_
BIT_ SET_ CUSTOM_ MINING_ JOB_ ERROR - CHANNEL_
BIT_ SET_ CUSTOM_ MINING_ JOB_ SUCCESS - CHANNEL_
BIT_ SET_ EXTRANONCE_ PREFIX - CHANNEL_
BIT_ SET_ GROUP_ CHANNEL - CHANNEL_
BIT_ SET_ TARGET - CHANNEL_
BIT_ SUBMIT_ SHARES_ ERROR - CHANNEL_
BIT_ SUBMIT_ SHARES_ EXTENDED - CHANNEL_
BIT_ SUBMIT_ SHARES_ STANDARD - CHANNEL_
BIT_ SUBMIT_ SHARES_ SUCCESS - CHANNEL_
BIT_ UPDATE_ CHANNEL - CHANNEL_
BIT_ UPDATE_ CHANNEL_ ERROR - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ EXTENDED_ CHANNELS_ NOT_ SUPPORTED_ FOR_ STANDARD_ JOBS - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ INVALID_ NOMINAL_ HASHRATE - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ INVALID_ USER_ IDENTITY - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ MAX_ TARGET_ OUT_ OF_ RANGE - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ MIN_ EXTRANONCE_ SIZE_ TOO_ LARGE - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ STANDARD_ CHANNELS_ NOT_ SUPPORTED_ FOR_ CUSTOM_ WORK - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ UNKNOWN_ USER - ERROR_
CODE_ OPEN_ MINING_ CHANNEL_ UNSUPPORTED_ MIN_ EXTRANONCE_ SIZE - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ CHANNEL_ ID - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ PREFIX - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ TX - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ TX_ INPUT_ N_ SEQUENCE - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ TX_ LOCKTIME - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ TX_ OUTPUTS - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ COINBASE_ TX_ VERSION - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ MERKLE_ PATH - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ MINING_ JOB_ TOKEN - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ MIN_ NTIME - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ NBITS - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ INVALID_ VERSION - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ JD_ NOT_ SUPPORTED - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ JOB_ NOT_ YET_ VALIDATED - ERROR_
CODE_ SET_ CUSTOM_ MINING_ JOB_ STALE_ CHAIN_ TIP - ERROR_
CODE_ SUBMIT_ SHARES_ BAD_ EXTRANONCE_ SIZE - ERROR_
CODE_ SUBMIT_ SHARES_ DIFFICULTY_ TOO_ LOW - ERROR_
CODE_ SUBMIT_ SHARES_ DUPLICATE_ SHARE - ERROR_
CODE_ SUBMIT_ SHARES_ INVALID_ CHANNEL_ ID - ERROR_
CODE_ SUBMIT_ SHARES_ INVALID_ JOB_ ID - ERROR_
CODE_ SUBMIT_ SHARES_ INVALID_ SHARE - ERROR_
CODE_ SUBMIT_ SHARES_ STALE_ SHARE - ERROR_
CODE_ UPDATE_ CHANNEL_ INVALID_ CHANNEL_ ID - ERROR_
CODE_ UPDATE_ CHANNEL_ INVALID_ NOMINAL_ HASHRATE - ERROR_
CODE_ VERSION_ ROLLING_ NOT_ ALLOWED - MESSAGE_
TYPE_ CLOSE_ CHANNEL - MESSAGE_
TYPE_ MINING_ SET_ NEW_ PREV_ HASH - MESSAGE_
TYPE_ NEW_ EXTENDED_ MINING_ JOB - MESSAGE_
TYPE_ NEW_ MINING_ JOB - MESSAGE_
TYPE_ OPEN_ EXTENDED_ MINING_ CHANNEL - MESSAGE_
TYPE_ OPEN_ EXTENDED_ MINING_ CHANNEL_ SUCCESS - MESSAGE_
TYPE_ OPEN_ MINING_ CHANNEL_ ERROR - MESSAGE_
TYPE_ OPEN_ STANDARD_ MINING_ CHANNEL - MESSAGE_
TYPE_ OPEN_ STANDARD_ MINING_ CHANNEL_ SUCCESS - MESSAGE_
TYPE_ SET_ CUSTOM_ MINING_ JOB - MESSAGE_
TYPE_ SET_ CUSTOM_ MINING_ JOB_ ERROR - MESSAGE_
TYPE_ SET_ CUSTOM_ MINING_ JOB_ SUCCESS - MESSAGE_
TYPE_ SET_ EXTRANONCE_ PREFIX - MESSAGE_
TYPE_ SET_ GROUP_ CHANNEL - MESSAGE_
TYPE_ SET_ TARGET - MESSAGE_
TYPE_ SUBMIT_ SHARES_ ERROR - MESSAGE_
TYPE_ SUBMIT_ SHARES_ EXTENDED - MESSAGE_
TYPE_ SUBMIT_ SHARES_ STANDARD - MESSAGE_
TYPE_ SUBMIT_ SHARES_ SUCCESS - MESSAGE_
TYPE_ UPDATE_ CHANNEL - MESSAGE_
TYPE_ UPDATE_ CHANNEL_ ERROR