-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Std-lib support for ZK opcodes (#6832)
## Description This PR adds support for the `ecop` and `epar` opcodes in the std-lib. It also introduces the `Point2D` and `Scalar` type support cryptographic operations. The new crypto module follows the same format as developed in #5747 which is still yet to come, ensuring compatibility. The `Point2D` and `Scalar` types also use `Bytes` under the hood to ensure future curves with points larger than 32 bytes are still supported. ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: green <xgreenx9999@gmail.com> Co-authored-by: Vaivaswatha Nagaraj <vaivaswatha.nagaraj@fuel.sh>
- Loading branch information
1 parent
47e75f7
commit c6daba5
Showing
12 changed files
with
1,460 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,222 @@ | ||
library; | ||
|
||
use ::vec::*; | ||
use ::bytes::{Bytes, *}; | ||
use ::revert::require; | ||
use ::crypto::{point2d::*, scalar::*}; | ||
use ::alloc::alloc; | ||
|
||
/// The error type used when performing elliptic curve operations for the Alt BN128 curve. | ||
pub enum AltBn128Error { | ||
/// The elliptic curve point used was invalid. | ||
InvalidEllipticCurvePoint: (), | ||
/// The elliptic curve scalar used was invalid. | ||
InvalidEllipticCurveScalar: (), | ||
} | ||
|
||
/// Performs an elliptic curve multiplication with a given curve, point, and scalar. | ||
/// | ||
/// # Additional Information | ||
/// | ||
/// The Fuel VM currently only supports the Alt BN128 curve. | ||
/// | ||
/// # Arguments | ||
/// | ||
/// * `point`: [Point2D] - The point used to perform the multiplication. | ||
/// * `scalar`: [Scalar] - The scalar used perform the multiplication. | ||
/// | ||
/// # Returns | ||
/// | ||
/// * [Point2D] - The resulting computed point. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ```sway | ||
/// use std::{point2d::Point2D, scalar::Scalar, alt_bn128::alt_bn128_mul}; | ||
/// | ||
/// fn foo(point: Point2D, scalar: Scalar) { | ||
/// let result = alt_bn128_mul(point, scalar); | ||
/// assert(!result.is_zero()); | ||
/// } | ||
/// ``` | ||
pub fn alt_bn128_mul(point: Point2D, scalar: Scalar) -> Point2D { | ||
require( | ||
valid_alt_bn128_point(point), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
require( | ||
valid_alt_bn128_scalar(scalar), | ||
AltBn128Error::InvalidEllipticCurveScalar, | ||
); | ||
|
||
// 1P = ([32 bytes], [32 bytes]) | ||
let mut result = [b256::zero(), b256::zero()]; | ||
// 1P1S = (X, Y), Z = ([32 bytes], [32 bytes]), [32 bytes] = 3 * 32 bytes | ||
let mut ptr = alloc::<b256>(3); | ||
point.x().ptr().copy_to::<b256>(ptr.add::<b256>(0), 1); | ||
point.y().ptr().copy_to::<b256>(ptr.add::<b256>(1), 1); | ||
scalar.bytes().ptr().copy_to::<b256>(ptr.add::<b256>(2), 1); | ||
|
||
asm(buffer: result, curve: 0, operation: 1, scalar: ptr) { | ||
ecop buffer curve operation scalar; | ||
}; | ||
|
||
Point2D::from(result) | ||
} | ||
|
||
/// Performs an elliptic curve additions with a given curve and 2 points. | ||
/// | ||
/// # Additional Information | ||
/// | ||
/// The Fuel VM currently only supports the Alt BN128 curve. | ||
/// | ||
/// # Arguments | ||
/// | ||
/// * `point_1`: [Point2D] - The first point used to perform the addition. | ||
/// * `point_2`: [Point2D] - The second point used to perform the addition. | ||
/// | ||
/// # Returns | ||
/// | ||
/// * [Point2D] - The resulting computed point. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ```sway | ||
/// use std::{point2d::Point2D, scalar::Scalar, alt_bn128::alt_bn128_add}; | ||
/// | ||
/// fn foo(point_1: Point2D, point_2: Point2D) { | ||
/// let result = alt_bn128_add(point_1, point_2); | ||
/// assert(!result.is_zero()); | ||
/// } | ||
/// ``` | ||
pub fn alt_bn128_add(point_1: Point2D, point_2: Point2D) -> Point2D { | ||
require( | ||
valid_alt_bn128_point(point_1), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
require( | ||
valid_alt_bn128_point(point_2), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
|
||
// 1P = ([32 bytes], [32 bytes]) | ||
let mut result = [b256::zero(), b256::zero()]; | ||
// 1P1P = (X, Y), (X, Y) = ([32 bytes], [32 bytes]), ([32 bytes], [32 bytes]) = 4 * 32 bytes | ||
let mut points_ptr = alloc::<b256>(4); | ||
point_1 | ||
.x() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>(0), 1); | ||
point_1 | ||
.y() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>(1), 1); | ||
point_2 | ||
.x() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>(2), 1); | ||
point_2 | ||
.y() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>(3), 1); | ||
|
||
asm(buffer: result, curve: 0, operation: 0, points: points_ptr) { | ||
ecop buffer curve operation points; | ||
}; | ||
|
||
Point2D::from(result) | ||
} | ||
|
||
/// Performs an elliptic curve paring check with a given curve and 3 points. | ||
/// | ||
/// # Additional Information | ||
/// | ||
/// The Fuel VM currently only supports the Alt BN128 curve. | ||
/// | ||
/// # Arguments | ||
/// | ||
/// * `points`: [Vec<(Point2D, [Point2D; 2])>] - The points used to perform the pairing check. | ||
/// | ||
/// # Returns | ||
/// | ||
/// * [bool] - True if the pairing is valid, false otherwise. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ```sway | ||
/// use std::{point2d::Point2D, scalar::Scalar, alt_bn128::alt_bn128_pairing_check}; | ||
/// | ||
/// fn foo(points: Vec<(Point2D, [Point2D; 2])>) { | ||
/// let result = alt_bn128_pairing_check(points); | ||
/// assert(result); | ||
/// } | ||
/// ``` | ||
pub fn alt_bn128_pairing_check(points: Vec<(Point2D, [Point2D; 2])>) -> bool { | ||
// Total bytes is (P1, (G1, G2)) = ([32 bytes, 32 bytes], ([32 bytes, 32 bytes], [32 bytes, 32 bytes])) = 6 * 32 bytes * length | ||
let mut points_ptr = alloc::<b256>(points.len() * 6); | ||
let mut iter = 0; | ||
while iter < points.len() { | ||
let p1 = points.get(iter).unwrap().0; | ||
let p2 = points.get(iter).unwrap().1[0]; | ||
let p3 = points.get(iter).unwrap().1[1]; | ||
|
||
require( | ||
valid_alt_bn128_point(p1), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
require( | ||
valid_alt_bn128_point(p2), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
require( | ||
valid_alt_bn128_point(p3), | ||
AltBn128Error::InvalidEllipticCurvePoint, | ||
); | ||
|
||
// Copy all 6 32 byte length points to the single slice | ||
p1 | ||
.x() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>(iter * 6), 1); | ||
p1 | ||
.y() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>((iter * 6) + 1), 1); | ||
p2 | ||
.x() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>((iter * 6) + 2), 1); | ||
p2 | ||
.y() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>((iter * 6) + 3), 1); | ||
p3 | ||
.x() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>((iter * 6) + 4), 1); | ||
p3 | ||
.y() | ||
.ptr() | ||
.copy_to::<b256>(points_ptr.add::<b256>((iter * 6) + 5), 1); | ||
|
||
iter += 1; | ||
} | ||
|
||
// Result is bool | ||
asm(buffer, curve: 0, length: points.len(), points: points_ptr) { | ||
epar buffer curve length points; | ||
buffer: bool | ||
} | ||
} | ||
|
||
// Returns true if the point is in valid alt bn128 format. | ||
fn valid_alt_bn128_point(point: Point2D) -> bool { | ||
// 1P = ([32 bytes], [32 bytes]) | ||
point.x().len() == 32 && point.y().len() == 32 | ||
} | ||
|
||
// Returns true if the scalar is in valid alt bn128 format. | ||
fn valid_alt_bn128_scalar(scalar: Scalar) -> bool { | ||
// 1S = [32 bytes] | ||
scalar.bytes().len() == 32 | ||
} |
Oops, something went wrong.