Add _be suffix to BE compress/decompress functions

Author: LStan

bn254/src/compression.rs

@@ -126,9 +126,20 @@ mod target_arch {
         LE,
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g1_decompress_be` instead"
+    )]
     #[inline(always)]
     pub fn alt_bn128_g1_decompress(
         g1_bytes: &[u8],
+    ) -> Result<[u8; ALT_BN128_G1_POINT_SIZE], AltBn128CompressionError> {
+        alt_bn128_g1_decompress_be(g1_bytes)
+    }
+
+    #[inline(always)]
+    pub fn alt_bn128_g1_decompress_be(
+        g1_bytes: &[u8],
     ) -> Result<[u8; ALT_BN128_G1_POINT_SIZE], AltBn128CompressionError> {
         alt_bn128_apply_g1_decompress(g1_bytes, Endianness::BE)
     }
@@ -173,12 +184,26 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g1_compress_be` instead"
+    )]
     #[inline(always)]
     pub fn alt_bn128_g1_compress(
         g1_bytes: &[u8],
     ) -> Result<
         [u8; alt_bn128_compression_size::ALT_BN128_G1_COMPRESSED_POINT_SIZE],
         AltBn128CompressionError,
+    > {
+        alt_bn128_g1_compress_be(g1_bytes)
+    }
+
+    #[inline(always)]
+    pub fn alt_bn128_g1_compress_be(
+        g1_bytes: &[u8],
+    ) -> Result<
+        [u8; alt_bn128_compression_size::ALT_BN128_G1_COMPRESSED_POINT_SIZE],
+        AltBn128CompressionError,
     > {
         alt_bn128_apply_g1_compress(g1_bytes, Endianness::BE)
     }
@@ -221,9 +246,20 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g2_decompress_be` instead"
+    )]
     #[inline(always)]
     pub fn alt_bn128_g2_decompress(
         g2_bytes: &[u8],
+    ) -> Result<[u8; ALT_BN128_G2_POINT_SIZE], AltBn128CompressionError> {
+        alt_bn128_g2_decompress_be(g2_bytes)
+    }
+
+    #[inline(always)]
+    pub fn alt_bn128_g2_decompress_be(
+        g2_bytes: &[u8],
     ) -> Result<[u8; ALT_BN128_G2_POINT_SIZE], AltBn128CompressionError> {
         alt_bn128_apply_g2_decompress(g2_bytes, Endianness::BE)
     }
@@ -268,12 +304,26 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g2_compress_be` instead"
+    )]
     #[inline(always)]
     pub fn alt_bn128_g2_compress(
         g2_bytes: &[u8],
     ) -> Result<
         [u8; alt_bn128_compression_size::ALT_BN128_G2_COMPRESSED_POINT_SIZE],
         AltBn128CompressionError,
+    > {
+        alt_bn128_g2_compress_be(g2_bytes)
+    }
+
+    #[inline(always)]
+    pub fn alt_bn128_g2_compress_be(
+        g2_bytes: &[u8],
+    ) -> Result<
+        [u8; alt_bn128_compression_size::ALT_BN128_G2_COMPRESSED_POINT_SIZE],
+        AltBn128CompressionError,
     > {
         alt_bn128_apply_g2_compress(g2_bytes, Endianness::BE)
     }
@@ -342,6 +392,10 @@ mod target_arch {
         solana_define_syscall::definitions as syscalls,
     };
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g1_compress_be` instead"
+    )]
     pub fn alt_bn128_g1_compress(
         input: &[u8],
     ) -> Result<[u8; ALT_BN128_G1_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
@@ -361,6 +415,25 @@ mod target_arch {
         }
     }
 
+    pub fn alt_bn128_g1_compress_be(
+        input: &[u8; ALT_BN128_G1_POINT_SIZE],
+    ) -> Result<[u8; ALT_BN128_G1_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
+        let mut result_buffer = [0; ALT_BN128_G1_COMPRESSED_POINT_SIZE];
+        let result = unsafe {
+            syscalls::sol_alt_bn128_compression(
+                ALT_BN128_G1_COMPRESS_BE,
+                input as *const _ as *const u8,
+                input.len() as u64,
+                &mut result_buffer as *mut _ as *mut u8,
+            )
+        };
+
+        match result {
+            0 => Ok(result_buffer),
+            _ => Err(AltBn128CompressionError::UnexpectedError),
+        }
+    }
+
     pub fn alt_bn128_g1_compress_le(
         input: &[u8; ALT_BN128_G1_POINT_SIZE],
     ) -> Result<[u8; ALT_BN128_G1_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
@@ -380,6 +453,10 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g1_decompress_be` instead"
+    )]
     pub fn alt_bn128_g1_decompress(
         input: &[u8],
     ) -> Result<[u8; ALT_BN128_G1_POINT_SIZE], AltBn128CompressionError> {
@@ -399,6 +476,25 @@ mod target_arch {
         }
     }
 
