fix(rust/cardano-blockchain-types): CIP36 payment address type (#233)

* fix(cardano-blockchain-types): cip36 payment address type

Signed-off-by: bkioshn <[email protected]>

* fix(cardano-blockchain-types): cip36 payment addr comments + payable logic

Signed-off-by: bkioshn <[email protected]>

---------

Signed-off-by: bkioshn <[email protected]>

Author: bkioshn

rust/cardano-blockchain-types/src/metadata/cip36/key_registration.rs

@@ -12,7 +12,7 @@ use catalyst_types::{
 use cbork_utils::decode_helper::{decode_array_len, decode_bytes, decode_helper, decode_map_len};
 use ed25519_dalek::VerifyingKey;
 use minicbor::{decode, Decode, Decoder};
-use pallas::ledger::addresses::{Address, ShelleyAddress};
+use pallas::ledger::addresses::Address;
 use strum::FromRepr;
 
 use super::voting_pk::VotingPubKey;
@@ -45,7 +45,7 @@ pub(crate) struct Cip36KeyRegistration {
     /// Payment Address to associate with the voting keys.
     /// Field 3 in the CIP-36 61284 Spec.
     /// None if it is not set.
-    pub payment_addr: Option<ShelleyAddress>,
+    pub payment_addr: Option<Address>,
     /// Nonce (nonce that has been slot corrected).
     /// None if it is not set.
     pub nonce: Option<u64>,
@@ -62,6 +62,11 @@ pub(crate) struct Cip36KeyRegistration {
     pub is_payable: Option<bool>,
 }
 
+/// Header type of Shelley address that are consider as payable.
+/// Payable if payment part is a `PaymentKeyHash`
+/// <https://cips.cardano.org/cip/CIP-19>
+const VALID_PAYABLE_HEADER: [u8; 4] = [0, 2, 4, 6];
+
 /// Enum of CIP36 registration (61284) with its associated unsigned integer key.
 #[derive(FromRepr, Debug, PartialEq)]
 #[repr(u16)]
@@ -111,12 +116,12 @@ impl Decode<'_, ProblemReport> for Cip36KeyRegistration {
                         cip36_key_registration.stake_pk = stake_pk;
                     },
                     Cip36KeyRegistrationKeys::PaymentAddr => {
-                        let shelley_addr = decode_payment_addr(d, err_report)?;
-                        cip36_key_registration.is_payable = shelley_addr
+                        let address = decode_payment_addr(d, err_report)?;
+                        cip36_key_registration.is_payable = address
                             .as_ref()
-                            .map(|addr| !addr.payment().is_script())
+                            .map(|addr| VALID_PAYABLE_HEADER.contains(&addr.typeid()))
                             .or(None);
-                        cip36_key_registration.payment_addr = shelley_addr;
+                        cip36_key_registration.payment_addr = address;
                     },
                     Cip36KeyRegistrationKeys::Nonce => {
                         cip36_key_registration.raw_nonce = Some(decode_nonce(d)?);
@@ -294,16 +299,29 @@ fn decode_stake_pk(
 ///
 /// # Returns
 ///
-/// - The payment address as a `ShelleyAddress`.
-/// - None if cannot converted `Vec<u8>` to `ShelleyAddress`.
+/// - The payment address as a `Address`.
+/// - None if cannot converted `Vec<u8>` to `Address` or the address is a Byron address.
 /// - Error if decoding failed.
 fn decode_payment_addr(
     d: &mut Decoder, err_report: &ProblemReport,
-) -> Result<Option<ShelleyAddress>, decode::Error> {
+) -> Result<Option<Address>, decode::Error> {
     let raw_addr = decode_bytes(d, "CIP36 Key Registration payment address")?;
     // Cannot convert raw address to Address type
-    let address = match Address::from_bytes(&raw_addr) {
-        Ok(addr) => addr,
+    match Address::from_bytes(&raw_addr) {
+        Ok(addr) => {
+            match addr {
+                Address::Byron(byron_address) => {
+                    err_report.invalid_value(
+                        "Address",
+                        format!("{byron_address:?}").as_str(),
+                        "Expected non Byron address",
+                        "CIP36 Key Registration payment address",
+                    );
+                    Ok(None)
+                },
+                _ => Ok(Some(addr)),
+            }
+        },
         Err(e) => {
             err_report.conversion_error(
                 "Cardano address",
@@ -312,20 +330,8 @@ fn decode_payment_addr(
                 "CIP36 Key Registration payment address",
             );
             // Can't process any further
-            return Ok(None);
+            Ok(None)
         },
-    };
-
-    if let Address::Shelley(addr) = address {
-        Ok(Some(addr.clone()))
-    } else {
-        err_report.invalid_value(
-            "Shelley Address",
-            format!("{address}").as_str(),
-            "Expected Shelley address",
-            "CIP36 Key Registration payment address",
-        );
-        Ok(None)
     }
 }
 

rust/cardano-blockchain-types/src/metadata/cip36/mod.rs

@@ -10,7 +10,7 @@ use catalyst_types::problem_report::ProblemReport;
 use ed25519_dalek::VerifyingKey;
 use key_registration::Cip36KeyRegistration;
 use minicbor::{Decode, Decoder};
-use pallas::ledger::addresses::ShelleyAddress;
+use pallas::ledger::addresses::Address;
 use registration_witness::Cip36RegistrationWitness;
 use voting_pk::VotingPubKey;
 
@@ -247,7 +247,7 @@ impl Cip36 {
 
     /// Get the payment address from the registration.
     #[must_use]
-    pub fn payment_address(&self) -> Option<&ShelleyAddress> {
+    pub fn payment_address(&self) -> Option<&Address> {
         self.key_registration.payment_addr.as_ref()
     }
 

rust/cardano-blockchain-types/src/metadata/cip36/validation.rs

@@ -74,7 +74,16 @@ impl Cip36 {
             return;
         };
         // Extract the network tag and validate
-        let network_tag = address.network();
+        let Some(network_tag) = address.network() else {
+            // Byron address don't have network tag
+            self.err_report.missing_field(
+                "Network tag",
+                "Validate CIP36 payment address network, network tag not found",
+            );
+            self.is_valid_payment_address_network = false;
+            return;
+        };
+
         let valid = match self.network {
             Network::Mainnet => network_tag.value() == 1,
             Network::Preprod | Network::Preview => network_tag.value() == 0,
@@ -164,12 +173,9 @@ mod tests {
         // cSpell:disable
         let addr = Address::from_bech32("addr_test1qprhw4s70k0vzyhvxp6h97hvrtlkrlcvlmtgmaxdtjz87xrjkctk27ypuv9dzlzxusqse89naweygpjn5dxnygvus05sdq9h07").expect("Failed to create address");
         // cSpell:enable
-        let Address::Shelley(shelley_addr) = addr else {
-            panic!("Invalid address type")
-        };
         let mut cip36 = create_cip36();
         cip36.key_registration = Cip36KeyRegistration {
-            payment_addr: Some(shelley_addr),
+            payment_addr: Some(addr),
             ..Default::default()
         };
         cip36.validate_payment_address_network();
@@ -183,13 +189,10 @@ mod tests {
         // cSpell:disable
         let addr = Address::from_bech32("addr_test1qprhw4s70k0vzyhvxp6h97hvrtlkrlcvlmtgmaxdtjz87xrjkctk27ypuv9dzlzxusqse89naweygpjn5dxnygvus05sdq9h07").expect("Failed to create address");
         // cSpell:enable
-        let Address::Shelley(shelley_addr) = addr else {
-            panic!("Invalid address type")
-        };
         let mut cip36 = create_cip36();
         cip36.network = Network::Mainnet;
         cip36.key_registration = Cip36KeyRegistration {
-            payment_addr: Some(shelley_addr),
+            payment_addr: Some(addr),
             ..Default::default()
         };
         cip36.validate_payment_address_network();