Merge pull request #1049 from ProvableHQ/rr/add-record-decrypt-with-tvk

Add transition view key and record view key decryption methods for transitions and records.

Author: Roee-87

wasm/Cargo.lock

@@ -37,8 +37,8 @@ mod tests {
         Scalar,
         Signature,
         native::{FieldNative, GroupNative, LiteralNative, PlaintextNative, ScalarNative, SignatureNative},
-        test::{TEST_STRUCT, create_native_field_vector},
         types::native::{BHP256Native, BHP512Native, BHP768Native, BHP1024Native},
+        utilities::test::{TEST_STRUCT, create_native_field_vector},
     };
     use snarkvm_console::algorithms::{Commit, CommitUncompressed, Hash, HashUncompressed, ToBits};
 

wasm/src/algorithms/bhp/mod.rs

@@ -35,9 +35,8 @@ mod tests {
         Signature,
         js_array_from_fields,
         native::{GroupNative, LiteralNative, PlaintextNative, ScalarNative, SignatureNative},
-        test::TEST_STRUCT,
         types::native::{FieldNative, Poseidon2Native, Poseidon4Native, Poseidon8Native},
-        utilities::test::create_native_field_vector,
+        utilities::test::{TEST_STRUCT, create_native_field_vector},
     };
     use snarkvm_console::{
         algorithms::{Hash, HashMany, HashToGroup, HashToScalar},

wasm/src/algorithms/poseidon/mod.rs

@@ -23,7 +23,11 @@ use crate::{
     input_to_js_value,
     object,
     output_to_js_value,
-    types::native::{FromBytes, ToBytes, TransitionNative},
+    types::native::{CurrentNetwork, FieldNative, InputNative, OutputNative, TransitionNative, U16Native},
+};
+use snarkvm_console::{
+    prelude::{FromBytes, Network, ToBytes},
+    program::compute_function_id,
 };
 
 use js_sys::{Array, Reflect, Uint8Array};
@@ -191,6 +195,73 @@ impl Transition {
     pub fn scm(&self) -> Field {
         Field::from(self.0.scm())
     }
+
+    /// Decrypt the transition using the transition view key.
+    ///
+    /// @param {Field} tvk The transition view key.
+    ///
+    /// @returns {Transition} The transition with public values for inputs and outputs.
+    #[wasm_bindgen(js_name = decryptTransition)]
+    pub fn decrypt_transition(&self, tvk: &Field) -> Result<Self, String> {
+        let function_id =
+            compute_function_id(&U16Native::new(CurrentNetwork::ID), self.0.program_id(), self.0.function_name())
+                .map_err(|e| e.to_string())?;
+
+        // Create a vector that will be populated with decrypted private inputs and
+        // non-private inputs.
+        let mut decrypted_inputs = Vec::with_capacity(self.0.inputs().len());
+
+        // Iterate over the inputs and decrypt if they are private.  Non-private inputs
+        // such as public inputs and records are copied and added to the inputs vector.
+        for (index, input) in self.0.inputs().iter().enumerate() {
+            decrypted_inputs.push(match input {
+                InputNative::Private(input_id, Some(ciphertext)) => {
+                    let index_field = FieldNative::from_u16(index as u16);
+                    let input_view_key = CurrentNetwork::hash_psd4(&[function_id, **tvk, index_field])
+                        .map_err(|_| "Could not create input view key".to_string())?;
+                    let plaintext = ciphertext.decrypt_symmetric(input_view_key).map_err(|e| e.to_string())?;
+                    InputNative::Public(*input_id, Some(plaintext))
+                }
+                _ => input.clone(),
+            });
+        }
+
+        let outputs = self.0.outputs();
+        let num_inputs = self.0.inputs().len();
+
+        // Create a vector that will be populated with decrypted private outputs and
+        // non-private outputs.
+        let mut decrypted_outputs = Vec::with_capacity(outputs.len());
+
+        // Iterate over the outputs and decrypt if they are private.  Non-private outputs
+        // are copied and added to the outputs vector.
+        for (index, output) in outputs.iter().enumerate() {
+            decrypted_outputs.push(match output {
+                OutputNative::Private(output_id, Some(ciphertext)) => {
+                    let index_field = FieldNative::from_u16((num_inputs + index) as u16);
+                    let output_view_key = CurrentNetwork::hash_psd4(&[function_id, **tvk, index_field])
+                        .map_err(|_| "Could not create output view key".to_string())?;
+                    let plaintext = ciphertext.decrypt_symmetric(output_view_key).map_err(|e| e.to_string())?;
+                    OutputNative::Public(*output_id, Some(plaintext))
+                }
+                _ => output.clone(),
+            });
+        }
+
+        // The Transition struct is reconstructed with the decrypted inputs and outputs.
+        Ok(Self(
+            TransitionNative::new(
+                *self.0.program_id(),
+                *self.0.function_name(),
+                decrypted_inputs,
+                decrypted_outputs,
+                *self.0.tpk(),
+                *self.0.tcm(),
+                *self.0.scm(),
+            )
+            .map_err(|_| "failed to construct decrypted transition".to_string())?,
+        ))
+    }
 }
 
 impl Deref for Transition {
@@ -251,6 +322,11 @@ mod tests {
         "3771264214823666953346974490700157125043441681812666085949968314967709800215field";
     pub const TRANSITION: &str = r#"{"id":"au1naeu56spz0x0zct003sa8qgpzndy6nxj8rrcm7n0fehy9llcl5yscflt0k","program":"token_registry.aleo","function":"burn_private","inputs":[{"type":"record","id":"4569194627311410524427044648350523511369013276760031398859310110870190258038field","tag":"4584393733726099907383249165298083023636530416018938077800083356406243497342field"},{"type":"public","id":"4155661860779318196369465902681808025430867777096367712868886959018716227815field","value":"2853086u128"}],"outputs":[{"type":"record","id":"3771264214823666953346974490700157125043441681812666085949968314967709800215field","checksum":"17461704767783030875142836237730678349755524657182224909428747180538982740field","value":"record1qyqspwnlv6gfxx05yj7aw7z2dl44gyh06jrvgf42jux0dep33cy7jlsvqsrxzmt0w4h8ggcqqgqsqwdwr889h9fhnyclazs8yt26t6r5ua4qk7yksj7p40rz9846mzgrpp6x76m9de0kjezrqqpqyq9sj8x3qdmz6nal4j470a0wwcray54lffe3ya5u2zlpeq45lg4up3na8gul0vgrn3eced6dka4ax2ja85xzds4pmqf8csrn8ku5cv3qz8m90p6x2unwv9k97ct4w35x7unf0fshg6t0de0hyet3w45hyetyyvqqyqgq8djhghnte2w86qsdjaumy4zcux2fxszm3ej2956af8cpl2w95g9pqct4w35x7unf0fjkghm4de6xjmprqqpqzqxd6c782j0ny65ed2ckzp3vlx7cv8drslasq8kqpdzmjeyzal38qemw38x0axnz5t53fj6ttavh8l4jlfjdryc6mesd4w6uvpmzfsqqjvtu0xd"},{"type":"future","id":"2177527202823505610844479366424698260670813913152550670302738921219693374616field","value":"{\n  program_id: token_registry.aleo,\n  function_name: burn_private,\n  arguments: [\n    3443843282313283355522573239085696902919850365217539366784739393210722344986field,\n    2853086u128,\n    aleo1tjkv7vquk6yldxz53ecwsy5csnun43rfaknpkjc97v5223dlnyxsglv7nm,\n    5783861720504029593520331872442756678068735468923730684279741068753131773333field\n  ]\n}"}],"tpk":"8426225807947287980879824833030089440060785195861154519084544916641544071836group","tcm":"3226339871444496417979841037237975848011574524309845233165930705339306709897field","scm":"6845182532650964173356391969005331370591444046632036068754797772530920467754field"}"#;
     pub const TEST_PRIVATE_KEY: &str = "APrivateKey1zkp6rE5FSWGD3jxrsAT64aZutFs3w6xvF8uQzGZKJEKsN8j";
+    pub const TRANSITION_TESTNET: &str = r#"{"id":"au1u62jasyx78x9hktak24awyj38fz73aseq8g9cx98u8egd9pj9uxq3u6s2z","program":"hello_hello.aleo","function":"hello","inputs":[{"type":"public","id":"3748790614260807060977840590007893602934308327222309419419577452790958781330field","value":"1u32"},{"type":"private","id":"5954208307642819953251922459490586292095132973876550778604572231610245257004field","value":"ciphertext1qyq0m5mp0d2gzh2pv9p25z70gz2avhqdt3dp8y8thzwf3aq6g35zcqcuyptz3"}],"outputs":[{"type":"private","id":"1557506318887190915592751299113729867877933642317637206076176689093854281418field","value":"ciphertext1qyqzmhw8ln9r6uuyh0n5jrsqlt25wdggqp3d9yqyttpr3g7g00k2sysdf9rmv"}],"tpk":"7532444547840484531569841377269810017844130178606467837628364672670182422388group","tcm":"7292056195970541935877520517416922164990366931599720071937561392936678536563field","scm":"8283770351301010771186520129040704279224805960417079922462917369178354050332field"}"#;
+    pub const TRANSITION_TESTNET_DECRYPTED: &str = r#"{"id":"au1mhdz6jqm973v5vfkz2pwgv63p340c9tpvydxha2zs8w03746qcpqvx3yye","program":"hello_hello.aleo","function":"hello","inputs":[{"type":"public","id":"3748790614260807060977840590007893602934308327222309419419577452790958781330field","value":"1u32"},{"type":"public","id":"5954208307642819953251922459490586292095132973876550778604572231610245257004field","value":"2u32"}],"outputs":[{"type":"public","id":"1557506318887190915592751299113729867877933642317637206076176689093854281418field","value":"3u32"}],"tpk":"7532444547840484531569841377269810017844130178606467837628364672670182422388group","tcm":"7292056195970541935877520517416922164990366931599720071937561392936678536563field","scm":"8283770351301010771186520129040704279224805960417079922462917369178354050332field"}"#;
+    pub const TRANSITION_MAINNET: &str = r#"{"id":"au1mguuz0dh20f78802m4z0py7n08xhl0pz60llzck63mhl8pc8l5xqxpwgtn","program":"hello_hello.aleo","function":"main","inputs":[{"type":"public","id":"6393584049543470937057043098611271993206122889317039351966319038535020834557field","value": "1u32"},{"type":"private","id":"8207446256045172951742235001162005156507562935942883128759030124682934277495field","value":"ciphertext1qyqqgz9qnupeld9vr4vuwp6yrpmhgtkvmgag5m7mmrruw0r6je666qgqdswk3"}],"outputs":[{"type":"private","id":"127469473292952941321346770257126666363371158501875622169294663492714835110field","value":"ciphertext1qyqyapkjuxm9dcslgyjf7hkr2k3dek500z40gjspnwvll0uawj23vzgggc405"}],"tpk":"7647553513996966044119163122930125808381703910407273818947266861843062002251group","tcm":"4479413938380109857414238205380483440836495997450846894155088299187217672609field","scm":"6461007226176477784737642021400489186736987671609840640950580467598882134642field"}"#;
+    pub const TRANSITION_MAINNET_DECRYPTED: &str = r#"{"id":"au1jl2ur42sj7hwe4r0alv6gnklqxj0fszrvu3q82gjcls5x6q9pyzqdgmu2k","program":"hello_hello.aleo","function":"main","inputs":[{"type":"public","id":"6393584049543470937057043098611271993206122889317039351966319038535020834557field","value":"1u32"},{"type":"public","id":"8207446256045172951742235001162005156507562935942883128759030124682934277495field","value":"2u32"}],"outputs":[{"type":"public","id":"127469473292952941321346770257126666363371158501875622169294663492714835110field","value":"3u32"}],"tpk":"7647553513996966044119163122930125808381703910407273818947266861843062002251group","tcm":"4479413938380109857414238205380483440836495997450846894155088299187217672609field","scm":"6461007226176477784737642021400489186736987671609840640950580467598882134642field"}"#;
+    pub const PRIVATE_KEY: &str = "APrivateKey1zkp8CZNn3yeCseEtxuVPbDCwSyhGW6yZKUYKfgXmcpoGPWH";
 
     #[test]
     fn transition_to_and_from_serialization() {
@@ -334,7 +410,7 @@ mod tests {
 
     #[wasm_bindgen_test]
     fn test_input_correctness() {
-        let transition = Transition::from_string(TRANSITION).unwrap();
+        let transition = Transition::from_str(TRANSITION).unwrap();
         let inputs = transition.inputs(true);
         let input_1 = Object::from(inputs.get(0));
         let input_2 = inputs.get(1);
@@ -406,4 +482,78 @@ mod tests {
             "5783861720504029593520331872442756678068735468923730684279741068753131773333field"
         );
     }
+
+    #[wasm_bindgen_test]
+    #[cfg(feature = "testnet")]
+    fn test_transition_decryption() {
+        // Create a view key from the test private key.
+        let private_key = PrivateKey::from_str(PRIVATE_KEY).unwrap();
+        let view_key = ViewKey::from_private_key(&private_key);
+
+        // Get a transition with records.
+        let transition = Transition::from_string(TRANSITION_TESTNET).unwrap();
+
+        // Get the transition view key.
+        let tvk = transition.tvk(&view_key);
+
+        // Decrypt the transition using the transition view key.
+        let decrypted_transition = transition.decrypt_transition(&tvk).unwrap();
+
+        assert_eq!(decrypted_transition.to_string(), TRANSITION_TESTNET_DECRYPTED);
+    }
+
+    #[wasm_bindgen_test]
+    #[cfg(feature = "mainnet")]
+    fn test_transition_decryption_mainnet() {
+        // Create a view key from the test private key.
+        let private_key = PrivateKey::from_str(PRIVATE_KEY).unwrap();
+        let view_key = ViewKey::from_private_key(&private_key);
+
+        // Get a transition with records.
+        let transition = Transition::from_string(TRANSITION_MAINNET).unwrap();
+
+        // Get the transition view key.
+        let tvk = transition.tvk(&view_key);
+
+        // Decrypt the transition using the transition view key.
+        let decrypted_transition = transition.decrypt_transition(&tvk).unwrap();
+
+        assert_eq!(decrypted_transition.to_string(), TRANSITION_MAINNET_DECRYPTED);
+    }
+
+    #[wasm_bindgen_test]
+    #[cfg(feature = "testnet")]
+    fn test_transition_decrypt_testnet_invalid_vk() {
+        // Create a view key from the test private key.
+        let private_key = PrivateKey::from_str(TEST_PRIVATE_KEY).unwrap();
+        let view_key = ViewKey::from_private_key(&private_key);
+
+        // Get a transition with records.
+        let transition = Transition::from_string(TRANSITION_TESTNET).unwrap();
+
+        // Create an invalid transition view key.
+        let invalid_tvk = transition.tvk(&view_key);
+
+        // Attempt to decrypt the transition using the invalid transition view key.
+        let result = transition.decrypt_transition(&invalid_tvk);
+        assert!(result.is_err());
+    }
+
+    #[wasm_bindgen_test]
+    #[cfg(feature = "mainnet")]
+    fn test_transition_decrypt_testnet_invalid_vk() {
+        // Create a view key from the test private key.
+        let private_key = PrivateKey::from_str(TEST_PRIVATE_KEY).unwrap();
+        let view_key = ViewKey::from_private_key(&private_key);
+
+        // Get a transition with records.
+        let transition = Transition::from_string(TRANSITION_MAINNET).unwrap();
+
+        // Create an invalid transition view key.
+        let invalid_tvk = transition.tvk(&view_key);
+
+        // Attempt to decrypt the transition using the invalid transition view key.
+        let result = transition.decrypt_transition(&invalid_tvk);
+        assert!(result.is_err());
+    }
 }

wasm/src/ledger/transition.rs

@@ -174,8 +174,9 @@ pub use types::{Field, Group, Scalar};
 mod thread_pool;
 
 mod utilities;
+pub use utilities::EncryptionToolkit;
 #[cfg(test)]
-pub use utilities::*;
+pub use utilities::test::*;
 
 #[cfg(test)]
 mod thread_pool {

wasm/src/lib.rs

@@ -17,7 +17,7 @@
 use crate::{
     insert_plaintext,
     object,
-    types::native::{EntryNative, RecordPlaintextNative},
+    types::native::{PlaintextEntryNative, RecordPlaintextNative},
 };
 use js_sys::{Object, Reflect};
 
@@ -35,13 +35,13 @@ pub fn record_to_js_object(record: &RecordPlaintextNative) -> Result<Object, Str
     // Get the metadata from the record and insert it into the javascript object.
     record.data().iter().for_each(|(key, value)| {
         match value {
-            EntryNative::Public(plaintext) => {
+            PlaintextEntryNative::Public(plaintext) => {
                 insert_plaintext(&js_record, key, plaintext);
             }
-            EntryNative::Constant(plaintext) => {
+            PlaintextEntryNative::Constant(plaintext) => {
                 insert_plaintext(&js_record, key, plaintext);
             }
-            EntryNative::Private(plaintext) => {
+            PlaintextEntryNative::Private(plaintext) => {
                 insert_plaintext(&js_record, key, plaintext);
             }
         };

wasm/src/programs/data/helpers/record.rs

@@ -20,15 +20,7 @@ use crate::{
     Transition,
     log,
     native::ProgramIDNative,
-    types::native::{
-        CurrentNetwork,
-        ExecutionNative,
-        IdentifierNative,
-        ProcessNative,
-        ProgramID,
-        ProgramNative,
-        VerifyingKeyNative,
-    },
+    types::native::{ExecutionNative, IdentifierNative, ProcessNative, ProgramNative, VerifyingKeyNative},
 };
 use snarkvm_algorithms::snark::varuna::VarunaVersion;