+    pub fn alt_bn128_g1_decompress_be(
+        input: &[u8; ALT_BN128_G1_COMPRESSED_POINT_SIZE],
+    ) -> Result<[u8; ALT_BN128_G1_POINT_SIZE], AltBn128CompressionError> {
+        let mut result_buffer = [0; ALT_BN128_G1_POINT_SIZE];
+        let result = unsafe {
+            syscalls::sol_alt_bn128_compression(
+                ALT_BN128_G1_DECOMPRESS_BE,
+                input as *const _ as *const u8,
+                input.len() as u64,
+                &mut result_buffer as *mut _ as *mut u8,
+            )
+        };
+
+        match result {
+            0 => Ok(result_buffer),
+            _ => Err(AltBn128CompressionError::UnexpectedError),
+        }
+    }
+
     pub fn alt_bn128_g1_decompress_le(
         input: &[u8; ALT_BN128_G1_COMPRESSED_POINT_SIZE],
     ) -> Result<[u8; ALT_BN128_G1_POINT_SIZE], AltBn128CompressionError> {
@@ -418,6 +514,10 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g2_compress_be` instead"
+    )]
     pub fn alt_bn128_g2_compress(
         input: &[u8],
     ) -> Result<[u8; ALT_BN128_G2_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
@@ -437,6 +537,25 @@ mod target_arch {
         }
     }
 
+    pub fn alt_bn128_g2_compress_be(
+        input: &[u8; ALT_BN128_G2_POINT_SIZE],
+    ) -> Result<[u8; ALT_BN128_G2_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
+        let mut result_buffer = [0; ALT_BN128_G2_COMPRESSED_POINT_SIZE];
+        let result = unsafe {
+            syscalls::sol_alt_bn128_compression(
+                ALT_BN128_G2_COMPRESS_BE,
+                input as *const _ as *const u8,
+                input.len() as u64,
+                &mut result_buffer as *mut _ as *mut u8,
+            )
+        };
+
+        match result {
+            0 => Ok(result_buffer),
+            _ => Err(AltBn128CompressionError::UnexpectedError),
+        }
+    }
+
     pub fn alt_bn128_g2_compress_le(
         input: &[u8; ALT_BN128_G2_POINT_SIZE],
     ) -> Result<[u8; ALT_BN128_G2_COMPRESSED_POINT_SIZE], AltBn128CompressionError> {
@@ -456,8 +575,19 @@ mod target_arch {
         }
     }
 
+    #[deprecated(
+        since = "3.2.0",
+        note = "Please use `alt_bn128_g2_decompress_be` instead"
+    )]
+    #[inline(always)]
     pub fn alt_bn128_g2_decompress(
         input: &[u8; ALT_BN128_G2_COMPRESSED_POINT_SIZE],
+    ) -> Result<[u8; ALT_BN128_G2_POINT_SIZE], AltBn128CompressionError> {
+        alt_bn128_g2_decompress_be(input)
+    }
+
+    pub fn alt_bn128_g2_decompress_be(
+        input: &[u8; ALT_BN128_G2_COMPRESSED_POINT_SIZE],
     ) -> Result<[u8; ALT_BN128_G2_POINT_SIZE], AltBn128CompressionError> {
         let mut result_buffer = [0; ALT_BN128_G2_POINT_SIZE];
         let result = unsafe {
@@ -503,9 +633,9 @@ mod tests {
         ark_serialize::{CanonicalDeserialize, CanonicalSerialize, Compress, Validate},
         std::ops::Neg,
         target_arch::{
-            alt_bn128_g1_compress, alt_bn128_g1_compress_le, alt_bn128_g1_decompress,
-            alt_bn128_g1_decompress_le, alt_bn128_g2_compress, alt_bn128_g2_compress_le,
-            alt_bn128_g2_decompress, alt_bn128_g2_decompress_le,
+            alt_bn128_g1_compress_be, alt_bn128_g1_compress_le, alt_bn128_g1_decompress_be,
+            alt_bn128_g1_decompress_le, alt_bn128_g2_compress_be, alt_bn128_g2_compress_le,
+            alt_bn128_g2_decompress_be, alt_bn128_g2_decompress_le,
         },
     };
     type G1 = ark_bn254::g1::G1Affine;
@@ -553,10 +683,10 @@ mod tests {
             // test be
             let compressed_ref: [u8; 32] = convert_endianness::<32, 32>(&compressed_ref);
 
-            let decompressed = alt_bn128_g1_decompress(compressed_ref.as_slice()).unwrap();
+            let decompressed = alt_bn128_g1_decompress_be(compressed_ref.as_slice()).unwrap();
 
             assert_eq!(
-                alt_bn128_g1_compress(&decompressed).unwrap(),
+                alt_bn128_g1_compress_be(&decompressed).unwrap(),
                 compressed_ref
             );
             assert_eq!(decompressed, *g1_be);
@@ -608,10 +738,10 @@ mod tests {
             // test be
             let compressed_ref: [u8; 64] = convert_endianness::<64, 64>(&compressed_ref);
 
-            let decompressed = alt_bn128_g2_decompress(compressed_ref.as_slice()).unwrap();
+            let decompressed = alt_bn128_g2_decompress_be(compressed_ref.as_slice()).unwrap();
 
             assert_eq!(
-                alt_bn128_g2_compress(&decompressed).unwrap(),
+                alt_bn128_g2_compress_be(&decompressed).unwrap(),
                 compressed_ref
             );
             assert_eq!(decompressed, *g2_be);
@@ -621,16 +751,16 @@ mod tests {
     #[test]
     fn alt_bn128_compression_g1_point_of_infitity() {
         let g1_bytes = vec![0u8; 64];
-        let g1_compressed = alt_bn128_g1_compress(&g1_bytes).unwrap();
-        let g1_decompressed = alt_bn128_g1_decompress(&g1_compressed).unwrap();
+        let g1_compressed = alt_bn128_g1_compress_be(&g1_bytes).unwrap();
+        let g1_decompressed = alt_bn128_g1_decompress_be(&g1_compressed).unwrap();
         assert_eq!(g1_bytes, g1_decompressed);
     }
 
     #[test]
     fn alt_bn128_compression_g2_point_of_infitity() {
         let g1_bytes = vec![0u8; 128];
-        let g1_compressed = alt_bn128_g2_compress(&g1_bytes).unwrap();
-        let g1_decompressed = alt_bn128_g2_decompress(&g1_compressed).unwrap();
+        let g1_compressed = alt_bn128_g2_compress_be(&g1_bytes).unwrap();
+        let g1_decompressed = alt_bn128_g2_decompress_be(&g1_compressed).unwrap();
         assert_eq!(g1_bytes, g1_decompressed);
     }
 }

bn254/tests/curve_operations.rs

@@ -130,11 +130,11 @@ fn alt_bn128_compression_pairing_test_input() {
             return;
         }
         let g1 = input[0..64].to_vec();
-        let g1_compressed = alt_bn128_g1_compress(&g1).unwrap();
-        assert_eq!(g1, alt_bn128_g1_decompress(&g1_compressed).unwrap());
+        let g1_compressed = alt_bn128_g1_compress_be(&g1).unwrap();
+        assert_eq!(g1, alt_bn128_g1_decompress_be(&g1_compressed).unwrap());
         let g2 = input[64..192].to_vec();
-        let g2_compressed = alt_bn128_g2_compress(&g2).unwrap();
-        assert_eq!(g2, alt_bn128_g2_decompress(&g2_compressed).unwrap());
+        let g2_compressed = alt_bn128_g2_compress_be(&g2).unwrap();
+        assert_eq!(g2, alt_bn128_g2_decompress_be(&g2_compressed).unwrap());
 
         // test le
         let g1_le = convert_endianness::<32, 64>(&g1.try_into().unwrap());