Merge branch 'main' into wip/document-schemas

Author: stevenj

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
     types:
       - synchronize
       - ready_for_review
+      - opened
 
 
 permissions:
@@ -17,11 +18,12 @@ permissions:
 
 jobs:
   ci:
+    if: ${{ !github.event.pull_request.draft }}
     uses: input-output-hk/catalyst-forge/.github/workflows/ci.yml@ci/v1.7.1
     with:
       forge_version: 0.8.0
 
   test_reporting:
-    if: always()
+    if: ${{ !github.event.pull_request.draft }}
     needs: ci
     uses: ./.github/workflows/generate-allure-report.yml

rust/cardano-blockchain-types/Cargo.toml

@@ -20,8 +20,8 @@ workspace = true
 [dependencies]
 pallas = { version = "0.30.1", git = "https://github.com/input-output-hk/catalyst-pallas.git", rev = "9b5183c8b90b90fe2cc319d986e933e9518957b3" }
 # pallas-hardano = { version = "0.30.1", git = "https://github.com/input-output-hk/catalyst-pallas.git", rev = "9b5183c8b90b90fe2cc319d986e933e9518957b3" }
-cbork-utils = { version = "0.0.1", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
-catalyst-types = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
+cbork-utils = { version = "0.0.1", path = "../cbork-utils" }
+catalyst-types = { version = "0.0.3", path = "../catalyst-types" }
 
 ouroboros = "0.18.4"
 tracing = "0.1.41"

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,23 +45,28 @@ 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).
-    /// Field 4 in the CIP-36 61284 Spec.
     /// None if it is not set.
     pub nonce: Option<u64>,
     /// Registration Purpose (Always 0 for Catalyst).
     /// Field 5 in the CIP-36 61284 Spec.
     /// Default to 0.
     pub purpose: u64,
     /// Raw nonce (nonce that has not had slot correction applied).
+    /// Field 4 in the CIP-36 61284 Spec.
     /// None if it is not set.
     pub raw_nonce: Option<u64>,
     /// Is payment address payable? (not a script)
     /// None if it is not set.
     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,14 +10,14 @@ 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;
 
 use crate::{MetadatumLabel, MultiEraBlock, Network, Slot, TxnIndex};
 
 /// CIP-36 Catalyst registration
