DEPRECATION NOTICE: With native bigint opcodes added in Noir v0.24.0, this repository is no longer required. Use the native bigint abstractions instead of this library.
This library provides three crates:
biguint
- custom unsigned big integer type implemented using u56 limbs primefield
- wrapper around biguint
that implements prime field operationscurves
- example elliptic curve libraries built using the primefield
typebiguint
This crate provides a custom BigUint56
data type, allowing for computations on large unsigned integers. The integers are represented with a fixed number of limbs, each of which is a 56-bit unsigned integer.
We utilize u56
limbs for two primary reasons:
u112
is the maximum double-width value that can be represented in Noir.This provides various functionalities such as arithmetic operations (addition, subtraction, multiplication, division), bitwise operations (left shift, right shift), comparisons and conversions (to bytes, to bits).
primefield
This contains the PrimeField
data type, which allows for efficient operations on prime field elements. This is implemented as a wrapper around the BigUint56
type and stores the values in the Montgomery form for efficient modular multiplication/reduction.
curves
This crate contains examples of the secp256k1
and the ed25519
curves implemented using the PrimeField
type.
In your Nargo.toml
file, add the following dependency:
[dependencies]
noir_bigint_curves = { tag = "v0.2.0", git = "https://github.com/shuklaayush/noir-bigint", directory="crates/curves" }
noir_biguint = { tag = "v0.2.0", git = "https://github.com/shuklaayush/noir-bigint", directory="crates/biguint" }
noir_bigint_primefield = { tag = "v0.2.0", git = "https://github.com/shuklaayush/noir-bigint", directory="crates/primefield" }
Tests are run using nargo
:
nargo test
All tests are run as part of the CI pipeline test.yaml
.
Contributions are welcome! Please adhere to the following guidelines:
This is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any losses incurred through any use of this code base.