Merge pull request #3004 from ProvableHQ/feat/snark-verify

[Feature] Implement `snark.verify` opcode

Author: vicsn

.circleci/config.yml

@@ -58,7 +58,7 @@ commands:
 
             # Put cargo/rustup first in PATH for this step and subsequent steps
             $Env:Path = "$Env:USERPROFILE\.cargo\bin;$Env:Path"
-            
+
             # Select the toolchain
             rustup default 1.88.0-x86_64-pc-windows-msvc
 

Cargo.lock

@@ -14,6 +14,8 @@
 // limitations under the License.
 
 use core::fmt::Debug;
+use snarkvm_utilities::{FromBytes, ToBytes, io_error};
+use std::io;
 
 /// A trait to specify the SNARK mode.
 pub trait SNARKMode: 'static + Copy + Clone + Debug + PartialEq + Eq + Sync + Send {
@@ -37,8 +39,26 @@ impl SNARKMode for VarunaNonHidingMode {
 }
 
 /// The different Varuna Versions.
+#[repr(u8)]
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub enum VarunaVersion {
     V1 = 1,
     V2 = 2,
 }
+
+impl ToBytes for VarunaVersion {
+    fn write_le<W: io::Write>(&self, writer: W) -> io::Result<()> {
+        (*self as u8).write_le(writer)
+    }
+}
+
+impl FromBytes for VarunaVersion {
+    fn read_le<R: io::Read>(reader: R) -> io::Result<Self> {
+        match u8::read_le(reader)? {
+            0 => Err(io_error("Zero is not a valid Varuna version")),
+            1 => Ok(Self::V1),
+            2 => Ok(Self::V2),
+            _ => Err(io_error("Invalid Varuna version")),
+        }
+    }
+}

algorithms/src/snark/varuna/mode.rs

@@ -14,7 +14,7 @@
 // limitations under the License.
 
 use super::*;
