fix(sign-doc): name + const

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

Author: bkioshn

rust/signed_doc/src/lib.rs

@@ -21,7 +21,7 @@ use error::CatalystSignedDocError;
 pub use metadata::{DocumentRef, ExtraFields, Metadata, UuidV4, UuidV7};
 pub use minicbor::{decode, encode, Decode, Decoder, Encode};
 pub use signature::{KidUri, Signatures};
-use utils::context::SignDocContext;
+use utils::context::DecodeSignDocCtx;
 
 /// Inner type that holds the Catalyst Signed Document with parsing errors.
 #[derive(Debug, Clone)]
@@ -112,15 +112,15 @@ impl TryFrom<&[u8]> for CatalystSignedDocument {
 
     fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
         let error_report = ProblemReport::new("Catalyst Signed Document");
-        let mut ctx = SignDocContext { error_report };
+        let mut ctx = DecodeSignDocCtx { error_report };
         let decoded: CatalystSignedDocument = minicbor::decode_with(value, &mut ctx)
             .map_err(|e| CatalystSignedDocError::new(ctx.error_report, e.into()))?;
         Ok(decoded)
     }
 }
 
-impl Decode<'_, SignDocContext> for CatalystSignedDocument {
-    fn decode(d: &mut Decoder<'_>, ctx: &mut SignDocContext) -> Result<Self, decode::Error> {
+impl Decode<'_, DecodeSignDocCtx> for CatalystSignedDocument {
+    fn decode(d: &mut Decoder<'_>, ctx: &mut DecodeSignDocCtx) -> Result<Self, decode::Error> {
         let start = d.position();
         d.skip()?;
         let end = d.position();

rust/signed_doc/src/metadata/extra_fields.rs

@@ -164,7 +164,8 @@ impl ExtraFields {
     pub(crate) fn from_protected_header(
         protected: &ProtectedHeader, error_report: &ProblemReport,
     ) -> anyhow::Result<Self> {
-        let context = "COSE ProtectedHeader to ExtraFields";
+        /// Context for error messages.
+        const CONTEXT: &str = "COSE ProtectedHeader to ExtraFields";
 
         let mut extra = ExtraFields::default();
 
@@ -180,7 +181,7 @@ impl ExtraFields {
                         "CBOR COSE protected header doc ref",
                         &format!("{cbor_doc_ref:?}"),
                         &format!("Expected DocumentRef: {e}"),
-                        &format!("{context}, DocumentRef"),
+                        &format!("{CONTEXT}, DocumentRef"),
                     );
                 },
             }
@@ -198,7 +199,7 @@ impl ExtraFields {
                         "CBOR COSE protected header document template",
                         &format!("{cbor_doc_template:?}"),
                         &format!("Expected DocumentRef: {e}"),
-                        &format!("{context}, DocumentRef"),
+                        &format!("{CONTEXT}, DocumentRef"),
                     );
                 },
             }
@@ -216,7 +217,7 @@ impl ExtraFields {
                         "CBOR COSE protected header document reply",
                         &format!("{cbor_doc_reply:?}"),
                         &format!("Expected DocumentRef: {e}"),
-                        &format!("{context}, DocumentRef"),
+                        &format!("{CONTEXT}, DocumentRef"),
                     );
                 },
             }
@@ -234,7 +235,7 @@ impl ExtraFields {
                         "COSE protected header document section",
                         &format!("{cbor_doc_section:?}"),
                         &format!("Expected String: {e:?}"),
-                        &format!("{context}, converting document section to String"),
+                        &format!("{CONTEXT}, converting document section to String"),
                     );
                 },
             }
@@ -256,7 +257,7 @@ impl ExtraFields {
                                     &format!("COSE protected header collaborator index {ids}"),
                                     &format!("{collaborator:?}"),
                                     &format!("Expected String: {e:?}"),
-                                    &format!("{context}, converting collaborator to String"),
+                                    &format!("{CONTEXT}, converting collaborator to String"),
                                 );
                             },
                         }
@@ -268,7 +269,7 @@ impl ExtraFields {
                         "CBOR COSE protected header collaborators",
                         &format!("{cbor_doc_collabs:?}"),
                         &format!("Expected Array: {e:?}"),
-                        &format!("{context}, converting collaborators to Array"),
+                        &format!("{CONTEXT}, converting collaborators to Array"),
                     );
                 },
             }
@@ -286,7 +287,7 @@ impl ExtraFields {
                         "CBOR COSE protected header brand ID",
                         &format!("{cbor_doc_brand_id:?}"),
                         &format!("Expected UUID: {e:?}"),
-                        &format!("{context}, decoding CBOR UUID for brand ID"),
+                        &format!("{CONTEXT}, decoding CBOR UUID for brand ID"),
                     );
                 },
             }
@@ -304,7 +305,7 @@ impl ExtraFields {
                         "CBOR COSE protected header campaign ID",
                         &format!("{cbor_doc_campaign_id:?}"),
                         &format!("Expected UUID: {e:?}"),
-                        &format!("{context}, decoding CBOR UUID for campaign ID"),
+                        &format!("{CONTEXT}, decoding CBOR UUID for campaign ID"),
                     );
                 },
             }
@@ -322,7 +323,7 @@ impl ExtraFields {
                         "CBOR COSE protected header election ID",
                         &format!("{cbor_doc_election_id:?}"),
                         &format!("Expected UUID: {e:?}"),
-                        &format!("{context}, decoding CBOR UUID for election ID"),
+                        &format!("{CONTEXT}, decoding CBOR UUID for election ID"),
                     );
                 },
             }
@@ -340,7 +341,7 @@ impl ExtraFields {
                         "CBOR COSE protected header category ID",
                         &format!("{cbor_doc_category_id:?}"),
                         &format!("Expected UUID: {e:?}"),
-                        &format!("{context}, decoding CBOR UUID for category ID"),
+                        &format!("{CONTEXT}, decoding CBOR UUID for category ID"),
                     );
                 },
             }

rust/signed_doc/src/utils/context.rs

@@ -2,8 +2,8 @@
 
 use catalyst_types::problem_report::ProblemReport;
 
-/// Sign Document Context.
-pub(crate) struct SignDocContext {
+/// Sign Document Decoding Context.
+pub(crate) struct DecodeSignDocCtx {
     /// Error Report.
     pub(crate) error_report: ProblemReport,
 }