feat: compiler tutorial WIP

docs/src/compiler/is_prime_rust.md

@@ -0,0 +1,192 @@
+# Writing a MidenVM Program In Rust
+
+_Using the Miden compiler to write programs in Rust and generate a proof of computation using the MidenVM CLI_
+
+## Overview
+
+In this guide, we will write a simple Rust program that checks whether an integer is prime. We will compile the Rust program into a Miden package and run it in the Miden VM. We will also cover how to use the Miden CLI to generate a STARK proof that the computation was performed correctly.
+
+## What we'll cover
+
+- Writing basic _pure_ programs in Rust using the Miden compiler.
+- Running programs in the Miden VM.
+- Generating a proof of computation for the `is_prime` program
+- Verifying the STARK proof of the `is_prime` program execution
+
+## Limitations and Important Considerations
+
+Please note these current limitations of the Miden compiler:
+
+- **No Floating Point Support:** Only integer arithmetic is supported (e.g., `u32`, `u64`, etc.).
+- **No Standard Library:** Programs must be written with `#![no_std]`.
+- **Entrypoint Constraints:** The `entrypoint` function can accept at most **16 inputs** on the stack and produces a single `u32` output.
+
+## Step 1: Installing the Miden Compiler
+
+Ensure you are using the nightly release of the rust toolchain:
+
+```bash
+rustup update nightly
+rustup default nightly
+```
+
+Install the `midenc` compiler and `cargo-miden` extension:
+
+```bash
+cargo install cargo-miden
+cargo install midenc --locked
+```
+
+If you encounter issues with the `cargo-miden` installation, you can specify a specific nightly version that is known to work with the Miden compiler.
+
+```bash
+cargo +nightly-2025-03-20 install cargo-miden
+```
+
+## Step 2: Writing the Rust Program
+
+In a new terminal outside of the compiler repository, create a new Miden project:
+
+```bash
+cargo miden new --program is_prime
+cd is_prime
+```
+
+Add the following Rust code to `is_prime/src/lib.rs`. This code checks whether a number is prime:
+
+```rust
+#![no_std]
+
+// Custom panic handler since we don't have the standard library.
+#[cfg(not(test))]
+#[panic_handler]
+fn my_panic(_info: &core::panic::PanicInfo) -> ! {
+    loop {}
+}
+
+/// Returns true if the integer is prime.
+fn is_prime(n: u32) -> bool {
+    if n <= 1 {
+        return false;
+    }
+    if n <= 3 {
+        return true;
+    }
+    if n % 2 == 0 || n % 3 == 0 {
+        return false;
+    }
+    let mut i = 5;
+    while i * i <= n {
+        if n % i == 0 || n % (i + 2) == 0 {
+            return false;
+        }
+        i += 6;
+    }
+    true
+}
+
+/// The entry point to the Miden program.
+#[no_mangle]
+fn entrypoint(n: u32) -> bool {
+    is_prime(n)
+}
+```
+
+Add this code into your project's `src/lib.rs` file.
+
+Next, create an `is_prime/inputs.toml` file:
+
+```toml
+[inputs]
+stack = [29]
+```
+
+This file sets the value that will be passed into our `entrypoint` function when the program runs.
+
+## Step 3: Running the Program in the Miden VM
+
+Compile your program with:
+
+```bash
+cargo miden build --release
+```
+
+Run your compiled Miden assembly program using:
+
+```bash
+midenc run target/miden/release/is_prime.masp --inputs inputs.toml
+```
+
+The output will look like this:
+
+```
+===============================================================================
+Run program: target/miden/release/is_prime.masp
+-------------------------------------------------------------------------------
+Executed program with hash 0x6c5173a2d77d294bbdccf3332092aeee9dc4ad431a0aa25842ef704044565681 in 0 seconds
+Output: [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+VM cycles: 805 extended to 1024 steps (21% padding).
+├── Stack rows: 597
+├── Range checker rows: 83
+└── Chiplets rows: 805
+├── Hash chiplet rows: 728
+├── Bitwise chiplet rows: 72
+├── Memory chiplet rows: 4
+└── Kernel ROM rows: 0
+```
+
+The program returns `1` if the integer passed to the `is_prime` function is prime and `0` if it is not.
+
+## Step 4: Generating a zk proof of the `is_prime` program execution
+
+First cloning the Miden VM repository and install the Miden VM CLI:
+
+```bash
+cargo install miden-vm --version 0.16.2 --features concurrent,executable
+```
+
+After installation is complete, return to the `is_prime` directory.
+
+The current input file format for the Miden VM differs slightly from that of the compiler. This means we need to create an `is_prime.inputs` file at the root of the `is_prime` directory:
+
+```json
+{
+  "operand_stack": ["29"]
+}
+```
+
+Now, using the Miden VM CLI tool, we can prove our program by running the following:
+
+```bash
+miden prove target/miden/release/is_prime.masp -i is_prime.inputs
+```
+
+The output should look like this:
+
+```
+===============================================================================
+Prove program: target/miden/release/is_prime.masp
+-------------------------------------------------------------------------------
+Proving program with hash 6c5173a2d77d294bbdccf3332092aeee9dc4ad431a0aa25842ef704044565681...
+Program proved in 35 ms
+Output: [1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+```
+
+To verify the proof generated in the previous step, run the following:
+
+```bash
+miden verify -p target/miden/release/is_prime.proof -i is_prime.inputs -x 6c5173a2d77d294bbdccf3332092aeee9dc4ad431a0aa25842ef704044565681
+```
+
+The output should look like this:
+
+```
+===============================================================================
+Verifying proof: target/miden/release/is_prime.proof
+-------------------------------------------------------------------------------
+Verification complete in 3 ms
+```
+
+## Conclusion
+
+This tutorial demonstrated how to write a basic program using the Miden compiler and how to prove and verify the execution of the program using the Miden CLI.

docs/src/rust-client/unauthenticated_note_how_to.md

@@ -23,22 +23,18 @@ Alice ➡ Bob ➡ Charlie ➡ Dave ➡ Eve ➡ Frank ➡ ...
 ## Step-by-step process
 
 1. **Client Initialization:**
-
    - Set up an RPC client to connect with the Miden testnet.
    - Initialize a random coin generator and a store for persisting account data.
 
 2. **Deploying a Fungible Faucet:**
-
    - Use a random seed to deploy a fungible faucet.
    - Configure the faucet parameters (symbol, decimals, and max supply) and add it to the client.
 
 3. **Creating Wallet Accounts:**
-
    - Build multiple wallet accounts using a secure key generation process.
    - Add these accounts to the client, making them ready for transactions.
 
 4. **Minting and Transacting with Unauthenticated Notes:**
-
    - Mint tokens for one of the accounts (Alice) from the deployed faucet.
    - Create a note representing the minted tokens.
    - Build and submit a transaction that uses the unauthenticated note via the "unauthenticated" method.