Skip to content

Commit 1b97ee9

Browse files
greenhatgreenhat
committed
refactor: rename miden-prelude to miden-stdlib-sys in SDK
1 parent bdc927d commit 1b97ee9

File tree

42 files changed

+173
-176
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+173
-176
lines changed

‎docs/src/guides/develop_miden_in_rust.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Developing Miden Programs In Rust
22

3-
This chapter will walk through how to develop Miden programs in Rust using the prelude and standard library provided by the `miden-prelude` crate (see the [README](https://github.com/0xPolygonMiden/compiler/sdk/prelude/README.md)).
3+
This chapter will walk through how to develop Miden programs in Rust using the standard library provided by the `miden-stdlib-sys` crate (see the [README](https://github.com/0xPolygonMiden/compiler/sdk/stdlib-sys/README.md)).
44

55
## Getting Started
66

7-
Import the prelude and standard library from the `miden-prelude` crate:
7+
Import the standard library from the `miden-stdlib-sys` crate:
88

99
```rust
10-
use miden_prelude::*;
10+
use miden_stdlib_sys::*;
1111
```
1212

1313
## Using `Felt` (field element) type

‎frontend-wasm/src/intrinsics/felt.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use midenc_hir::{Felt, FunctionIdent, Immediate, InstBuilder, SourceSpan, Type::
44

55
use crate::module::function_builder_ext::FunctionBuilderExt;
66

7-
pub(crate) const PRELUDE_INTRINSICS_FELT_MODULE_NAME: &str = "miden:prelude/intrinsics_felt";
7+
pub(crate) const INTRINSICS_FELT_MODULE_NAME: &str = "miden:stdlib/intrinsics_felt";
88

99
/// Convert a call to a felt op intrinsic function into instruction(s)
1010
pub(crate) fn convert_felt_intrinsics(

‎frontend-wasm/src/intrinsics/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ fn modules() -> &'static HashSet<&'static str> {
1515
static MODULES: OnceLock<HashSet<&'static str>> = OnceLock::new();
1616
MODULES.get_or_init(|| {
1717
let mut s = HashSet::default();
18-
s.insert(felt::PRELUDE_INTRINSICS_FELT_MODULE_NAME);
18+
s.insert(felt::INTRINSICS_FELT_MODULE_NAME);
1919
s
2020
})
2121
}
@@ -28,7 +28,7 @@ pub fn convert_intrinsics_call(
2828
span: SourceSpan,
2929
) -> Vec<Value> {
3030
match func_id.module.as_symbol().as_str() {
31-
felt::PRELUDE_INTRINSICS_FELT_MODULE_NAME => {
31+
felt::INTRINSICS_FELT_MODULE_NAME => {
3232
felt::convert_felt_intrinsics(func_id, args, builder, span)
3333
}
3434
_ => panic!("No intrinsics found for {}", func_id),

‎frontend-wasm/src/miden_abi/stdlib/crypto/dsa.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ pub(crate) fn signatures() -> ModuleFunctionTypeMap {
1212
RPO_FALCON512_VERIFY,
1313
FunctionType::new([Felt, Felt, Felt, Felt, Felt, Felt, Felt, Felt], []),
1414
);
15-
m.insert("miden:prelude/std_crypto_dsa", funcs);
15+
m.insert("miden:stdlib/std_crypto_dsa", funcs);
1616
m
1717
}

‎frontend-wasm/src/miden_abi/stdlib/mem.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ pub(crate) fn signatures() -> ModuleFunctionTypeMap {
4040
],
4141
),
4242
);
43-
m.insert("miden:prelude/std_mem", funcs);
43+
m.insert("miden:stdlib/std_mem", funcs);
4444
m
4545
}

‎sdk/Cargo.lock

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[workspace]
22
resolver = "2"
33
members = [
4-
"prelude",
4+
"stdlib-sys",
55
"tx-kernel",
66
"sdk",
77
]

‎sdk/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The Miden SDK is a set of Rust crates that provide libraries for developing Mide
44

55
The SDK is composed of the following crates:
66

7-
## Miden Prelude
7+
## Miden Standard Library
88

9-
The `miden-prelude` crate provides a `Felt` type that represents field element in the Miden VM and a standard library for developing Miden programs.
9+
The `miden-stdlib-sys` crate provides a `Felt` type that represents field element in the Miden VM and a standard library for developing Miden programs.
1010

11-
See [README](prelude/README.md)
11+
See [README](stdlib-sys/README.md)
1212

1313
## Miden SDK
1414

‎sdk/sdk/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ edition.workspace = true
1515
crate-type = ["rlib"]
1616

1717
[dependencies]
18-
miden-prelude = { path = "../prelude" }
18+
miden-stdlib-sys = { path = "../stdlib-sys" }
1919
miden-sdk-tx-kernel = { path = "../tx-kernel" }

‎sdk/sdk/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#![no_std]
22

3-
pub use miden_prelude::*;
43
pub use miden_sdk_tx_kernel::*;
4+
pub use miden_stdlib_sys::*;

‎sdk/prelude/Cargo.toml renamed to ‎sdk/stdlib-sys/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
2-
name = "miden-prelude"
3-
description = "Miden Prelude: intrinsics and standard library for Miden"
2+
name = "miden-stdlib-sys"
3+
description = "Low-level Rust bindings for the Miden standard library"
44
version.workspace = true
55
rust-version.workspace = true
66
authors.workspace = true

‎sdk/prelude/README.md renamed to ‎sdk/stdlib-sys/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Miden Prelude
1+
# Miden Standard Library
22

3-
The `miden-prelude` crate provides a `Felt` type that represents field element in the Miden VM and a standard library for developing Miden programs.
3+
The `miden-stdlib-sys` crate provides a `Felt` type that represents field element in the Miden VM and a standard library for developing Miden programs.
44

55
## Miden VM instructions
66

‎sdk/prelude/src/intrinsics/felt.rs renamed to ‎sdk/stdlib-sys/src/intrinsics/felt.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use core::ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign};
22

3-
#[link(wasm_import_module = "miden:prelude/intrinsics_felt")]
3+
#[link(wasm_import_module = "miden:stdlib/intrinsics_felt")]
44
extern "C" {
55
#[link_name = "from_u64_unchecked"]
66
fn extern_from_u64_unchecked(value: u64) -> Felt;

‎sdk/prelude/src/intrinsics/mod.rs renamed to ‎sdk/stdlib-sys/src/intrinsics/mod.rs

File renamed without changes.

‎sdk/prelude/src/intrinsics/word.rs renamed to ‎sdk/stdlib-sys/src/intrinsics/word.rs

File renamed without changes.

‎sdk/prelude/src/lib.rs renamed to ‎sdk/stdlib-sys/src/lib.rs

File renamed without changes.

‎sdk/prelude/src/stdlib/crypto/dsa.rs renamed to ‎sdk/stdlib-sys/src/stdlib/crypto/dsa.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::{Felt, Word};
22

3-
#[link(wasm_import_module = "miden:prelude/std_crypto_dsa")]
3+
#[link(wasm_import_module = "miden:stdlib/std_crypto_dsa")]
44
extern "C" {
55
#[link_name = "rpo_falcon512_verify<0x0000000000000000000000000000000000000000000000000000000000000000>"]
66
fn extern_rpo_falcon512_verify(

‎sdk/prelude/src/stdlib/crypto/hashes.rs renamed to ‎sdk/stdlib-sys/src/stdlib/crypto/hashes.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
//! value per element.
44
use crate::Felt;
55

6-
// #[link(wasm_import_module = "miden:prelude/std_crypto_hashes")]
76
#[link(wasm_import_module = "std::crypto_hashes")]
87
extern "C" {
98
/// Computes BLAKE3 1-to-1 hash.

‎sdk/prelude/src/stdlib/crypto/mod.rs renamed to ‎sdk/stdlib-sys/src/stdlib/crypto/mod.rs

File renamed without changes.

‎sdk/prelude/src/stdlib/mem.rs renamed to ‎sdk/stdlib-sys/src/stdlib/mem.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use alloc::vec::Vec;
55

66
use crate::{Felt, Word};
77

8-
#[link(wasm_import_module = "miden:prelude/std_mem")]
8+
#[link(wasm_import_module = "miden:stdlib/std_mem")]
99
extern "C" {
1010

1111
/// Moves an arbitrary number of words from the advice stack to memory.

‎sdk/prelude/src/stdlib/mod.rs renamed to ‎sdk/stdlib-sys/src/stdlib/mod.rs

File renamed without changes.

‎sdk/tx-kernel/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ edition.workspace = true
1515
crate-type = ["rlib"]
1616

1717
[dependencies]
18-
miden-prelude = { path = "../prelude" }
18+
miden-stdlib-sys = { path = "../stdlib-sys" }

‎sdk/tx-kernel/src/externs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use miden_prelude::Felt;
1+
use miden_stdlib_sys::Felt;
22

33
use crate::{AccountId, CoreAsset, NoteId, NoteType, Tag};
44

‎sdk/tx-kernel/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ extern crate alloc;
1010

1111
use alloc::vec::Vec;
1212

13-
use miden_prelude::Felt;
13+
use miden_stdlib_sys::Felt;
1414

1515
/// Get the account ID of the currently executing note account.
1616
pub fn get_id() -> AccountId {

‎sdk/tx-kernel/src/types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use miden_prelude::{Felt, Word};
1+
use miden_stdlib_sys::{Felt, Word};
22

33
#[repr(transparent)]
44
#[derive(Copy, Clone)]

‎tests/integration/expected/add_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $add_felt.wasm
22
(type (;0;) (func (param f64 f64) (result f64)))
3-
(import "miden:prelude/intrinsics_felt" "add" (func $miden_prelude::intrinsics::felt::extern_add (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "add" (func $miden_stdlib_sys::intrinsics::felt::extern_add (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result f64)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_add
7+
call $miden_stdlib_sys::intrinsics::felt::extern_add
88
)
99
(table (;0;) 1 1 funcref)
1010
(memory (;0;) 16)

‎tests/integration/expected/div_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $div_felt.wasm
22
(type (;0;) (func (param f64 f64) (result f64)))
3-
(import "miden:prelude/intrinsics_felt" "div" (func $miden_prelude::intrinsics::felt::extern_div (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "div" (func $miden_stdlib_sys::intrinsics::felt::extern_div (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result f64)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_div
7+
call $miden_stdlib_sys::intrinsics::felt::extern_div
88
)
99
(table (;0;) 1 1 funcref)
1010
(memory (;0;) 16)

‎tests/integration/expected/eq_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $eq_felt.wasm
22
(type (;0;) (func (param f64 f64) (result i32)))
3-
(import "miden:prelude/intrinsics_felt" "eq" (func $miden_prelude::intrinsics::felt::extern_eq (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "eq" (func $miden_stdlib_sys::intrinsics::felt::extern_eq (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result i32)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_eq
7+
call $miden_stdlib_sys::intrinsics::felt::extern_eq
88
i32.const 1
99
i32.eq
1010
)

‎tests/integration/expected/ge_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $ge_felt.wasm
22
(type (;0;) (func (param f64 f64) (result i32)))
3-
(import "miden:prelude/intrinsics_felt" "ge" (func $miden_prelude::intrinsics::felt::extern_ge (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "ge" (func $miden_stdlib_sys::intrinsics::felt::extern_ge (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result i32)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_ge
7+
call $miden_stdlib_sys::intrinsics::felt::extern_ge
88
i32.const 0
99
i32.ne
1010
)

‎tests/integration/expected/gt_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $gt_felt.wasm
22
(type (;0;) (func (param f64 f64) (result i32)))
3-
(import "miden:prelude/intrinsics_felt" "gt" (func $miden_prelude::intrinsics::felt::extern_gt (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "gt" (func $miden_stdlib_sys::intrinsics::felt::extern_gt (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result i32)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_gt
7+
call $miden_stdlib_sys::intrinsics::felt::extern_gt
88
i32.const 0
99
i32.ne
1010
)

‎tests/integration/expected/le_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $le_felt.wasm
22
(type (;0;) (func (param f64 f64) (result i32)))
3-
(import "miden:prelude/intrinsics_felt" "le" (func $miden_prelude::intrinsics::felt::extern_le (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "le" (func $miden_stdlib_sys::intrinsics::felt::extern_le (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result i32)
55
local.get 1
66
local.get 0
7-
call $miden_prelude::intrinsics::felt::extern_le
7+
call $miden_stdlib_sys::intrinsics::felt::extern_le
88
i32.const 0
99
i32.ne
1010
)

‎tests/integration/expected/lt_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $lt_felt.wasm
22
(type (;0;) (func (param f64 f64) (result i32)))
3-
(import "miden:prelude/intrinsics_felt" "lt" (func $miden_prelude::intrinsics::felt::extern_lt (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "lt" (func $miden_stdlib_sys::intrinsics::felt::extern_lt (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result i32)
55
local.get 1
66
local.get 0
7-
call $miden_prelude::intrinsics::felt::extern_lt
7+
call $miden_stdlib_sys::intrinsics::felt::extern_lt
88
i32.const 0
99
i32.ne
1010
)

‎tests/integration/expected/mul_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $mul_felt.wasm
22
(type (;0;) (func (param f64 f64) (result f64)))
3-
(import "miden:prelude/intrinsics_felt" "mul" (func $miden_prelude::intrinsics::felt::extern_mul (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "mul" (func $miden_stdlib_sys::intrinsics::felt::extern_mul (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result f64)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_mul
7+
call $miden_stdlib_sys::intrinsics::felt::extern_mul
88
)
99
(table (;0;) 1 1 funcref)
1010
(memory (;0;) 16)

‎tests/integration/expected/neg_felt.wat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
(module $neg_felt.wasm
22
(type (;0;) (func (param f64 f64) (result f64)))
3-
(import "miden:prelude/intrinsics_felt" "sub" (func $miden_prelude::intrinsics::felt::extern_sub (;0;) (type 0)))
3+
(import "miden:stdlib/intrinsics_felt" "sub" (func $miden_stdlib_sys::intrinsics::felt::extern_sub (;0;) (type 0)))
44
(func $entrypoint (;1;) (type 0) (param f64 f64) (result f64)
55
local.get 0
66
local.get 1
7-
call $miden_prelude::intrinsics::felt::extern_sub
7+
call $miden_stdlib_sys::intrinsics::felt::extern_sub
88
)
99
(table (;0;) 1 1 funcref)
1010
(memory (;0;) 16)

0 commit comments

Comments
 (0)