Add documentation + fix acronym names (#339)

* Add documentation + fix acronym names

Using dcSpark/cddl-codegen#218 and dcSpark/cddl-codegen#238

Also renames some cert fields to be clear as `coin` was not very
helpful.

* update multi-era crates too

* clippy fix

chain/rust/src/auxdata/cbor_encodings.rs

@@ -20,7 +20,7 @@ pub struct ConwayFormatAuxDataEncoding {
 }
 
 #[derive(Clone, Debug, Default)]
-pub struct ShelleyMaFormatAuxDataEncoding {
+pub struct ShelleyMAFormatAuxDataEncoding {
     pub len_encoding: LenEncoding,
     pub auxiliary_scripts_encoding: LenEncoding,
 }

chain/rust/src/auxdata/mod.rs

@@ -8,14 +8,14 @@ pub mod utils;
 
 use crate::plutus::{PlutusV1Script, PlutusV2Script, PlutusV3Script};
 use crate::transaction::NativeScript;
-use cbor_encodings::{ConwayFormatAuxDataEncoding, ShelleyMaFormatAuxDataEncoding};
+use cbor_encodings::{ConwayFormatAuxDataEncoding, ShelleyMAFormatAuxDataEncoding};
 
 pub use metadata::*;
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub enum AuxiliaryData {
     Shelley(ShelleyFormatAuxData),
-    ShelleyMA(ShelleyMaFormatAuxData),
+    ShelleyMA(ShelleyMAFormatAuxData),
     Conway(ConwayFormatAuxData),
 }
 
@@ -24,8 +24,8 @@ impl AuxiliaryData {
         Self::Shelley(shelley)
     }
 
-    pub fn new_shelley_m_a(shelley_m_a: ShelleyMaFormatAuxData) -> Self {
-        Self::ShelleyMA(shelley_m_a)
+    pub fn new_shelley_ma(shelley_ma: ShelleyMAFormatAuxData) -> Self {
+        Self::ShelleyMA(shelley_ma)
     }
 
     pub fn new_conway(conway: ConwayFormatAuxData) -> Self {
@@ -66,14 +66,14 @@ impl Default for ConwayFormatAuxData {
 pub type ShelleyFormatAuxData = Metadata;
 
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
-pub struct ShelleyMaFormatAuxData {
+pub struct ShelleyMAFormatAuxData {
     pub transaction_metadata: Metadata,
     pub auxiliary_scripts: Vec<NativeScript>,
     #[serde(skip)]
-    pub encodings: Option<ShelleyMaFormatAuxDataEncoding>,
+    pub encodings: Option<ShelleyMAFormatAuxDataEncoding>,
 }
 
-impl ShelleyMaFormatAuxData {
+impl ShelleyMAFormatAuxData {
     pub fn new(transaction_metadata: Metadata, auxiliary_scripts: Vec<NativeScript>) -> Self {
         Self {
             transaction_metadata,

chain/rust/src/auxdata/serialization.rs

@@ -19,8 +19,8 @@ impl Serialize for AuxiliaryData {
     ) -> cbor_event::Result<&'se mut Serializer<W>> {
         match self {
             AuxiliaryData::Shelley(shelley) => shelley.serialize(serializer, force_canonical),
-            AuxiliaryData::ShelleyMA(shelley_m_a) => {
-                shelley_m_a.serialize(serializer, force_canonical)
+            AuxiliaryData::ShelleyMA(shelley_ma) => {
+                shelley_ma.serialize(serializer, force_canonical)
             }
             AuxiliaryData::Conway(conway) => conway.serialize(serializer, force_canonical),
         }
@@ -43,9 +43,9 @@ impl Deserialize for AuxiliaryData {
                 }
             };
             let deser_variant: Result<_, DeserializeError> =
-                ShelleyMaFormatAuxData::deserialize(raw);
+                ShelleyMAFormatAuxData::deserialize(raw);
             match deser_variant {
-                Ok(shelley_m_a) => return Ok(Self::ShelleyMA(shelley_m_a)),
+                Ok(shelley_ma) => return Ok(Self::ShelleyMA(shelley_ma)),
                 Err(e) => {
                     errs.push(e.annotate("ShelleyMA"));
                     raw.as_mut_ref()
@@ -513,7 +513,7 @@ impl Deserialize for ConwayFormatAuxData {
     }
 }
 
-impl Serialize for ShelleyMaFormatAuxData {
+impl Serialize for ShelleyMAFormatAuxData {
     fn serialize<'se, W: Write>(
         &self,
         serializer: &'se mut Serializer<W>,
@@ -551,7 +551,7 @@ impl Serialize for ShelleyMaFormatAuxData {
     }
 }
 
-impl Deserialize for ShelleyMaFormatAuxData {
+impl Deserialize for ShelleyMAFormatAuxData {
     fn deserialize<R: BufRead + Seek>(raw: &mut Deserializer<R>) -> Result<Self, DeserializeError> {
         let len = raw.array_sz()?;
         let len_encoding: LenEncoding = len.into();
@@ -586,15 +586,15 @@ impl Deserialize for ShelleyMaFormatAuxData {
                     _ => return Err(DeserializeFailure::EndingBreakMissing.into()),
                 },
             }
-            Ok(ShelleyMaFormatAuxData {
+            Ok(ShelleyMAFormatAuxData {
                 transaction_metadata,
                 auxiliary_scripts,
-                encodings: Some(ShelleyMaFormatAuxDataEncoding {
+                encodings: Some(ShelleyMAFormatAuxDataEncoding {
                     len_encoding,
                     auxiliary_scripts_encoding,
                 }),
             })
         })()
-        .map_err(|e| e.annotate("ShelleyMaFormatAuxData"))
+        .map_err(|e| e.annotate("ShelleyMAFormatAuxData"))
     }
 }

chain/rust/src/auxdata/utils.rs

@@ -5,7 +5,7 @@ use crate::{
     transaction::NativeScript,
 };
 
-use super::{AuxiliaryData, ConwayFormatAuxData, ShelleyMaFormatAuxData};
+use super::{AuxiliaryData, ConwayFormatAuxData, ShelleyMAFormatAuxData};
 
 impl AuxiliaryData {
     pub fn new() -> Self {
@@ -81,7 +81,7 @@ impl AuxiliaryData {
     pub fn add_native_scripts(&mut self, scripts: Vec<NativeScript>) {
         match self {
             Self::Shelley(shelley) => {
-                *self = Self::ShelleyMA(ShelleyMaFormatAuxData::new(shelley.clone(), scripts));
+                *self = Self::ShelleyMA(ShelleyMAFormatAuxData::new(shelley.clone(), scripts));
             }
             Self::ShelleyMA(shelley_ma) => {
                 shelley_ma.auxiliary_scripts.extend(scripts);

chain/rust/src/certs/cbor_encodings.rs

@@ -10,7 +10,7 @@ pub struct AuthCommitteeHotCertEncoding {
 }
 
 #[derive(Clone, Debug, Default)]
-pub struct DnsNameEncoding {
+pub struct DNSNameEncoding {
     pub inner_encoding: StringEncoding,
 }
 
@@ -64,14 +64,14 @@ pub struct PoolRetirementEncoding {
 pub struct RegCertEncoding {
     pub len_encoding: LenEncoding,
     pub tag_encoding: Option<cbor_event::Sz>,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
 pub struct RegDrepCertEncoding {
     pub len_encoding: LenEncoding,
     pub index_0_encoding: Option<cbor_event::Sz>,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -112,7 +112,7 @@ pub struct StakeRegDelegCertEncoding {
     pub len_encoding: LenEncoding,
     pub tag_encoding: Option<cbor_event::Sz>,
     pub pool_encoding: StringEncoding,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -133,21 +133,21 @@ pub struct StakeVoteRegDelegCertEncoding {
     pub len_encoding: LenEncoding,
     pub tag_encoding: Option<cbor_event::Sz>,
     pub pool_encoding: StringEncoding,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
 pub struct UnregCertEncoding {
     pub len_encoding: LenEncoding,
     pub tag_encoding: Option<cbor_event::Sz>,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
 pub struct UnregDrepCertEncoding {
     pub len_encoding: LenEncoding,
     pub index_0_encoding: Option<cbor_event::Sz>,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }
 
 #[derive(Clone, Debug, Default)]
@@ -171,5 +171,5 @@ pub struct VoteDelegCertEncoding {
 pub struct VoteRegDelegCertEncoding {
     pub len_encoding: LenEncoding,
     pub tag_encoding: Option<cbor_event::Sz>,
-    pub coin_encoding: Option<cbor_event::Sz>,
+    pub deposit_encoding: Option<cbor_event::Sz>,
 }