openvm-org · jonathanpwang · Jan 23, 2025 · Jan 23, 2025 · Jan 23, 2025 · Jan 23, 2025
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -41,7 +41,7 @@ members = [
     "extensions/algebra/circuit",
     "extensions/algebra/transpiler",
     "extensions/algebra/guest",
-    "extensions/algebra/moduli-setup",
+    "extensions/extension-algebra-macros/moduli-macros",
     "extensions/algebra/tests",
     "extensions/bigint/circuit",
     "extensions/bigint/transpiler",
@@ -58,7 +58,7 @@ members = [
     "extensions/ecc/circuit",
     "extensions/ecc/transpiler",
     "extensions/ecc/guest",
-    "extensions/ecc/sw-setup",
+    "extensions/extension-algebra-macros/sw-macros",
     "extensions/ecc/tests",
     "extensions/pairing/circuit",
     "extensions/pairing/transpiler",
@@ -153,12 +153,12 @@ openvm-bigint-guest = { path = "extensions/bigint/guest", default-features = fal
 openvm-algebra-circuit = { path = "extensions/algebra/circuit", default-features = false }
 openvm-algebra-transpiler = { path = "extensions/algebra/transpiler", default-features = false }
 openvm-algebra-guest = { path = "extensions/algebra/guest", default-features = false }
-openvm-algebra-moduli-setup = { path = "extensions/algebra/moduli-setup", default-features = false }
-openvm-algebra-complex-macros = { path = "extensions/algebra/guest/src/field/complex-macros", default-features = false }
+openvm-algebra-moduli-macros = { path = "extensions/extension-algebra-macros/moduli-macros", default-features = false }
+openvm-algebra-complex-macros = { path = "extensions/extension-algebra-macros/complex-macros", default-features = false }
 openvm-ecc-circuit = { path = "extensions/ecc/circuit", default-features = false }
 openvm-ecc-transpiler = { path = "extensions/ecc/transpiler", default-features = false }
 openvm-ecc-guest = { path = "extensions/ecc/guest", default-features = false }
-openvm-ecc-sw-setup = { path = "extensions/ecc/sw-setup", default-features = false }
+openvm-ecc-sw-macros = { path = "extensions/extension-algebra-macros/sw-macros", default-features = false }
 openvm-pairing-circuit = { path = "extensions/pairing/circuit", default-features = false }
 openvm-pairing-transpiler = { path = "extensions/pairing/transpiler", default-features = false }
 openvm-pairing-guest = { path = "extensions/pairing/guest", default-features = false }

diff --git a/benchmarks/programs/ecrecover/src/main.rs b/benchmarks/programs/ecrecover/src/main.rs
@@ -21,11 +21,11 @@ use revm_precompile::{
 
 openvm::entry!(main);
 
-openvm_algebra_guest::moduli_setup::moduli_init! {
+openvm_algebra_guest::moduli_macros::moduli_init! {
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F",
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE BAAEDCE6 AF48A03B BFD25E8C D0364141"
 }
-openvm_ecc_guest::sw_setup::sw_init! {
+openvm_ecc_guest::sw_macros::sw_init! {
     Secp256k1Point,
 }
 

diff --git a/benchmarks/src/bin/ecrecover.rs b/benchmarks/src/bin/ecrecover.rs
@@ -93,7 +93,7 @@ fn main() -> Result<()> {
     let args = BenchmarkCli::parse();
 
     let elf = args.build_bench_program("ecrecover")?;
-    // TODO: update sw_setup macros and read it from elf.
+    // TODO: update sw_macros and read it from elf.
     let exe = VmExe::from_elf(
         elf,
         Transpiler::<BabyBear>::default()

diff --git a/book/src/custom-extensions/algebra.md b/book/src/custom-extensions/algebra.md
@@ -2,7 +2,7 @@
 
 The OpenVM Algebra extension provides tools to create and manipulate modular arithmetic structures and their complex extensions. For example, if \\(p\\) is prime, OpenVM Algebra can handle modular arithmetic in \\(\mathbb{F}\_p\\) and its quadratic extension fields \\(\mathbb{F}\_p[x]/(x^2 + 1)\\).
 
-The functional part is provided by the `openvm-algebra-guest` crate, which is a guest library that can be used in any OpenVM program. The macros for creating corresponding structs are in the `openvm-algebra-moduli-setup` and `openvm-algebra-complex-macros` crates.
+The functional part is provided by the `openvm-algebra-guest` crate, which is a guest library that can be used in any OpenVM program. The macros for creating corresponding structs are in the `openvm-algebra-moduli-macros` and `openvm-algebra-complex-macros` crates.
 
 ## Available traits and methods
 

diff --git a/docs/repo/layout.md b/docs/repo/layout.md
@@ -78,6 +78,13 @@ Command-line binary to compile, execute, and prove guest programs is in [`cli`](
 
 The toolchain, ISA, and VM are simultaneously extendable. All non-system functionality is implemented via extensions, which may be moved to standalone repositories in the future but are presently in this repository for maintainer convenience.
 
+#### Procedural macros for algebraic structs
+
+- [`openvm-algebra-moduli-macros`](../../extensions/extension-algebra-macros/moduli-macros): Procedural macros for use in guest program to generate modular arithmetic struct with custom intrinsics for compile-time modulus.
+- [`openvm-algebra-complex-macros`](../../extensions/extension-algebra-macros/complex-macros): Procedural macros for use in guest program to generate complex field struct with custom intrinsics for compile-time modulus.
+- [`openvm-ecc-sw-macros`](../../extensions/extension-algebra-macros/sw-macros): Procedural macros for use in guest program to generate short Weierstrass curve struct with custom intrinsics for compile-time curve.
+
+
 #### RV32IM
 
 - [`openvm-rv32im-circuit`](../../extensions/rv32im/circuit): Circuit extension for RV32IM instructions and IO instructions.
@@ -111,16 +118,13 @@ The toolchain, ISA, and VM are simultaneously extendable. All non-system functio
 - [`openvm-algebra-circuit`](../../extensions/algebra/circuit): Circuit extension for modular arithmetic for arbitrary compile-time modulus. Supports modular arithmetic and complex field extension operations.
 - [`openvm-algebra-transpiler`](../../extensions/algebra/transpiler): Transpiler extension for modular arithmetic for arbitrary compile-time modulus. Supports modular arithmetic and complex field extension operations.
 - [`openvm-algebra-guest`](../../extensions/algebra/guest): Guest library with traits for modular arithmetic and complex field extension operations.
-- [`openvm-algebra-moduli-setup`](../../extensions/algebra/moduli-setup): Procedural macros for use in guest program to generate modular arithmetic struct with custom intrinsics for compile-time modulus.
-- [`openvm-algebra-complex-macros`](../../extensions/algebra/guest/src/field/complex-macros): Procedural macros for use in guest program to generate complex field struct with custom intrinsics for compile-time modulus.
 - [`openvm-algebra-tests`](../../extensions/algebra/tests): Integration tests for the algebra extension.
 
 #### Elliptic Curve Cryptography
 
 - [`openvm-ecc-circuit`](../../extensions/ecc/circuit): Circuit extension for Weierstrass elliptic curve operations for arbitrary compile-time curve.
 - [`openvm-ecc-transpiler`](../../extensions/ecc/transpiler): Transpiler extension for Weierstrass elliptic curve operations for arbitrary compile-time curve.
 - [`openvm-ecc-guest`](../../extensions/ecc/guest): Guest library with traits for elliptic curve cryptography. Includes implementations of ECDSA and multi-scalar multiplication.
-- [`openvm-ecc-sw-setup`](../../extensions/ecc/sw-setup): Procedural macros for use in guest program to generate short Weierstrass curve struct with custom intrinsics for compile-time curve.
 - [`openvm-ecc-tests`](../../extensions/ecc/tests): Integration tests for the elliptic curve cryptography extension.
 
 #### Elliptic Curve Pairing

diff --git a/examples/algebra/src/main.rs b/examples/algebra/src/main.rs
@@ -1,7 +1,7 @@
 #![cfg_attr(not(feature = "std"), no_main)]
 #![cfg_attr(not(feature = "std"), no_std)]
 
-use openvm_algebra_guest::{moduli_setup::*, IntMod};
+use openvm_algebra_guest::{moduli_macros::*, IntMod};
 
 openvm::entry!(main);
 

diff --git a/examples/ecc/src/main.rs b/examples/ecc/src/main.rs
@@ -11,12 +11,12 @@ use openvm_ecc_guest::{
 // ANCHOR_END: imports
 
 // ANCHOR: init
-openvm_algebra_guest::moduli_setup::moduli_init! {
+openvm_algebra_guest::moduli_macros::moduli_init! {
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F",
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE BAAEDCE6 AF48A03B BFD25E8C D0364141"
 }
 
-openvm_ecc_guest::sw_setup::sw_init! {
+openvm_ecc_guest::sw_macros::sw_init! {
     Secp256k1Point,
 }
 // ANCHOR_END: init

diff --git a/examples/pairing/Cargo.toml b/examples/pairing/Cargo.toml
@@ -10,7 +10,7 @@ members = []
 openvm = { git = "https://github.com/openvm-org/openvm.git" }
 openvm-platform = { git = "https://github.com/openvm-org/openvm.git" }
 openvm-algebra-guest = { git = "https://github.com/openvm-org/openvm.git" }
-openvm-algebra-moduli-setup = { git = "https://github.com/openvm-org/openvm.git" }
+openvm-algebra-moduli-macros = { git = "https://github.com/openvm-org/openvm.git" }
 openvm-algebra-complex-macros = { git = "https://github.com/openvm-org/openvm.git" }
 openvm-ecc-guest = { git = "https://github.com/openvm-org/openvm.git" }
 openvm-pairing-guest = { git = "https://github.com/openvm-org/openvm.git", features = ["bls12_381"] }

diff --git a/examples/pairing/src/main.rs b/examples/pairing/src/main.rs
@@ -14,7 +14,7 @@ use openvm_pairing_guest::{
 // ANCHOR_END: imports
 
 // ANCHOR: init
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "0x1a0111ea397fe69a4b1ba7b6434bacd764774b84f38512bf6730d2a0f6b0f6241eabfffeb153ffffb9feffffffffaaab",
     "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"
 }

diff --git a/extensions/algebra/guest/Cargo.toml b/extensions/algebra/guest/Cargo.toml
@@ -10,7 +10,7 @@ repository.workspace = true
 [dependencies]
 openvm = { workspace = true }
 openvm-platform = { workspace = true }
-openvm-algebra-moduli-setup = { workspace = true }
+openvm-algebra-moduli-macros = { workspace = true }
 openvm-algebra-complex-macros = { workspace = true }
 serde = { workspace = true }
 serde-big-array = "0.5.1"

diff --git a/extensions/algebra/guest/src/lib.rs b/extensions/algebra/guest/src/lib.rs
@@ -53,7 +53,7 @@ pub use field::Field;
 #[cfg(not(target_os = "zkvm"))]
 use num_bigint::BigUint;
 pub use openvm_algebra_complex_macros as complex_macros;
-pub use openvm_algebra_moduli_setup as moduli_setup;
+pub use openvm_algebra_moduli_macros as moduli_macros;
 pub use serde_big_array::BigArray;
 use strum_macros::FromRepr;
 

diff --git a/extensions/algebra/tests/programs/Cargo.toml b/extensions/algebra/tests/programs/Cargo.toml
@@ -9,8 +9,8 @@ openvm = { path = "../../../../crates/toolchain/openvm" }
 openvm-platform = { path = "../../../../crates/toolchain/platform" }
 
 openvm-algebra-guest = { path = "../../guest" }
-openvm-algebra-moduli-setup = { path = "../../moduli-setup", default-features = false }
-openvm-algebra-complex-macros = { path = "../../guest/src/field/complex-macros", default-features = false }
+openvm-algebra-moduli-macros = { path = "../../../extension-algebra-macros/moduli-macros", default-features = false }
+openvm-algebra-complex-macros = { path = "../../../extension-algebra-macros/complex-macros", default-features = false }
 num-bigint = { version = "0.4", default-features = false }
 serde = { version = "1.0", default-features = false, features = [
     "alloc",

diff --git a/extensions/algebra/tests/programs/examples/complex-secp256k1.rs b/extensions/algebra/tests/programs/examples/complex-secp256k1.rs
@@ -5,10 +5,10 @@ use openvm_algebra_guest::{field::ComplexConjugate, DivAssignUnsafe, DivUnsafe,
 
 openvm::entry!(main);
 
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     Secp256k1Coord { modulus = "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F" }
 }
-openvm_algebra_moduli_setup::moduli_init!(
+openvm_algebra_moduli_macros::moduli_init!(
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F"
 );
 

diff --git a/extensions/algebra/tests/programs/examples/complex-two-modulos.rs b/extensions/algebra/tests/programs/examples/complex-two-modulos.rs
@@ -5,11 +5,11 @@ use openvm_algebra_guest::IntMod;
 
 openvm::entry!(main);
 
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     Mod1 { modulus = "998244353" },
     Mod2 { modulus = "1000000007" }
 }
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "998244353", "1000000007"
 }
 

diff --git a/extensions/algebra/tests/programs/examples/little.rs b/extensions/algebra/tests/programs/examples/little.rs
@@ -5,11 +5,11 @@ use openvm_algebra_guest::{DivUnsafe, IntMod};
 
 openvm::entry!(main);
 
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     Secp256k1Coord { modulus = "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F" }
 }
 
-openvm_algebra_moduli_setup::moduli_init!(
+openvm_algebra_moduli_macros::moduli_init!(
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F"
 );
 

diff --git a/extensions/algebra/tests/programs/examples/moduli_setup.rs b/extensions/algebra/tests/programs/examples/moduli_setup.rs
@@ -6,16 +6,16 @@ extern crate alloc;
 use openvm_algebra_guest::IntMod;
 
 openvm::entry!(main);
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     Bls12381 { modulus = "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787" },
     Mod1e18 { modulus = "1000000000000000003" },
 }
 
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     Mersenne61 { modulus = "0x1fffffffffffffff" },
 }
 
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787",
     "1000000000000000003",
     "0x1fffffffffffffff",

diff --git a/extensions/ecc/guest/Cargo.toml b/extensions/ecc/guest/Cargo.toml
@@ -20,8 +20,8 @@ k256 = { workspace = true, optional = true }
 hex-literal = { workspace = true }
 openvm-rv32im-guest = { workspace = true }
 openvm-algebra-guest = { workspace = true }
-openvm-ecc-sw-setup = { workspace = true }
-openvm-algebra-moduli-setup = { workspace = true }
+openvm-ecc-sw-macros = { workspace = true }
+openvm-algebra-moduli-macros = { workspace = true }
 
 # Used for `halo2curves` feature
 # TODO[yj]: Transition to PSE halo2curves

diff --git a/extensions/ecc/guest/src/k256.rs b/extensions/ecc/guest/src/k256.rs
@@ -6,8 +6,8 @@ use lazy_static::lazy_static;
 #[cfg(not(target_os = "zkvm"))]
 use num_bigint::BigUint;
 use openvm_algebra_guest::{Field, IntMod};
-use openvm_algebra_moduli_setup::moduli_declare;
-use openvm_ecc_sw_setup::sw_declare;
+use openvm_algebra_moduli_macros::moduli_declare;
+use openvm_ecc_sw_macros::sw_declare;
 
 use super::group::{CyclicGroup, Group};
 use crate::weierstrass::{CachedMulTable, IntrinsicCurve};

diff --git a/extensions/ecc/guest/src/lib.rs b/extensions/ecc/guest/src/lib.rs
@@ -6,7 +6,7 @@ extern crate alloc;
 #[cfg(feature = "halo2curves")]
 pub use halo2curves_axiom as halo2curves;
 pub use openvm_algebra_guest as algebra;
-pub use openvm_ecc_sw_setup as sw_setup;
+pub use openvm_ecc_sw_macros as sw_macros;
 use strum_macros::FromRepr;
 
 mod affine_point;

diff --git a/extensions/ecc/guest/src/p256.rs b/extensions/ecc/guest/src/p256.rs
@@ -20,7 +20,7 @@ lazy_static! {
     ));
 }
 
-openvm_algebra_moduli_setup::moduli_declare! {
+openvm_algebra_moduli_macros::moduli_declare! {
     P256Coord { modulus = "0xffffffff00000001000000000000000000000000ffffffffffffffffffffffff" },
     P256Scalar { modulus = "0xffffffff00000000ffffffffffffffffbce6faada7179e84f3b9cac2fc632551" },
 }
@@ -38,7 +38,7 @@ pub const CURVE_B: P256Coord = P256Coord::from_const_bytes(hex!(
 
 pub struct P256;
 
-openvm_ecc_sw_setup::sw_declare! {
+openvm_ecc_sw_macros::sw_declare! {
     P256Point { mod_type = P256Coord, a = CURVE_A, b = CURVE_B },
 }
 

diff --git a/extensions/ecc/tests/programs/Cargo.toml b/extensions/ecc/tests/programs/Cargo.toml
@@ -9,9 +9,9 @@ openvm = { path = "../../../../crates/toolchain/openvm" }
 openvm-platform = { path = "../../../../crates/toolchain/platform" }
 
 openvm-ecc-guest = { path = "../../guest", default-features = false }
-openvm-ecc-sw-setup = { path = "../../../../extensions/ecc/sw-setup", default-features = false }
+openvm-ecc-sw-macros = { path = "../../../../extensions/extension-algebra-macros/sw-macros", default-features = false }
 openvm-algebra-guest = { path = "../../../algebra/guest", default-features = false }
-openvm-algebra-moduli-setup = { path = "../../../algebra/moduli-setup", default-features = false }
+openvm-algebra-moduli-macros = { path = "../../../extension-algebra-macros/moduli-macros", default-features = false }
 openvm-keccak256-guest = { path = "../../../keccak256/guest", default-features = false }
 
 serde = { version = "1.0", default-features = false, features = [

diff --git a/extensions/ecc/tests/programs/examples/decompress.rs b/extensions/ecc/tests/programs/examples/decompress.rs
@@ -10,11 +10,11 @@ use openvm_ecc_guest::{
 
 openvm::entry!(main);
 
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F",
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE BAAEDCE6 AF48A03B BFD25E8C D0364141"
 }
-openvm_ecc_sw_setup::sw_init! {
+openvm_ecc_sw_macros::sw_init! {
     Secp256k1Point,
 }
 

diff --git a/extensions/ecc/tests/programs/examples/ec.rs b/extensions/ecc/tests/programs/examples/ec.rs
@@ -10,12 +10,12 @@ use openvm_ecc_guest::{
     Group,
 };
 
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE FFFFFC2F",
     "0xFFFFFFFF FFFFFFFF FFFFFFFF FFFFFFFE BAAEDCE6 AF48A03B BFD25E8C D0364141"
 }
 
-openvm_ecc_sw_setup::sw_init! {
+openvm_ecc_sw_macros::sw_init! {
     Secp256k1Point,
 }
 

diff --git a/extensions/ecc/tests/programs/examples/ec_nonzero_a.rs b/extensions/ecc/tests/programs/examples/ec_nonzero_a.rs
@@ -14,12 +14,12 @@ use openvm_ecc_guest::{
 
 openvm::entry!(main);
 
-openvm_algebra_moduli_setup::moduli_init! {
+openvm_algebra_moduli_macros::moduli_init! {
     "0xffffffff00000001000000000000000000000000ffffffffffffffffffffffff",
     "0xffffffff00000000ffffffffffffffffbce6faada7179e84f3b9cac2fc632551"
 }
 
-openvm_ecc_sw_setup::sw_init! {
+openvm_ecc_sw_macros::sw_init! {
     P256Point,
 }