-use snarkvm_circuit_types::U8;
+use snarkvm_circuit_types::{U8, U32};
 
 impl<A: Aleo> ToBits for Future<A> {
     type Boolean = Boolean<A>;
@@ -39,7 +39,11 @@ impl<A: Aleo> ToBits for Future<A> {
         for argument in &self.arguments {
             let argument_bits = argument.to_bits_le();
             // Write the size of the argument.
-            U16::constant(console::U16::new(argument_bits.len() as u16)).write_bits_le(vec);
+            let argument_length = argument_bits.len();
+            match argument_length <= u16::MAX as usize {
+                true => U16::constant(console::U16::new(argument_length as u16)).write_bits_le(vec),
+                false => U32::constant(console::U32::new(argument_length as u32)).write_bits_le(vec),
+            }
             // Write the argument.
             vec.extend_from_slice(&argument_bits);
         }
@@ -65,7 +69,11 @@ impl<A: Aleo> ToBits for Future<A> {
         for argument in &self.arguments {
             let argument_bits = argument.to_bits_be();
             // Write the size of the argument.
-            U16::constant(console::U16::new(argument_bits.len() as u16)).write_bits_be(vec);
+            let argument_length = argument_bits.len();
+            match argument_length <= u16::MAX as usize {
+                true => U16::constant(console::U16::new(argument_length as u16)).write_bits_be(vec),
+                false => U32::constant(console::U32::new(argument_length as u32)).write_bits_be(vec),
+            }
             // Write the argument.
             vec.extend_from_slice(&argument_bits);
         }

circuit/program/src/data/future/to_bits.rs

@@ -49,8 +49,9 @@ pub enum ConsensusVersion {
     V12 = 12,
     /// V13: Introduces external structs.
     V13 = 13,
-    /// V14: Increase the program size limit to 512 kB and transaction size limit to 540 kB.
-    ///      Introduces `aleo::GENERATOR` and `aleo::GENERATOR_POWERS` opcodes.
+    /// V14: Increase the program size limit to 512 kB, the transaction size limit to 540 kB,
+    ///      the array size limit to 2048, and the `Future` argument bit size to 32 bits.
+    ///      Introduces `aleo::GENERATOR`, `aleo::GENERATOR_POWERS`, and `snark.verify` opcodes.
     V14 = 14,
 }
 
@@ -318,6 +319,11 @@ mod tests {
             assert!(*version > previous_version);
             previous_version = *version;
         }
+        let mut previous_version = N::MAX_ARRAY_ELEMENTS.first().unwrap().0;
+        for (version, _) in N::MAX_ARRAY_ELEMENTS.iter().skip(1) {
+            assert!(*version > previous_version);
+            previous_version = *version;
+        }
         let mut previous_version = N::MAX_PROGRAM_SIZE.first().unwrap().0;
         for (version, _) in N::MAX_PROGRAM_SIZE.iter().skip(1) {
             assert!(*version > previous_version);
@@ -362,6 +368,12 @@ mod tests {
             // Double-check that consensus_config_value returns the correct value.
             assert_eq!(consensus_config_value!(N, TRANSACTION_SPEND_LIMIT, height).unwrap(), *value);
         }
+        for (version, value) in N::MAX_ARRAY_ELEMENTS.iter() {
+            // Ensure that the height at which an update occurs are present in CONSENSUS_VERSION_HEIGHTS.
+            let height = N::CONSENSUS_VERSION_HEIGHTS().iter().find(|(c_version, _)| *c_version == *version).unwrap().1;
+            // Double-check that consensus_config_value returns the correct value.
+            assert_eq!(consensus_config_value!(N, MAX_ARRAY_ELEMENTS, height).unwrap(), *value);
+        }
         for (version, value) in N::MAX_PROGRAM_SIZE.iter() {
             // Ensure that the height at which an update occurs are present in CONSENSUS_VERSION_HEIGHTS.
             let height = N::CONSENSUS_VERSION_HEIGHTS().iter().find(|(c_version, _)| *c_version == *version).unwrap().1;
@@ -387,6 +399,7 @@ mod tests {
         for (_, height) in N::CONSENSUS_VERSION_HEIGHTS().iter() {
             assert!(consensus_config_value!(N, MAX_CERTIFICATES, *height).is_some());
             assert!(consensus_config_value!(N, TRANSACTION_SPEND_LIMIT, *height).is_some());
+            assert!(consensus_config_value!(N, MAX_ARRAY_ELEMENTS, *height).is_some());
             assert!(consensus_config_value!(N, MAX_PROGRAM_SIZE, *height).is_some());
             assert!(consensus_config_value!(N, MAX_TRANSACTION_SIZE, *height).is_some());
             assert!(consensus_config_value!(N, MAX_WRITES, *height).is_some());
@@ -403,6 +416,16 @@ mod tests {
         }
     }
 
+    /// Ensure that `MAX_ARRAY_ELEMENTS` increases and is correctly defined.
+    /// See the constant declaration for an explanation why.
+    fn max_array_elements_increasing<N: Network>() {
+        let mut previous_value = N::MAX_ARRAY_ELEMENTS.first().unwrap().1;
+        for (_, value) in N::MAX_ARRAY_ELEMENTS.iter().skip(1) {
+            assert!(*value >= previous_value);
+            previous_value = *value;
+        }
+    }
+
     /// Ensure that `MAX_TRANSACTION_SIZE` is at least 28KB greater than `MAX_PROGRAM_SIZE` for all consensus versions.
     /// This overhead accounts for proofs, signatures, and other transaction metadata.
     fn transaction_size_exceeds_program_size<N: Network>() {
@@ -425,6 +448,7 @@ mod tests {
         let _ = [N1::CONSENSUS_VERSION_HEIGHTS, N2::CONSENSUS_VERSION_HEIGHTS, N3::CONSENSUS_VERSION_HEIGHTS];
         let _ = [N1::MAX_CERTIFICATES, N2::MAX_CERTIFICATES, N3::MAX_CERTIFICATES];
         let _ = [N1::TRANSACTION_SPEND_LIMIT, N2::TRANSACTION_SPEND_LIMIT, N3::TRANSACTION_SPEND_LIMIT];
+        let _ = [N1::MAX_ARRAY_ELEMENTS, N2::MAX_ARRAY_ELEMENTS, N3::MAX_ARRAY_ELEMENTS];
         let _ = [N1::MAX_PROGRAM_SIZE, N2::MAX_PROGRAM_SIZE, N3::MAX_PROGRAM_SIZE];
         let _ = [N1::MAX_TRANSACTION_SIZE, N2::MAX_TRANSACTION_SIZE, N3::MAX_TRANSACTION_SIZE];
         let _ = [N1::MAX_WRITES, N2::MAX_WRITES, N3::MAX_WRITES];
@@ -470,6 +494,10 @@ mod tests {
         max_certificates_increasing::<TestnetV0>();
         max_certificates_increasing::<CanaryV0>();
 
+        max_array_elements_increasing::<MainnetV0>();
+        max_array_elements_increasing::<TestnetV0>();
+        max_array_elements_increasing::<CanaryV0>();
+
         transaction_size_exceeds_program_size::<MainnetV0>();
         transaction_size_exceeds_program_size::<TestnetV0>();
         transaction_size_exceeds_program_size::<CanaryV0>();

console/network/src/consensus_heights.rs

@@ -192,8 +192,9 @@ pub trait Network:
 
     /// The minimum number of elements in an array.
     const MIN_ARRAY_ELEMENTS: usize = 1; // This ensures the array is not empty.
-    /// The maximum number of elements in an array.
-    const MAX_ARRAY_ELEMENTS: usize = 512;
+    ///  A list of (consensus_version, size) pairs indicating the maximum number of elements in an array.
+    const MAX_ARRAY_ELEMENTS: [(ConsensusVersion, usize); 3] =
+        [(ConsensusVersion::V1, 32), (ConsensusVersion::V11, 512), (ConsensusVersion::V14, 2048)];
 
     /// The minimum number of entries in a record.
     const MIN_RECORD_ENTRIES: usize = 1; // This accounts for 'record.owner'.
@@ -315,6 +316,11 @@ pub trait Network:
     fn CONSENSUS_HEIGHT(version: ConsensusVersion) -> Result<u32> {
         Ok(Self::CONSENSUS_VERSION_HEIGHTS().get(version as usize - 1).ok_or(anyhow!("Invalid consensus version"))?.1)
     }
+    /// Returns the last `MAX_ARRAY_ELEMENTS` value.
+    #[allow(non_snake_case)]
+    fn LATEST_MAX_ARRAY_ELEMENTS() -> usize {
+        Self::MAX_ARRAY_ELEMENTS.last().expect("MAX_ARRAY_ELEMENTS must have at least one entry").1
+    }
     /// Returns the last `MAX_CERTIFICATES` value.
     #[allow(non_snake_case)]
     fn LATEST_MAX_CERTIFICATES() -> u16 {

console/network/src/lib.rs

@@ -17,6 +17,7 @@ use super::*;
 
 impl<N: Network> ToBits for Future<N> {
     /// Returns the future as a list of **little-endian** bits.
+    // Note: Any updates to bit serialization will require updating `FinalizeType::future_size_in_bits`.
     #[inline]
     fn write_bits_le(&self, vec: &mut Vec<bool>) {
         // Write the bits for the program ID.
@@ -39,14 +40,23 @@ impl<N: Network> ToBits for Future<N> {
             let argument_bits = argument.to_bits_le();
 
             // Write the size of the argument.
-            u16::try_from(argument_bits.len()).or_halt_with::<N>("argument exceeds u16::MAX bits").write_bits_le(vec);
+            let argument_length = argument_bits.len();
+            match argument_length <= u16::MAX as usize {
+                true => u16::try_from(argument_length)
+                    .or_halt_with::<N>("argument exceeds u16::MAX bits")
+                    .write_bits_le(vec),
+                false => u32::try_from(argument_length)
+                    .or_halt_with::<N>("argument exceeds u32::MAX bits")
+                    .write_bits_le(vec),
+            }
 
             // Write the argument.
             vec.extend_from_slice(&argument_bits);
         }
     }
 
     /// Returns the future as a list of **big-endian** bits.
+    // Note: Any updates to bit serialization will require updating `FinalizeType::future_size_in_bits`.
     #[inline]
     fn write_bits_be(&self, vec: &mut Vec<bool>) {
         // Write the bits for the program ID.
@@ -69,7 +79,15 @@ impl<N: Network> ToBits for Future<N> {
             let argument_bits = argument.to_bits_be();
 
             // Write the size of the argument.
-            u16::try_from(argument_bits.len()).or_halt_with::<N>("argument exceeds u16::MAX bits").write_bits_be(vec);
+            let argument_length = argument_bits.len();
+            match argument_length <= u16::MAX as usize {
+                true => u16::try_from(argument_length)
+                    .or_halt_with::<N>("argument exceeds u16::MAX bits")
+                    .write_bits_be(vec),
+                false => u32::try_from(argument_length)
+                    .or_halt_with::<N>("argument exceeds u32::MAX bits")
+                    .write_bits_be(vec),
+            }
 
             // Write the argument.
             vec.extend_from_slice(&argument_bits);

console/program/src/data/future/to_bits.rs

@@ -61,7 +61,7 @@ impl<N: Network> Plaintext<N> {
             2 => {
                 // Read the length of the array.
                 let num_elements = u32::read_le(&mut reader)?;
-                if num_elements as usize > N::MAX_ARRAY_ELEMENTS {
+                if num_elements as usize > N::LATEST_MAX_ARRAY_ELEMENTS() {
                     return Err(error("Failed to deserialize plaintext: Array exceeds maximum length"));
                 }
                 // Read the elements.

console/program/src/data/plaintext/bytes.rs

@@ -93,7 +93,7 @@ impl<N: Network> Plaintext<N> {
         // Array
         else if variant == PlaintextType::<N>::ARRAY_PREFIX_BITS {
             let num_elements = u32::from_bits_le(next_bits(32)?)?;
-            if num_elements as usize > N::MAX_ARRAY_ELEMENTS {
+            if num_elements as usize > N::LATEST_MAX_ARRAY_ELEMENTS() {
                 bail!("Array exceeds maximum of elements.");
             }
 
@@ -176,7 +176,7 @@ impl<N: Network> Plaintext<N> {
         // Array
         else if variant == PlaintextType::<N>::ARRAY_PREFIX_BITS {
             let num_elements = u32::from_bits_be(next_bits(32)?)?;
-            if num_elements as usize > N::MAX_ARRAY_ELEMENTS {
+            if num_elements as usize > N::LATEST_MAX_ARRAY_ELEMENTS() {
                 bail!("Array exceeds maximum of elements.");
             }
 

console/program/src/data/plaintext/from_bits.rs

@@ -71,6 +71,40 @@ impl<N: Network> Plaintext<N> {
             _ => bail!("Expected a bit array, found a non-array plaintext."),
         }
     }
+
+    /// Returns the `Plaintext` as a `Vec<u8>`, if it is a u8 array.
+    pub fn as_byte_array(&self) -> Result<Vec<u8>> {
+        match self {
+            Self::Array(elements, _) => {
+                let mut bytes = Vec::with_capacity(elements.len());
+                for element in elements {
+                    match element {
+                        Self::Literal(Literal::U8(byte), _) => bytes.push(**byte),
+                        _ => bail!("Expected a u8 array, found a non-u8 element."),
+                    }
+                }
+                Ok(bytes)
+            }
+            _ => bail!("Expected a u8 array, found a non-array plaintext."),
+        }
+    }
+
+    /// Returns the `Plaintext` as a `Vec<N::Field>`, if it is a field array.
+    pub fn as_field_array(&self) -> Result<Vec<Field<N>>> {
+        match self {
+            Self::Array(elements, _) => {
+                let mut fields = Vec::with_capacity(elements.len());
+                for element in elements {
+                    match element {
+                        Self::Literal(Literal::Field(field), _) => fields.push(*field),
+                        _ => bail!("Expected an array of fields, found a non-field element."),
+                    }
+                }
+                Ok(fields)
+            }
+            _ => bail!("Expected an array of fields, found a non-array plaintext."),
+        }
+    }
 }
 
 impl<N: Network> From<Literal<N>> for Plaintext<N> {