Merge branch 'main' into wip/document-schemas

Author: stevenj

docs/src/architecture/08_concepts/catalyst_docs/comment.md

@@ -43,21 +43,24 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
 * [`ref`](./../signed_doc/meta.md#ref-document-reference).
-  Reference to a related [Proposal Document].
-* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value,
-  [comment template type](#comment-template).
+  Reference to a related [Proposal Document],
+  which [`type`](./../signed_doc/spec.md#type) must be equal to
+  [proposal document `type`][Proposal Document] field value.
 
-  ```CDDL
-  "template" => 37(h'0b8424d4ebfd46e395771775a69d290c')
-  ```
+* [`template`](./../signed_doc/meta.md#ref-document-reference).
+  A reference to the comment template document,
+  which [`type`](./../signed_doc/spec.md#type) must be equal to
+  [comment template `type`](#comment-template) field value.
 
 * [`reply`](./../signed_doc/meta.md#reply-reply-reference) (optional).
-  A reference to another comment,
+  A reference to another comment document,
   where the comment is in reply to the referenced comment.
+  The [`type`](./../signed_doc/spec.md#type) of the replied document
+  must be equal to comment document `type` field value.
   Comments may only reply to a single other comment document.
   The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id),
   but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver).
@@ -100,7 +103,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
 #### Content format

docs/src/architecture/08_concepts/catalyst_docs/proposal.md

@@ -47,15 +47,18 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
-* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value,
-  [proposal template type](#proposal-template).
+* [`template`](./../signed_doc/meta.md#ref-document-reference).
+  A reference to the proposal template document,
+  which [`type`](./../signed_doc/spec.md#type) must be equal to
+  [proposal template `type`](#proposal-template) field value.
 
-  ```CDDL
-  "template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
-  ```
+* [`category_id`](./../signed_doc/meta.md#category_id) (optional).
+  A reference to the category document,
+  which [`type`](./../signed_doc/spec.md#type) must be equal to
+  `48c20109-362a-4d32-9bba-e0a9cf8b45be` value.
 
 #### Content format
 
@@ -91,7 +94,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
 #### Content format

docs/src/architecture/08_concepts/catalyst_docs/review.md

@@ -43,15 +43,13 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
-* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value,
-  [review template type](#review-template).
-
-  ```CDDL
-  "template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc')
-  ```
+* [`template`](./../signed_doc/meta.md#ref-document-reference).
+  A reference to the review template document,
+  which [`type`](./../signed_doc/spec.md#type) must be equal to
+  [review template `type`](#review-template) field value.
 
 #### Content format
 
@@ -87,7 +85,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   [Catalyst Signed Document content] must be [Brotli] compressed.
 
   ```CDDL
-  "content-type" => "br"
+  "content-encoding" => "br"
   ```
 
 #### Content format

docs/src/architecture/08_concepts/signed_doc/meta.md

@@ -122,4 +122,5 @@ e.g. "Development & Infrastructure", "Products & Integrations".
 
 [UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
 [CBOR]: https://datatracker.ietf.org/doc/rfc8949/
+[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
 [JSON Path]: https://datatracker.ietf.org/doc/html/rfc9535

rust/Earthfile

@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.2.28 AS rust-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.2.37 AS rust-ci
 
 COPY_SRC:
     FUNCTION

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 = "r20250128-01" }
-catalyst-types = { version = "0.0.1", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250128-01" }
+cbork-utils = { version = "0.0.1", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250212-00" }
+catalyst-types = { version = "0.0.1", git = "https://github.com/input-output-hk/catalyst-libs.git", tag = "r20250212-00" }
 
 ouroboros = "0.18.4"
 tracing = "0.1.41"

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

@@ -9,5 +9,5 @@ define_hashes!(
     /// A transaction hash - Blake2b-256 hash of a transaction.
     (TransactionHash, Blake2b256Hash),
     /// A public key hash - raw Blake2b-224 hash of an Ed25519 public key (has no discriminator, just the hash).
-    (PubKeyHash, Blake2b224Hash)
+    (PubKeyHash, Blake2b224Hash),
 );

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

@@ -10,6 +10,7 @@ mod network;
 mod point;
 mod slot;
 mod txn_index;
+mod txn_output_offset;
 mod txn_witness;
 
 pub use auxdata::{
@@ -29,4 +30,5 @@ pub use network::Network;
 pub use point::Point;
 pub use slot::Slot;
 pub use txn_index::TxnIndex;
+pub use txn_output_offset::TxnOutputOffset;
 pub use txn_witness::{TxnWitness, VKeyHash};

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

@@ -116,9 +116,10 @@ impl Decode<'_, ProblemReport> for Cip36KeyRegistration {
                             .as_ref()
                             .map(|addr| !addr.payment().is_script())
                             .or(None);
+                        cip36_key_registration.payment_addr = shelley_addr;
                     },
                     Cip36KeyRegistrationKeys::Nonce => {
-                        cip36_key_registration.nonce = Some(decode_nonce(d)?);
+                        cip36_key_registration.raw_nonce = Some(decode_nonce(d)?);
                     },
                     Cip36KeyRegistrationKeys::Purpose => {
                         cip36_key_registration.purpose = decode_purpose(d)?;

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

@@ -67,6 +67,7 @@ impl fmt::Display for Cip36 {
 
 /// CIP-36 Catalyst registration error
 #[allow(dead_code, clippy::module_name_repetitions)]
+#[derive(Debug)]
 pub struct Cip36Error {
     /// The decoding error that make the code not able to process.
     error: anyhow::Error,
@@ -345,3 +346,32 @@ impl Cip36 {
         &self.err_report
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::{Cip36, MultiEraBlock, Network, Point};
+
+    // CIP36 in transaction 1
+    // <https://preprod.cardanoscan.io/transaction/5c7cf7bff543447fc1e46c2598380fa08b8d882de2191ef5bc80078b71724217?tab=metadata>
+    fn block_1() -> MultiEraBlock {
+        let data = hex::decode(include_str!("./test_data/block_1.block")).unwrap();
+        let previous = Point::fuzzy(0.into());
+        MultiEraBlock::new(Network::Preprod, data, &previous, 0.into()).unwrap()
+    }
+
+    #[test]
+    fn new() {
+        let res = Cip36::new(&block_1(), 1.into(), true).unwrap().unwrap();
+        assert!(!res.err_report().is_problematic());
+        assert!(res.is_valid());
+        assert!(res.network() == Network::Preprod);
+        assert!(res.raw_nonce() == Some(55_076_993));
+        assert!(res.nonce() == Some(55_076_993));
+    }
+
+    #[test]
+    fn from_block() {
+        let res = Cip36::cip36_from_block(&block_1(), true).unwrap();
+        assert_eq!(res.len(), 1);
+    }
+}