Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate various items in stdlib #6156

Merged
merged 2 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions noir_stdlib/src/ec/consts/te.nr
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ pub struct BabyJubjub {
}

#[field(bn254)]
#[deprecated = "It's recommmended to use the external noir-edwards library (https://github.com/noir-lang/noir-edwards)"]
pub fn baby_jubjub() -> BabyJubjub {
BabyJubjub {
// Baby Jubjub (ERC-2494) parameters in affine representation
Expand Down
1 change: 1 addition & 0 deletions noir_stdlib/src/ec/tecurve.nr
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ mod affine {

impl Point {
// Point constructor
#[deprecated = "It's recommmended to use the external noir-edwards library (https://github.com/noir-lang/noir-edwards)"]
pub fn new(x: Field, y: Field) -> Self {
Self { x, y }
}
Expand Down
2 changes: 2 additions & 0 deletions noir_stdlib/src/hash/mimc.nr
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use crate::default::Default;
// You must use constants generated for the native field
// Rounds number should be ~ log(p)/log(exp)
// For 254 bit primes, exponent 7 and 91 rounds seems to be recommended
#[deprecated = "It's recommmended to use the external MiMC library (https://github.com/noir-lang/mimc)"]
fn mimc<let N: u32>(x: Field, k: Field, constants: [Field; N], exp: Field) -> Field {
//round 0
let mut t = x + k;
Expand Down Expand Up @@ -116,6 +117,7 @@ global MIMC_BN254_CONSTANTS: [Field; MIMC_BN254_ROUNDS] = [

//mimc implementation with hardcoded parameters for BN254 curve.
#[field(bn254)]
#[deprecated = "It's recommmended to use the external MiMC library (https://github.com/noir-lang/mimc)"]
pub fn mimc_bn254<let N: u32>(array: [Field; N]) -> Field {
let exponent = 7;
let mut r = 0;
Expand Down
2 changes: 1 addition & 1 deletion noir_stdlib/src/hash/sha256.nr
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::runtime::is_unconstrained;
pub fn sha256<let N: u32>(input: [u8; N]) -> [u8; 32]
// docs:end:sha256
{
crate::sha256::digest(input)
digest(input)
}

#[foreign(sha256_compression)]
Expand Down
13 changes: 10 additions & 3 deletions noir_stdlib/src/schnorr.nr
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
use crate::collections::vec::Vec;
use crate::embedded_curve_ops::{EmbeddedCurvePoint, EmbeddedCurveScalar};

#[foreign(schnorr_verify)]
Expand All @@ -23,7 +22,11 @@ pub fn verify_signature_slice(
// docs:end:schnorr_verify_slice
{}

pub fn verify_signature_noir<let N: u32>(public_key: EmbeddedCurvePoint, signature: [u8; 64], message: [u8; N]) -> bool {
pub fn verify_signature_noir<let N: u32>(
public_key: EmbeddedCurvePoint,
signature: [u8; 64],
message: [u8; N]
) -> bool {
//scalar lo/hi from bytes
let sig_s = EmbeddedCurveScalar::from_bytes(signature, 0);
let sig_e = EmbeddedCurveScalar::from_bytes(signature, 32);
Expand All @@ -42,7 +45,11 @@ pub fn verify_signature_noir<let N: u32>(public_key: EmbeddedCurvePoint, signatu
is_ok
}

pub fn assert_valid_signature<let N: u32>(public_key: EmbeddedCurvePoint, signature: [u8; 64], message: [u8; N]) {
pub fn assert_valid_signature<let N: u32>(
public_key: EmbeddedCurvePoint,
signature: [u8; 64],
message: [u8; N]
) {
//scalar lo/hi from bytes
let sig_s = EmbeddedCurveScalar::from_bytes(signature, 0);
let sig_e = EmbeddedCurveScalar::from_bytes(signature, 32);
Expand Down
11 changes: 10 additions & 1 deletion noir_stdlib/src/sha256.nr
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
// This file is kept for backwards compatibility.
pub use crate::hash::sha256::{digest, sha256_var};

#[deprecated = "replace with std::hash::sha256::digest"]
pub fn digest<let N: u32>(msg: [u8; N]) -> [u8; 32] {
crate::hash::sha256::digest(msg)
}

#[deprecated = "replace with std::hash::sha256::sha256_var"]
pub fn sha256_var<let N: u32>(msg: [u8; N], message_size: u64) -> [u8; 32] {
crate::hash::sha256::sha256_var(msg, message_size)
}
6 changes: 5 additions & 1 deletion noir_stdlib/src/sha512.nr
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
// This file is kept for backwards compatibility.
pub use crate::hash::sha512::digest;

#[deprecated = "replace with std::hash::sha512::digest"]
pub fn digest<let N: u32>(msg: [u8; N]) -> [u8; 64] {
crate::hash::sha512::digest(msg)
}
Loading