chore(stdlib)!: Rename fixed_base_scalar_mul to be more descriptive (…

…#2488) Co-authored-by: Tom French <[email protected]> Co-authored-by: Maxim Vezenov <[email protected]>
noir-lang · Sep 4, 2023 · 6efc007 · 6efc007
1 parent 1d9bcd0
commit 6efc007
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 5 deletions.
diff --git a/crates/nargo_cli/tests/compile_success_empty/intrinsic_die/src/main.nr b/crates/nargo_cli/tests/compile_success_empty/intrinsic_die/src/main.nr
@@ -6,6 +6,6 @@ fn main(x: Field) {
     let bytes = x.to_be_bytes(32);
 
     let hash = std::hash::pedersen([x]);
-    let _p1 = std::scalar_mul::fixed_base(x);
+    let _p1 = std::scalar_mul::fixed_base_embedded_curve(x);
 
 }
diff --git a/crates/nargo_cli/tests/execution_success/brillig_scalar_mul/src/main.nr b/crates/nargo_cli/tests/execution_success/brillig_scalar_mul/src/main.nr
@@ -16,7 +16,7 @@ unconstrained fn main(
           pub_x = b_pub_x;
           pub_y = b_pub_y;
      }
-     let res = std::scalar_mul::fixed_base(priv_key);
+     let res = std::scalar_mul::fixed_base_embedded_curve(priv_key);
      assert(res[0] == pub_x);
      assert(res[1] == pub_y);
 }
diff --git a/crates/nargo_cli/tests/execution_success/scalar_mul/src/main.nr b/crates/nargo_cli/tests/execution_success/scalar_mul/src/main.nr
@@ -16,7 +16,7 @@ fn main(
           pub_x = b_pub_x;
           pub_y = b_pub_y;
      }
-     let res = std::scalar_mul::fixed_base(priv_key);
+     let res = std::scalar_mul::fixed_base_embedded_curve(priv_key);
      assert(res[0] == pub_x);
      assert(res[1] == pub_y);
 }
diff --git a/crates/nargo_cli/tests/execution_success/simple_shield/src/main.nr b/crates/nargo_cli/tests/execution_success/simple_shield/src/main.nr
@@ -15,7 +15,7 @@ fn main(
   to_pubkey_y: Field, 
 ) -> pub [Field; 2] {
     // Compute public key from private key to show ownership
-    let pubkey = std::scalar_mul::fixed_base(priv_key);
+    let pubkey = std::scalar_mul::fixed_base_embedded_curve(priv_key);
     let pubkey_x = pubkey[0];
     let pubkey_y = pubkey[1];
 

diff --git a/noir_stdlib/src/scalar_mul.nr b/noir_stdlib/src/scalar_mul.nr
@@ -1,2 +1,8 @@
+// Computes a fixed base scalar multiplication over the embedded curve.
+// For bn254, We have Grumpkin and Baby JubJub.
+// For bls12-381, we have JubJub and Bandersnatch.
+//
+// The embedded curve being used is decided by the 
+// underlying proof system.
 #[foreign(fixed_base_scalar_mul)]
-fn fixed_base(_input : Field) -> [Field; 2] {}
+fn fixed_base_embedded_curve(_input : Field) -> [Field; 2] {}