Skip to content

docs: pass project manifest to miden build #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huklaa wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: pass project manifest to miden build #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
730179b
docs: pass project manifest to miden build
huklaa Aug 10, 2026
17add88
docs: pass project manifest in bank setup build
huklaa Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/src/miden-bank/00-project-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ The balance accessor is named `get_depositor_balance` rather than `get_balance`
:::info Contracts Are Excluded
Contracts are excluded from the Cargo workspace and built independently by the Miden toolchain. Each contract carries its own `miden` guest dependency plus a `miden-project.toml`. Only the `integration` crate remains a workspace member.

Because contracts are excluded, your IDE (rust-analyzer) may not provide completions or diagnostics for contract code. This is expected — contracts are built independently using `miden build`.
Because contracts are excluded, your IDE (rust-analyzer) may not provide completions or diagnostics for contract code. This is expected — contracts are built independently using `miden build` with their project manifest.
:::

## Step 4: Build and Verify
Expand All @@ -247,9 +247,11 @@ Let's verify everything compiles correctly:

```bash title=">_ Terminal"
cd contracts/bank-account
miden build --release
miden build --release miden-project.toml
```

Passing `miden-project.toml` explicitly avoids the `expected input file` error on toolchains where `miden build` invokes `midenc` directly.

<details>
<summary>Expected output</summary>

Expand Down Expand Up @@ -376,7 +378,7 @@ Your bank can be created, but doesn't do anything useful yet. In the next parts,
1. **`miden new`** creates a complete project workspace with contracts and integration folders
2. **Account components** are defined with a `#[component_storage]` struct plus a `#[component]` trait and impl
3. **Storage slots** are declared with `#[storage(description = "...")]` attributes
4. **`miden build`** compiles Rust to Miden Assembly (.masp package)
4. **`miden build miden-project.toml`** compiles Rust to Miden Assembly (.masp package)
5. **Tests verify** that your code works before moving on

## Next Steps
Expand Down
10 changes: 6 additions & 4 deletions examples/miden-bank/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ Companion code for the **Building a Bank with Miden Rust** tutorial.
Build all contracts:

```bash
cd contracts/bank-account && miden build
cd ../deposit-note && miden build
cd ../withdraw-request-note && miden build
cd ../init-tx-script && miden build
cd contracts/bank-account && miden build miden-project.toml
cd ../deposit-note && miden build miden-project.toml
cd ../withdraw-request-note && miden build miden-project.toml
cd ../init-tx-script && miden build miden-project.toml
```

Passing the project manifest explicitly avoids the `expected input file` error on toolchains where `miden build` invokes `midenc` directly.

Run integration tests:

```bash
Expand Down