moving tests, adding publishing details, refactoring

Layr-Labs · May 31, 2024 · 40b4868 · 40b4868
1 parent eae7e8f
commit 40b4868
Show file tree

Hide file tree

Showing 28 changed files with 1,262 additions and 1,223 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,6 +8,10 @@ description = "This library offers a set of functions for generating and interac
 readme = "README.md"
 repository = "https://github.com/Layr-Labs/rust-kzg-bn254"
 license-file = "LICENSE"
+exclude = [
+    "tests/*",
+    "benches/*",
+]
 
 [dependencies]
 ark-bn254 = "0.4.0"
@@ -32,25 +36,46 @@ num_cpus = "^1.16.0"
 criterion = "0.5"
 lazy_static = "1.4"
 
+[[test]]
+name = "kzg"
+path = "tests/kzg_test.rs"
+
+[[test]]
+name = "blob"
+path = "tests/blob_test.rs"
+
+[[test]]
+name = "polynomial"
+path = "tests/polynomial_test.rs"
+
+[[test]]
+name = "helpers"
+path = "tests/helpers_test.rs"
+
 [[bench]]
 name = "bench_g1_ifft"
 harness = false
+path = "benches/bench_g1_ifft.rs"
 
 [[bench]]
 name = "bench_kzg_setup"
 harness = false
+path = "benches/bench_kzg_setup.rs"
 
 [[bench]]
 name = "bench_kzg_commit"
 harness = false
+path = "benches/bench_kzg_commit.rs"
 
 [[bench]]
 name = "bench_kzg_proof"
 harness = false
+path = "benches/bench_kzg_proof.rs"
 
 [[bench]]
 name = "bench_kzg_verify"
 harness = false
+path = "benches/bench_kzg_verify.rs"
 
 [profile.bench]
 opt-level = 3

