use env variable for the path of the typescript project test vectors

+ in addtion to some refactorying
+ update README file

Author: Muhammad-Altabba

nucypher-core/README.md

@@ -17,6 +17,19 @@ Bindings for several languages are available:
 * [JavaScript](https://github.com/nucypher/nucypher-core/tree/main/nucypher-core-wasm) (WASM-based)
 * [Python](https://github.com/nucypher/nucypher-core/tree/main/nucypher-core-python)
 
+## Cross-Implementation Testing
+
+This library tests generate test vectors for ensuring compatibility between different implementations. The test vector generators automatically produce JSON files in both the Rust project and the TypeScript project.
+
+### Setting Custom Path for TypeScript Test Vectors
+
+By default, the test vector generators will look for the TypeScript project at a relative path. If your project structure is different, you can customize the TypeScript project path using an environment variable:
+
+```bash
+# Generate shared secret test vectors with custom TypeScript project path
+TS_PROJECT_TEST_VECTORS_PATH=/path/to/taco-web/packages/shared/test/fixtures/ cargo test -p nucypher-core --test generate_shared_secret_vectors
+```
+
 [crate-image]: https://img.shields.io/crates/v/nucypher-core.svg
 [crate-link]: https://crates.io/crates/nucypher-core
 [docs-image]: https://docs.rs/nucypher-core/badge.svg

nucypher-core/tests/fixtures/shared-secret-vectors.json

@@ -1,24 +1,8 @@
 {
-  "testVectors": [
+  "test_vectors": [
     {
-      "description": "Basic encryption/decryption compatibility",
-      "expected_ciphertext": "0102030405060708090a0b0c30e02d19293bd79329c9232eacc4e82eca99e0ea66e4da3808bccbacb3fd2ccbce94fe0c26cbbb81be779817",
-      "fixed_nonce": [
-        1,
-        2,
-        3,
-        4,
-        5,
-        6,
-        7,
-        8,
-        9,
-        10,
-        11,
-        12
-      ],
       "id": "vector1",
-      "plaintext": "This is a fixed test message",
+      "description": "Fixed nonce encryption with known plaintext",
       "shared_secret": [
         0,
         1,
@@ -52,150 +36,81 @@
         29,
         30,
         31
-      ]
-    },
-    {
-      "description": "Empty plaintext compatibility",
-      "expected_ciphertext": "102030405060708090a0b0c0d9abc79645718dc328d5c3faa129fced",
+      ],
+      "plaintext": "This is a test message",
       "fixed_nonce": [
-        16,
-        32,
-        48,
-        64,
-        80,
-        96,
-        112,
-        128,
-        144,
-        160,
-        176,
-        192
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        0
       ],
-      "id": "vector2",
-      "plaintext": "",
-      "shared_secret": [
-        32,
-        33,
-        34,
-        35,
-        36,
-        37,
-        38,
-        39,
-        40,
-        41,
-        42,
-        43,
-        44,
-        45,
-        46,
-        47,
-        48,
-        49,
-        50,
-        51,
-        52,
-        53,
-        54,
-        55,
-        56,
-        57,
-        58,
-        59,
-        60,
-        61,
-        62,
-        63
-      ]
+      "expected_ciphertext": "0000000000000000000000004cd02b428d8fd5f172412804dc376e4a9dc2809486c8b548d407dad8f75ee84d6d9e92a42c4a"
     },
     {
-      "description": "Rust-generated ciphertext for TypeScript compatibility check",
-      "expected_plaintext": "This is a message encrypted by the Rust implementation",
-      "id": "vector3",
-      "rust_generated_ciphertext": [
-        244,
-        240,
-        54,
+      "id": "vector2",
+      "description": "Fixed nonce encryption with alternative values",
+      "shared_secret": [
+        31,
+        30,
+        29,
+        28,
+        27,
+        26,
+        25,
         24,
-        5,
-        65,
-        204,
-        10,
-        149,
+        23,
+        22,
+        21,
+        20,
+        19,
+        18,
+        17,
+        16,
+        15,
+        14,
+        13,
+        12,
+        11,
         10,
-        78,
-        107,
-        203,
-        196,
-        102,
-        251,
-        108,
-        158,
-        36,
+        9,
+        8,
         7,
-        14,
-        87,
-        153,
-        251,
-        176,
-        242,
-        94,
-        153,
-        244,
-        118,
-        124,
-        216,
-        154,
+        6,
         5,
-        88,
-        98,
-        171,
-        221,
-        222,
-        14,
-        247,
-        21,
-        74,
-        25,
-        205,
-        80,
-        35,
-        47,
-        195,
-        218,
-        221,
-        23,
-        85,
-        23,
-        82,
-        145,
-        234,
-        171,
-        136,
-        141,
-        215,
-        95,
-        178,
-        103,
-        141,
-        70,
-        236,
-        104,
-        80,
-        106,
-        249,
-        218,
-        236,
-        96,
-        76,
-        77,
-        239,
-        197,
-        216,
-        31,
-        187,
-        146
+        4,
+        3,
+        2,
+        1,
+        0
       ],
+      "plaintext": "",
+      "fixed_nonce": [
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1
+      ],
+      "expected_ciphertext": "0101010101010101010101018726c5f2d5b81872a86493ef5232aaa1"
+    },
+    {
+      "id": "vector3",
+      "description": "Rust-generated ciphertext for TypeScript compatibility check",
       "shared_secret": [
         0,
         1,
@@ -229,7 +144,92 @@
         29,
         30,
         31
-      ]
+      ],
+      "rust_generated_ciphertext": [
+        87,
+        119,
+        14,
+        255,
+        68,
+        116,
+        249,
+        152,
+        58,
+        121,
+        245,
+        185,
+        157,
+        62,
+        23,
+        3,
+        50,
+        163,
+        150,
+        212,
+        167,
+        157,
+        244,
+        227,
+        159,
+        130,
+        110,
+        26,
+        30,
+        161,
+        173,
+        70,
+        232,
+        207,
+        110,
+        161,
+        252,
+        228,
+        149,
+        42,
+        173,
+        185,
+        61,
+        157,
+        144,
+        163,
+        128,
+        200,
+        87,
+        80,
+        172,
+        63,
+        235,
+        241,
+        169,
+        124,
+        248,
+        158,
+        213,
+        62,
+        241,
+        209,
+        117,
+        216,
+        202,
+        230,
+        106,
+        248,
+        170,
+        150,
+        126,
+        40,
+        203,
+        34,
+        14,
+        44,
+        71,
+        186,
+        234,
+        92,
+        13,
+        248
+      ],
+      "expected_plaintext": "This is a message encrypted by the Rust implementation"
     }
   ]
 }