-#[derive(Clone)]
+#[derive(Debug, Clone)]
 #[allow(clippy::struct_excessive_bools)]
 pub struct Cip36 {
     /// Key registration - 61284
@@ -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();

rust/cardano-blockchain-types/src/stake_address.rs

@@ -5,6 +5,7 @@
 use std::fmt::{Display, Formatter};
 
 use anyhow::{anyhow, Context};
+use catalyst_types::hashes::Blake2b224Hash;
 use pallas::{
     crypto::hash::Hash,
     ledger::{
@@ -26,8 +27,9 @@ impl StakeAddress {
     /// Creates a new instance from the given parameters.
     #[allow(clippy::expect_used, clippy::missing_panics_doc)]
     #[must_use]
-    pub fn new(network: Network, is_script: bool, hash: Hash<28>) -> Self {
+    pub fn new(network: Network, is_script: bool, stake_pk_hash: Blake2b224Hash) -> Self {
         let network = network.into();
+        let hash = stake_pk_hash.into();
         // `pallas::StakeAddress` can only be constructed from `ShelleyAddress`, so we are forced
         // to create a dummy shelley address. The input hash parameter is used to construct both
         // payment and delegation parts, but the payment part isn't used in the stake address
@@ -49,8 +51,8 @@ impl StakeAddress {
     #[must_use]
     pub fn from_stake_cred(network: Network, cred: &conway::StakeCredential) -> Self {
         match cred {
-            conway::StakeCredential::Scripthash(h) => Self::new(network, true, *h),
-            conway::StakeCredential::AddrKeyhash(h) => Self::new(network, false, *h),
+            conway::StakeCredential::Scripthash(h) => Self::new(network, true, (*h).into()),
+            conway::StakeCredential::AddrKeyhash(h) => Self::new(network, false, (*h).into()),
         }
     }
 
@@ -111,7 +113,7 @@ impl TryFrom<&[u8]> for StakeAddress {
             v => return Err(anyhow!("Unexpected type value: {v}, header = {header}")),
         };
 
-        Ok(Self::new(network, is_script, hash))
+        Ok(Self::new(network, is_script, hash.into()))
     }
 }
 
@@ -155,7 +157,7 @@ mod tests {
         ];
 
         for (network, is_script, hash, expected_header) in test_data {
-            let stake_address = StakeAddress::new(network, is_script, hash);
+            let stake_address = StakeAddress::new(network, is_script, hash.into());
             assert_eq!(stake_address.is_script(), is_script);
 
             // Check that conversion to bytes includes the expected header value.
@@ -227,7 +229,7 @@ mod tests {
         // cSpell:enable
 
         for (network, is_script, hash, expected) in test_data {
-            let address = StakeAddress::new(network, is_script, hash);
+            let address = StakeAddress::new(network, is_script, hash.into());
             assert_eq!(expected, format!("{address}"));
         }
     }

rust/cardano-blockchain-types/src/txn_index.rs

@@ -31,6 +31,12 @@ impl From<TxnIndex> for usize {
     }
 }
 
+impl From<TxnIndex> for u16 {
+    fn from(value: TxnIndex) -> Self {
+        value.0
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

rust/cardano-chain-follower/Cargo.toml

@@ -19,8 +19,8 @@ mithril-client = { version = "0.10.4", default-features = false, features = [
     "full",
     "num-integer-backend",
 ] }
-cardano-blockchain-types = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
-catalyst-types = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
+cardano-blockchain-types = { version = "0.0.3", path = "../cardano-blockchain-types" }
+catalyst-types = { version = "0.0.3", path = "../catalyst-types" }
 
 
 thiserror = "1.0.69"

rust/cardano-chain-follower/src/chain_sync.rs

@@ -561,7 +561,7 @@ pub(crate) async fn chain_sync(cfg: ChainSyncConfig, rx: mpsc::Receiver<MithrilU
         // Note: This can ONLY return with an error, otherwise it will sync indefinitely.
         if let Err(error) = follow_chain(&mut peer, cfg.chain, &mut fork_count).await {
             error!(
-                "Cardano Client {} failed to follow chain: {}: Reconnecting.",
+                "Cardano Client {} failed to follow chain: {:?}: Reconnecting.",
                 cfg.relay_address, error
             );
             continue;

rust/catalyst-types/src/hashes.rs

@@ -84,6 +84,13 @@ impl<const BYTES: usize> From<Hash<BYTES>> for Blake2bHash<BYTES> {
     }
 }
 
+impl<const BYTES: usize> From<Blake2bHash<BYTES>> for Hash<BYTES> {
+    #[inline]
+    fn from(hash: Blake2bHash<BYTES>) -> Self {
+        hash.0
+    }
+}
+
 impl<const BYTES: usize> From<Blake2bHash<BYTES>> for Vec<u8> {
     fn from(val: Blake2bHash<BYTES>) -> Self {
         val.0.to_vec()

rust/rbac-registration/Cargo.toml

@@ -30,8 +30,8 @@ tracing = "0.1.40"
 ed25519-dalek = "2.1.1"
 uuid = "1.11.0"
 
-c509-certificate = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
+c509-certificate = { version = "0.0.3", path = "../c509-certificate" }
 pallas = { version = "0.30.1", git = "https://github.com/input-output-hk/catalyst-pallas.git", rev = "9b5183c8b90b90fe2cc319d986e933e9518957b3" }
-cbork-utils = { version = "0.0.1", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
-cardano-blockchain-types = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
-catalyst-types = { version = "0.0.3", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250226-00" }
+cbork-utils = { version = "0.0.1", path = "../cbork-utils" }
+cardano-blockchain-types = { version = "0.0.3", path = "../cardano-blockchain-types" }
+catalyst-types = { version = "0.0.3", path = "../catalyst-types" }

rust/rbac-registration/src/cardano/cip509/mod.rs

@@ -6,8 +6,8 @@ pub use cip509::Cip509;
 #[allow(clippy::module_name_repetitions)]
 pub use rbac::{C509Cert, Cip509RbacMetadata, SimplePublicKeyType, X509DerCert};
 pub use types::{
-    CertKeyHash, KeyLocalRef, LocalRefInt, Payment, PaymentHistory, PointTxnIdx, RoleData,
-    RoleNumber, TxInputHash, ValidationSignature,
+    CertKeyHash, KeyLocalRef, LocalRefInt, Payment, PaymentHistory, PointData, PointTxnIdx,
+    RoleData, RoleNumber, TxInputHash, ValidationSignature,
 };
 pub use utils::Cip0134UriSet;
 

rust/rbac-registration/src/cardano/cip509/types/mod.rs

@@ -3,6 +3,7 @@
 pub use cert_key_hash::CertKeyHash;
 pub use key_local_ref::{KeyLocalRef, LocalRefInt};
 pub use payment_history::{Payment, PaymentHistory};
+pub use point_data::PointData;
 pub use point_tx_idx::PointTxnIdx;
 pub use role_data::RoleData;
 pub use role_number::RoleNumber;
@@ -12,6 +13,7 @@ pub use validation_signature::ValidationSignature;
 mod cert_key_hash;
 mod key_local_ref;
 mod payment_history;
+mod point_data;
 mod point_tx_idx;
 mod role_data;
 mod role_number;