Make notes and update docs if necessary. Create issues off the back of it to implement the other Mining Protocol messages.

link

Update the BitFlag trait method to a more accurate name from as_bytes() to something that obviously explains, the trait method returns a set bit in a u32. Also update the doc string in each impl to clearly explain the reason for setting a bit in a u32.

Need to look into the feature flags

The following message struct and implementations are missing from the job_negotiation sub-protocol module:

1. AllocateMiningJobToken(Client->Server)
2. AllocateMiningJobToken.Success(Server -> Client)
3. CommitMiningJob (Client -> Server)
4. CommitMiningJob.Success (Server->Client)
5. CommitMiningJob.Error (Server->Client)
6. IdentifyTransactions (Server->Client)
7. IdentifyTransactions.Success (Client->Server)
8. ProvideMissingTransactions (Server->Client)
9. ProvideMissingTransactions.Success (Client->Server)

A template_distribution module should exist to cover the Template Distribution Sub-Protocol with the following messages:

1. CoinbaseOutputDataSize (Client -> Server)
2. NewTemplate (Server -> Client)
3. SetNewPrevHash (Server -> Client)
4. RequestTransactionData (Client -> Server)
5. RequestTransactionData.Success (Server->Client)
6. RequestTransactionData.Error (Server->Client)
7. SubmitSolution (Client -> Server)

Note that this protocol does not have any mention of available protocol flags, but should probably be implemented as an empty variant for the sake of consistency.

Some Ideas:

• Test factory functions
• Macros

Create a STR_255 type that is an array of bytes limited to 255. Implement traits From and Into to do conversion to String representation.

STR_255 should be a [u8, 255].

• When converting From a String with a byte length greater than 255, convert up to 255 and drop the rest of the bytes.

• Create a types.rs file in messages module.

• Obviously unit test

Create a STR0_255 type and apply the From trait for str and String.

Return an error if the String is greater then 255 bytes.

Create module for Job Negotiation subprotocol

• What do the flags mean?
• Which flags are optional? (Can we set everything to unset) and test
  • Each submining protocol has their own set of feature flags
• [] Add flags for SetupConnectionSuccessMessage

• Make sure docs and doc strings are up to date for stratumv2-lib. We can check locally using cargo doc --no-deps --open

Further work from #12. Update SetupConnectionFlags or create a new enum for each specific Submining Protocol. We may have to have a shared trait to reference the different flags.

• There should be test coverage for all the stratumv2 messages, including initialization, serialization, deserialization, framing and unframing.

• SetupConnection
• SetupConnectionError
• SetupConnectionSuccess
• OpenExtendedChannel
• OpenExtendedChannelError
• OpenExtendedMiningChannelSuccess
• OpenStandardMiningChannel
• OpenStandardMiningChannelError
• OpenStandardMiningChannelSuccess

link

Example:

enum MsgType {
    SetupConnection = 0x00,
    SetupConnectionSuccess = 0x01.
    ...
}

Create a module for the Template Distribution subprotocol

• Update the examples to use messages and traits stratumv2-lib

Update serialize and frame trait implementations

• Update the noise module to use the new trait and message implemenations

Further work from #12. Implement SetupConnectionMessage.Success for sub protocol (0 = mining protocol)

Clients that are not configured to provide telemetry data to the upstream node SHOULD 
set device_id to 0-length strings. However, they MUST always set vendor to a string 
describing the manufacturer/developer and firmware version and SHOULD always set 
hardware_version to a string describing, at least, the particular hardware/software package in use.

Words such as SHOULD and MUST defined in rfc2119

• Most message for ser and der follow the same pattern, investigate if we can create a macro to create a message type including doc strings.

Heres one source where meta is used in the macro to capture the doc strings: https://amanjeev.com/blog/rust-document-macro-invocations