diff --git a/benches/bench_g1_ifft.rs b/benches/bench_g1_ifft.rs
@@ -17,9 +17,9 @@ fn generate_powers_of_2(limit: u64) -> Vec<usize> {
 fn bench_g1_ifft(c: &mut Criterion) {
     c.bench_function("bench_g1_ifft", |b| {
         let kzg = Kzg::setup(
-            "src/test-files/mainnet-data/g1.131072.point",
+            "tests/test-files/mainnet-data/g1.131072.point",
             "",
-            "src/test-files/mainnet-data/g2.point.powerOf2",
+            "tests/test-files/mainnet-data/g2.point.powerOf2",
             3000,
             3000,
         )

diff --git a/benches/bench_kzg_commit.rs b/benches/bench_kzg_commit.rs
@@ -6,9 +6,9 @@ use std::time::Duration;
 fn bench_kzg_commit(c: &mut Criterion) {
     let mut rng = rand::thread_rng();
     let mut kzg = Kzg::setup(
-        "src/test-files/mainnet-data/g1.131072.point",
+        "tests/test-files/mainnet-data/g1.131072.point",
         "",
-        "src/test-files/mainnet-data/g2.point.powerOf2",
+        "tests/test-files/mainnet-data/g2.point.powerOf2",
         268435456,
         131072,
     )

diff --git a/benches/bench_kzg_proof.rs b/benches/bench_kzg_proof.rs
@@ -6,9 +6,9 @@ use std::time::Duration;
 fn bench_kzg_proof(c: &mut Criterion) {
     let mut rng = rand::thread_rng();
     let mut kzg = Kzg::setup(
-        "src/test-files/mainnet-data/g1.131072.point",
+        "tests/test-files/mainnet-data/g1.131072.point",
         "",
-        "src/test-files/mainnet-data/g2.point.powerOf2",
+        "tests/test-files/mainnet-data/g2.point.powerOf2",
         268435456,
         131072,
     )

diff --git a/benches/bench_kzg_setup.rs b/benches/bench_kzg_setup.rs
@@ -6,9 +6,9 @@ fn bench_kzg_setup(c: &mut Criterion) {
     c.bench_function("bench_kzg_setup", |b| {
         b.iter(|| {
             Kzg::setup(
-                "src/test-files/g1.point",
-                "src/test-files/g2.point",
-                "src/test-files/g2.point.powerOf2",
+                "tests/test-files/g1.point",
+                "tests/test-files/g2.point",
+                "tests/test-files/g2.point.powerOf2",
                 3000,
                 3000,
             )
@@ -17,9 +17,9 @@ fn bench_kzg_setup(c: &mut Criterion) {
 
         b.iter(|| {
             Kzg::setup(
-                "src/test-files/mainnet-data/g1.131072.point",
+                "tests/test-files/mainnet-data/g1.131072.point",
                 "",
-                "src/test-files/mainnet-data/g2.point.powerOf2",
+                "tests/test-files/mainnet-data/g2.point.powerOf2",
                 268435456,
                 131072,
             )

diff --git a/benches/bench_kzg_verify.rs b/benches/bench_kzg_verify.rs
@@ -6,9 +6,9 @@ use std::time::Duration;
 fn bench_kzg_verify(c: &mut Criterion) {
     let mut rng = rand::thread_rng();
     let mut kzg = Kzg::setup(
-        "src/test-files/mainnet-data/g1.131072.point",
+        "tests/test-files/mainnet-data/g1.131072.point",
         "",
-        "src/test-files/mainnet-data/g2.point.powerOf2",
+        "tests/test-files/mainnet-data/g2.point.powerOf2",
         268435456,
         131072,
     )

diff --git a/src/blob.rs b/src/blob.rs
@@ -85,150 +85,3 @@ impl Blob {
         }
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn test_already_padded() {
-        let mut blob = Blob::from_bytes_and_pad("hi".as_bytes());
-        let mut result = blob.pad_data();
-        assert_eq!(result, Err(BlobError::AlreadyPaddedError));
-        blob.remove_padding().unwrap();
-        result = blob.remove_padding();
-        assert_eq!(result, Err(BlobError::NotPaddedError));
-        assert_eq!(blob.to_polynomial(), Err(BlobError::NotPaddedError));
-    }
-
-    #[test]
-    fn test_convert_by_padding_empty_byte() {
-        use crate::consts::GETTYSBURG_ADDRESS_BYTES;
-
-        let mut blob = Blob::from_bytes_and_pad("hi".as_bytes());
-        assert_eq!(
-            blob.get_blob_data(),
-            vec![0, 104, 105],
-            "testing adding padding"
-        );
-        assert_eq!(blob.is_padded(), true, "has to be padded");
-
-        blob.remove_padding().unwrap();
-        assert_eq!(
-            blob.get_blob_data(),
-            vec![104, 105],
-            "testing removing padding"
-        );
-        assert_eq!(blob.is_padded(), false, "cannot be padded");
-
-        let result: Vec<u8> = vec![
-            0, 70, 111, 117, 114, 115, 99, 111, 114, 101, 32, 97, 110, 100, 32, 115, 101, 118, 101,
-            110, 32, 121, 101, 97, 114, 115, 32, 97, 103, 111, 32, 111, 0, 117, 114, 32, 102, 97,
-            116, 104, 101, 114, 115, 32, 98, 114, 111, 117, 103, 104, 116, 32, 102, 111, 114, 116,
-            104, 44, 32, 111, 110, 32, 116, 104, 0, 105, 115, 32, 99, 111, 110, 116, 105, 110, 101,
-            110, 116, 44, 32, 97, 32, 110, 101, 119, 32, 110, 97, 116, 105, 111, 110, 44, 32, 99,
-            111, 110, 0, 99, 101, 105, 118, 101, 100, 32, 105, 110, 32, 108, 105, 98, 101, 114,
-            116, 121, 44, 32, 97, 110, 100, 32, 100, 101, 100, 105, 99, 97, 116, 101, 0, 100, 32,
-            116, 111, 32, 116, 104, 101, 32, 112, 114, 111, 112, 111, 115, 105, 116, 105, 111, 110,
-            32, 116, 104, 97, 116, 32, 97, 108, 108, 32, 109, 0, 101, 110, 32, 97, 114, 101, 32,
-            99, 114, 101, 97, 116, 101, 100, 32, 101, 113, 117, 97, 108, 46, 32, 78, 111, 119, 32,
-            119, 101, 32, 97, 114, 0, 101, 32, 101, 110, 103, 97, 103, 101, 100, 32, 105, 110, 32,
-            97, 32, 103, 114, 101, 97, 116, 32, 99, 105, 118, 105, 108, 32, 119, 97, 114, 44, 0,
-            32, 116, 101, 115, 116, 105, 110, 103, 32, 119, 104, 101, 116, 104, 101, 114, 32, 116,
-            104, 97, 116, 32, 110, 97, 116, 105, 111, 110, 44, 32, 111, 0, 114, 32, 97, 110, 121,
-            32, 110, 97, 116, 105, 111, 110, 32, 115, 111, 32, 99, 111, 110, 99, 101, 105, 118,
-            101, 100, 44, 32, 97, 110, 100, 32, 0, 115, 111, 32, 100, 101, 100, 105, 99, 97, 116,
-            101, 100, 44, 32, 99, 97, 110, 32, 108, 111, 110, 103, 32, 101, 110, 100, 117, 114,
-            101, 46, 32, 0, 87, 101, 32, 97, 114, 101, 32, 109, 101, 116, 32, 111, 110, 32, 97, 32,
-            103, 114, 101, 97, 116, 32, 98, 97, 116, 116, 108, 101, 45, 102, 105, 0, 101, 108, 100,
-            32, 111, 102, 32, 116, 104, 97, 116, 32, 119, 97, 114, 46, 32, 87, 101, 32, 104, 97,
-            118, 101, 32, 99, 111, 109, 101, 32, 116, 0, 111, 32, 100, 101, 100, 105, 99, 97, 116,
-            101, 32, 97, 32, 112, 111, 114, 116, 105, 111, 110, 32, 111, 102, 32, 116, 104, 97,
-            116, 32, 102, 105, 0, 101, 108, 100, 44, 32, 97, 115, 32, 97, 32, 102, 105, 110, 97,
-            108, 32, 114, 101, 115, 116, 105, 110, 103, 45, 112, 108, 97, 99, 101, 32, 102, 0, 111,
-            114, 32, 116, 104, 111, 115, 101, 32, 119, 104, 111, 32, 104, 101, 114, 101, 32, 103,
-            97, 118, 101, 32, 116, 104, 101, 105, 114, 32, 108, 105, 0, 118, 101, 115, 44, 32, 116,
-            104, 97, 116, 32, 116, 104, 97, 116, 32, 110, 97, 116, 105, 111, 110, 32, 109, 105,
-            103, 104, 116, 32, 108, 105, 118, 0, 101, 46, 32, 73, 116, 32, 105, 115, 32, 97, 108,
-            116, 111, 103, 101, 116, 104, 101, 114, 32, 102, 105, 116, 116, 105, 110, 103, 32, 97,
-            110, 100, 0, 32, 112, 114, 111, 112, 101, 114, 32, 116, 104, 97, 116, 32, 119, 101, 32,
-            115, 104, 111, 117, 108, 100, 32, 100, 111, 32, 116, 104, 105, 115, 46, 0, 32, 66, 117,
-            116, 44, 32, 105, 110, 32, 97, 32, 108, 97, 114, 103, 101, 114, 32, 115, 101, 110, 115,
-            101, 44, 32, 119, 101, 32, 99, 97, 110, 0, 110, 111, 116, 32, 100, 101, 100, 105, 99,
-            97, 116, 101, 44, 32, 119, 101, 32, 99, 97, 110, 110, 111, 116, 32, 99, 111, 110, 115,
-            101, 99, 114, 0, 97, 116, 101, 226, 128, 148, 119, 101, 32, 99, 97, 110, 110, 111, 116,
-            32, 104, 97, 108, 108, 111, 119, 226, 128, 148, 116, 104, 105, 115, 32, 103, 0, 114,
-            111, 117, 110, 100, 46, 32, 84, 104, 101, 32, 98, 114, 97, 118, 101, 32, 109, 101, 110,
-            44, 32, 108, 105, 118, 105, 110, 103, 32, 97, 110, 0, 100, 32, 100, 101, 97, 100, 44,
-            32, 119, 104, 111, 32, 115, 116, 114, 117, 103, 103, 108, 101, 100, 32, 104, 101, 114,
-            101, 44, 32, 104, 97, 118, 0, 101, 32, 99, 111, 110, 115, 101, 99, 114, 97, 116, 101,
-            100, 32, 105, 116, 32, 102, 97, 114, 32, 97, 98, 111, 118, 101, 32, 111, 117, 114, 32,
-            0, 112, 111, 111, 114, 32, 112, 111, 119, 101, 114, 32, 116, 111, 32, 97, 100, 100, 32,
-            111, 114, 32, 100, 101, 116, 114, 97, 99, 116, 46, 32, 84, 0, 104, 101, 32, 119, 111,
-            114, 108, 100, 32, 119, 105, 108, 108, 32, 108, 105, 116, 116, 108, 101, 32, 110, 111,
-            116, 101, 44, 32, 110, 111, 114, 32, 0, 108, 111, 110, 103, 32, 114, 101, 109, 101,
-            109, 98, 101, 114, 32, 119, 104, 97, 116, 32, 119, 101, 32, 115, 97, 121, 32, 104, 101,
-            114, 101, 44, 0, 32, 98, 117, 116, 32, 105, 116, 32, 99, 97, 110, 32, 110, 101, 118,
-            101, 114, 32, 102, 111, 114, 103, 101, 116, 32, 119, 104, 97, 116, 32, 116, 0, 104,
-            101, 121, 32, 100, 105, 100, 32, 104, 101, 114, 101, 46, 32, 73, 116, 32, 105, 115, 32,
-            102, 111, 114, 32, 117, 115, 32, 116, 104, 101, 32, 0, 108, 105, 118, 105, 110, 103,
-            44, 32, 114, 97, 116, 104, 101, 114, 44, 32, 116, 111, 32, 98, 101, 32, 100, 101, 100,
-            105, 99, 97, 116, 101, 100, 0, 32, 104, 101, 114, 101, 32, 116, 111, 32, 116, 104, 101,
-            32, 117, 110, 102, 105, 110, 105, 115, 104, 101, 100, 32, 119, 111, 114, 107, 32, 119,
-            104, 0, 105, 99, 104, 32, 116, 104, 101, 121, 32, 119, 104, 111, 32, 102, 111, 117,
-            103, 104, 116, 32, 104, 101, 114, 101, 32, 104, 97, 118, 101, 32, 116, 0, 104, 117,
-            115, 32, 102, 97, 114, 32, 115, 111, 32, 110, 111, 98, 108, 121, 32, 97, 100, 118, 97,
-            110, 99, 101, 100, 46, 32, 73, 116, 32, 105, 0, 115, 32, 114, 97, 116, 104, 101, 114,
-            32, 102, 111, 114, 32, 117, 115, 32, 116, 111, 32, 98, 101, 32, 104, 101, 114, 101, 32,
-            100, 101, 100, 105, 0, 99, 97, 116, 101, 100, 32, 116, 111, 32, 116, 104, 101, 32, 103,
-            114, 101, 97, 116, 32, 116, 97, 115, 107, 32, 114, 101, 109, 97, 105, 110, 105, 0, 110,
-            103, 32, 98, 101, 102, 111, 114, 101, 32, 117, 115, 226, 128, 148, 116, 104, 97, 116,
-            32, 102, 114, 111, 109, 32, 116, 104, 101, 115, 101, 32, 0, 104, 111, 110, 111, 114,
-            101, 100, 32, 100, 101, 97, 100, 32, 119, 101, 32, 116, 97, 107, 101, 32, 105, 110, 99,
-            114, 101, 97, 115, 101, 100, 32, 0, 100, 101, 118, 111, 116, 105, 111, 110, 32, 116,
-            111, 32, 116, 104, 97, 116, 32, 99, 97, 117, 115, 101, 32, 102, 111, 114, 32, 119, 104,
-            105, 99, 0, 104, 32, 116, 104, 101, 121, 32, 104, 101, 114, 101, 32, 103, 97, 118, 101,
-            32, 116, 104, 101, 32, 108, 97, 115, 116, 32, 102, 117, 108, 108, 32, 0, 109, 101, 97,
-            115, 117, 114, 101, 32, 111, 102, 32, 100, 101, 118, 111, 116, 105, 111, 110, 226, 128,
-            148, 116, 104, 97, 116, 32, 119, 101, 32, 104, 0, 101, 114, 101, 32, 104, 105, 103,
-            104, 108, 121, 32, 114, 101, 115, 111, 108, 118, 101, 32, 116, 104, 97, 116, 32, 116,
-            104, 101, 115, 101, 32, 100, 0, 101, 97, 100, 32, 115, 104, 97, 108, 108, 32, 110, 111,
-            116, 32, 104, 97, 118, 101, 32, 100, 105, 101, 100, 32, 105, 110, 32, 118, 97, 105,
-            110, 0, 226, 128, 148, 116, 104, 97, 116, 32, 116, 104, 105, 115, 32, 110, 97, 116,
-            105, 111, 110, 44, 32, 117, 110, 100, 101, 114, 32, 71, 111, 100, 44, 0, 32, 115, 104,
-            97, 108, 108, 32, 104, 97, 118, 101, 32, 97, 32, 110, 101, 119, 32, 98, 105, 114, 116,
-            104, 32, 111, 102, 32, 102, 114, 101, 101, 0, 100, 111, 109, 44, 32, 97, 110, 100, 32,
-            116, 104, 97, 116, 32, 103, 111, 118, 101, 114, 110, 109, 101, 110, 116, 32, 111, 102,
-            32, 116, 104, 101, 0, 32, 112, 101, 111, 112, 108, 101, 44, 32, 98, 121, 32, 116, 104,
-            101, 32, 112, 101, 111, 112, 108, 101, 44, 32, 102, 111, 114, 32, 116, 104, 101, 0, 32,
-            112, 101, 111, 112, 108, 101, 44, 32, 115, 104, 97, 108, 108, 32, 110, 111, 116, 32,
-            112, 101, 114, 105, 115, 104, 32, 102, 114, 111, 109, 32, 0, 116, 104, 101, 32, 101,
-            97, 114, 116, 104, 46,
-        ];
-
-        blob = Blob::from_bytes_and_pad(GETTYSBURG_ADDRESS_BYTES);
-        assert_eq!(blob.get_blob_data(), result, "testing adding padding");
-        assert_eq!(blob.is_padded(), true, "has to be padded");
-        assert_eq!(blob.get_length_after_padding(), 1515);
-
-        blob.remove_padding().unwrap();
-        assert_eq!(blob.is_padded(), false, "cannot be padded");
-        assert_eq!(
-            blob.get_blob_data(),
-            GETTYSBURG_ADDRESS_BYTES,
-            "testing removing padding"
-        );
-    }
-
-    #[test]
-    fn test_new_blob_creation() {
-        use crate::consts::GETTYSBURG_ADDRESS_BYTES;
-        let blob_from = Blob::from_bytes_and_pad(GETTYSBURG_ADDRESS_BYTES);
-        let mut blob_raw = Blob::new(GETTYSBURG_ADDRESS_BYTES.to_vec());
-
-        blob_raw.pad_data().unwrap();
-        assert_eq!(blob_raw, blob_from, "testing adding padding");
-        assert_eq!(blob_raw.is_padded(), true, "has to be padded");
-        assert_eq!(blob_from.is_padded(), true, "has to be padded");
-    }
-}
diff --git a/src/consts.rs b/src/consts.rs
@@ -1,4 +1,3 @@
 pub const BYTES_PER_FIELD_ELEMENT: usize = 32;
 pub const SIZE_OF_G1_AFFINE_COMPRESSED: usize = 32; // in bytes
 pub const SIZE_OF_G2_AFFINE_COMPRESSED: usize = 64; // in bytes
-pub const GETTYSBURG_ADDRESS_BYTES: &[u8] = "Fourscore and seven years ago our fathers brought forth, on this continent, a new nation, conceived in liberty, and dedicated to the proposition that all men are created equal. Now we are engaged in a great civil war, testing whether that nation, or any nation so conceived, and so dedicated, can long endure. We are met on a great battle-field of that war. We have come to dedicate a portion of that field, as a final resting-place for those who here gave their lives, that that nation might live. It is altogether fitting and proper that we should do this. But, in a larger sense, we cannot dedicate, we cannot consecrate—we cannot hallow—this ground. The brave men, living and dead, who struggled here, have consecrated it far above our poor power to add or detract. The world will little note, nor long remember what we say here, but it can never forget what they did here. It is for us the living, rather, to be dedicated here to the unfinished work which they who fought here have thus far so nobly advanced. It is rather for us to be here dedicated to the great task remaining before us—that from these honored dead we take increased devotion to that cause for which they here gave the last full measure of devotion—that we here highly resolve that these dead shall not have died in vain—that this nation, under God, shall have a new birth of freedom, and that government of the people, by the people, for the people, shall not perish from the earth.".as_bytes();