feat(rust/cardano-blockchain-types): Add CIP36

[bkioshn]

Description

Move CIP36 validation and decoding out of cardano-chain-follower

Related Issue(s)

#121

Description of Changes

This CIP36 registration is divided into 3 part

1. key_registration - 61284 decoding
2. registration_witness - 61285 decoding
3. Basic validation

• Signature validation of the registration witness 61285 against the stake public key in key registration 61284.
• Payment address network validation against the network. The given network should match the network tag within the payment address.
• Purpose validation, the purpose should be 0 for Catalyst (whenis_strict_catalyst is true).
• Voting keys validation, Catalyst supports only a single voting key per registration when is_strict_catalyst is true.

Additional change

• add decode_helper.rs helper function for CBOR decoder

Please confirm the following checks

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream module

[github-actions]

✅ Test Report | ${\color{lightgreen}Pass: 264/264}$ | ${\color{red}Fail: 0/264}$ |

[stevenj]

These changes need to be made.

[stevenj]

Make a new public library crate cbork-util move this module to it.
For now, its all that cbork-util will contain.

[stevenj]

This not verbose enough.
We should not be keeping it a secret why we failed to validate. We know what the errors are, we should explicitly list them as this is an End User report. Not an internal report.

The original code was:

  // Validate that all keys required to be present in the CIP36 Metadata are present.
        if !found_keys.contains(&1) {
            validation_report.push(
                "The CIP36 Metadata Voting Key/Delegation is missing from the data.".to_string(),
            );
        }
        if !found_keys.contains(&2) {
            validation_report
                .push("The CIP36 Metadata Stake Address is missing from the data.".to_string());
        }
        if !found_keys.contains(&3) {
            validation_report
                .push("The CIP36 Metadata Payment Address is missing from the data.".to_string());
        }
        if !found_keys.contains(&4) {
            validation_report
                .push("The CIP36 Metadata Nonce is missing from the data.".to_string());
        }

And it needs to be at least this verbose.

[stevenj]

Do not fail fast, accumulate all possible errors in a validation_report like the original code intended to do.
This is to inform the user of all the reasons we failed to validate the metadata, and stopping on the first is unhelpful and frustrating UX.