Merge pull request #338 from input-output-hk/whankinsiv/reference-script-support

feat: reference script persistence in utxo state

Author: whankinsiv

codec/src/map_parameters.rs

@@ -18,6 +18,7 @@ use acropolis_common::{
     rational_number::RationalNumber,
     *,
 };
+use pallas_primitives::conway::PseudoScript;
 use std::collections::{HashMap, HashSet};
 
 /// Map Pallas Network to our NetworkId
@@ -1100,3 +1101,21 @@ pub fn map_datum(datum: &Option<conway::MintedDatumOption>) -> Option<Datum> {
         None => None,
     }
 }
+
+pub fn map_reference_script(script: &Option<conway::MintedScriptRef>) -> Option<ReferenceScript> {
+    match script {
+        Some(PseudoScript::NativeScript(script)) => {
+            Some(ReferenceScript::Native(script.raw_cbor().to_vec()))
+        }
+        Some(PseudoScript::PlutusV1Script(script)) => {
+            Some(ReferenceScript::PlutusV1(script.as_ref().to_vec()))
+        }
+        Some(PseudoScript::PlutusV2Script(script)) => {
+            Some(ReferenceScript::PlutusV2(script.as_ref().to_vec()))
+        }
+        Some(PseudoScript::PlutusV3Script(script)) => {
+            Some(ReferenceScript::PlutusV3(script.as_ref().to_vec()))
+        }
+        None => None,
+    }
+}

common/src/types.rs

@@ -324,6 +324,15 @@ pub enum Datum {
     Inline(Vec<u8>),
 }
 
+// The full CBOR bytes of a reference script
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, PartialEq, Eq)]
+pub enum ReferenceScript {
+    Native(Vec<u8>),
+    PlutusV1(Vec<u8>),
+    PlutusV2(Vec<u8>),
+    PlutusV3(Vec<u8>),
+}
+
 /// Value (lovelace + multiasset)
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct Value {
@@ -448,6 +457,9 @@ pub struct TxOutput {
 
     /// Datum (Inline or Hash)
     pub datum: Option<Datum>,
+
+    /// Reference script
+    pub reference_script: Option<ReferenceScript>,
 }
 
 /// Transaction input (UTXO reference)

modules/assets_state/src/state.rs

@@ -769,6 +769,7 @@ mod tests {
                 )],
             },
             datum: datum.map(Datum::Inline),
+            reference_script: None,
         }
     }
 

modules/genesis_bootstrapper/src/genesis_bootstrapper.rs

@@ -152,6 +152,7 @@ impl GenesisBootstrapper {
                         }),
                         value: Value::new(*amount, Vec::new()),
                         datum: None,
+                        reference_script: None,
                     };
 
                     utxo_deltas_message.deltas.push(UTXODelta::Output(tx_output));

modules/tx_unpacker/src/tx_unpacker.rs

@@ -230,6 +230,7 @@ impl TxUnpacker {
                                                                         address,
                                                                         value: map_parameters::map_value(&output.value()),
                                                                         datum: map_parameters::map_datum(&output.datum()),
+                                                                        reference_script: map_parameters::map_reference_script(&output.script_ref())
                                                                     }));
 
                                                                     // catch all output lovelaces

modules/utxo_state/src/fake_immutable_utxo_store.rs

@@ -53,6 +53,7 @@ impl ImmutableUTXOStore for FakeImmutableUTXOStore {
             address: Address::None,
             value: Value::new(42, Vec::new()),
             datum: None,
+            reference_script: None,
         }))
     }
 

modules/utxo_state/src/state.rs

@@ -4,7 +4,7 @@ use acropolis_common::{
     messages::UTXODeltasMessage, params::SECURITY_PARAMETER_K, Address, BlockInfo, BlockStatus,
     Datum, TxInput, TxOutput, UTXODelta,
 };
-use acropolis_common::{AddressDelta, UTxOIdentifier, Value, ValueDelta};
+use acropolis_common::{AddressDelta, ReferenceScript, UTxOIdentifier, Value, ValueDelta};
 use anyhow::Result;
 use async_trait::async_trait;
 use std::collections::HashMap;
@@ -22,6 +22,9 @@ pub struct UTXOValue {
 
     /// Datum
     pub datum: Option<Datum>,
+
+    /// Reference script
+    pub reference_script: Option<ReferenceScript>,
 }
 
 /// Address delta observer
@@ -268,6 +271,7 @@ impl State {
             address: output.address.clone(),
             value: output.value.clone(),
             datum: output.datum.clone(),
+            reference_script: output.reference_script.clone(),
         };
 
         // Add to volatile or immutable maps
@@ -406,7 +410,9 @@ impl State {
 mod tests {
     use super::*;
     use crate::InMemoryImmutableUTXOStore;
-    use acropolis_common::{AssetName, BlockHash, ByronAddress, Era, NativeAsset, Value};
+    use acropolis_common::{
+        AssetName, BlockHash, ByronAddress, Era, NativeAsset, ReferenceScript, Value,
+    };
     use config::Config;
     use tokio::sync::Mutex;
 
@@ -450,6 +456,7 @@ mod tests {
     async fn observe_output_adds_to_immutable_utxos() {
         let mut state = new_state();
         let datum_data = vec![1, 2, 3, 4, 5];
+        let reference_script_bytes = vec![0xde, 0xad, 0xbe, 0xef];
 
         let output = TxOutput {
             utxo_identifier: UTxOIdentifier::new(0, 0, 0),
@@ -471,6 +478,7 @@ mod tests {
                 )],
             ),
             datum: Some(Datum::Inline(datum_data.clone())),
+            reference_script: Some(ReferenceScript::PlutusV1(reference_script_bytes.clone())),
         };
 
         let block = create_block(BlockStatus::Immutable, 1, 1);
@@ -503,6 +511,9 @@ mod tests {
                     value.datum,
                     Some(Datum::Inline(ref data)) if data == &datum_data
                 ));
+                assert!(matches!(
+                    value.reference_script,
+                    Some(ReferenceScript::PlutusV1(ref bytes)) if bytes == &reference_script_bytes));
             }
 
             _ => panic!("UTXO not found"),
@@ -532,6 +543,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block1 = create_block(BlockStatus::Immutable, 1, 1);
@@ -576,6 +588,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block10 = create_block(BlockStatus::Volatile, 10, 10);
@@ -616,6 +629,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block10 = create_block(BlockStatus::Volatile, 10, 10);
@@ -671,6 +685,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block1 = create_block(BlockStatus::Volatile, 1, 1);
@@ -718,6 +733,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block1 = create_block(BlockStatus::Volatile, 1, 1);
@@ -826,6 +842,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block1 = create_block(BlockStatus::Immutable, 1, 1);
@@ -884,6 +901,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block10 = create_block(BlockStatus::Volatile, 10, 10);
@@ -938,6 +956,7 @@ mod tests {
                 )],
             ),
             datum: None,
+            reference_script: None,
         };
 
         let block10 = create_block(BlockStatus::Volatile, 10, 10);