feat(rust/signed-doc): Add chain field metadata validation rule

rust/catalyst-signed-doc-spec/src/metadata/chain.rs

@@ -0,0 +1,9 @@
+//! `signed_doc.json` "chain" field JSON definition
+
+use crate::is_required::IsRequired;
+
+/// `signed_doc.json` "chain" field JSON object
+#[derive(serde::Deserialize)]
+pub struct Chain {
+    pub required: IsRequired,
+}

rust/catalyst-signed-doc-spec/src/metadata/mod.rs

@@ -1,5 +1,6 @@
 //! `metadata` field definition
 
+pub mod chain;
 pub mod doc_ref;
 pub mod parameters;
 pub mod reply;
@@ -14,4 +15,5 @@ pub struct Metadata {
     pub doc_ref: doc_ref::Ref,
     pub reply: reply::Reply,
     pub parameters: parameters::Parameters,
+    pub chain: chain::Chain,
 }

rust/signed_doc/src/metadata/chain.rs

@@ -34,6 +34,32 @@ pub struct Chain {
     document_ref: Option<DocumentRef>,
 }
 
+impl Chain {
+    /// Creates a new `Chain`.
+    #[must_use]
+    pub fn new(
+        height: i32,
+        document_ref: Option<DocumentRef>,
+    ) -> Self {
+        Self {
+            height,
+            document_ref,
+        }
+    }
+
+    /// Gets `height`.
+    #[must_use]
+    pub fn height(&self) -> i32 {
+        self.height
+    }
+
+    /// Gets `document_ref`.
+    #[must_use]
+    pub fn document_ref(&self) -> Option<&DocumentRef> {
+        self.document_ref.as_ref()
+    }
+}
+
 impl Display for Chain {
     fn fmt(
         &self,

rust/signed_doc/src/metadata/document_refs/doc_ref.rs

@@ -7,6 +7,7 @@ use cbork_utils::{array::Array, decode_context::DecodeCtx};
 use minicbor::{Decode, Encode};
 
 use super::doc_locator::DocLocator;
+use crate::CatalystSignedDocument;
 
 /// Number of item that should be in each document reference instance.
 const DOC_REF_ARR_ITEM: u64 = 3;
@@ -38,6 +39,13 @@ impl DocumentRef {
         }
     }
 
+    /// Create a new instance of another document reference without including
+    /// `doc_locator`.
+    #[must_use]
+    pub fn from_without_locator(other: &Self) -> Self {
+        Self::new(*other.id(), *other.ver(), DocLocator::default())
+    }
+
     /// Get Document Id.
     #[must_use]
     pub fn id(&self) -> &UuidV7 {
@@ -57,6 +65,18 @@ impl DocumentRef {
     }
 }
 
+impl TryFrom<&CatalystSignedDocument> for DocumentRef {
+    type Error = anyhow::Error;
+
+    fn try_from(value: &CatalystSignedDocument) -> Result<Self, Self::Error> {
+        Ok(Self::new(
+            value.doc_id()?,
+            value.doc_ver()?,
+            DocLocator::default(),
+        ))
+    }
+}
+
 impl Display for DocumentRef {
     fn fmt(
         &self,

rust/signed_doc/src/providers.rs

@@ -26,6 +26,12 @@ pub trait CatalystSignedDocumentProvider: Send + Sync {
         doc_ref: &DocumentRef,
     ) -> impl Future<Output = anyhow::Result<Option<CatalystSignedDocument>>> + Send;
 
+    /// Try to get all versions of the `CatalystSignedDocument` from the given `id`.
+    fn try_get_all(
+        &self,
+        id: UuidV7,
+    ) -> impl Future<Output = anyhow::Result<Vec<CatalystSignedDocument>>> + Send;
+
     /// Try to get the last known version of the `CatalystSignedDocument`, same
     /// `id` and the highest known `ver`.
     fn try_get_last_doc(
@@ -111,6 +117,18 @@ pub mod tests {
             Ok(self.signed_doc.get(doc_ref).cloned())
         }
 
+        async fn try_get_all(
+            &self,
+            id: catalyst_types::uuid::UuidV7,
+        ) -> anyhow::Result<Vec<CatalystSignedDocument>> {
+            Ok(self
+                .signed_doc
+                .iter()
+                .filter(|(doc_ref, _)| doc_ref.id() == &id)
+                .map(|(_, doc)| doc.clone())
+                .collect())
+        }
+
         async fn try_get_last_doc(
             &self,
             id: catalyst_types::uuid::UuidV7,