Skip to content

Docs/issue 232 add merkle example docs #236

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
Lesnak1 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs/issue 232 add merkle example docs #236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37842a6
fix: update playground and documentation URLs in README
Lesnak1 Aug 8, 2026
46c2d9d
docs: add Merkle Inclusion example documentation to README
Lesnak1 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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Playground for example programs for the [Miden VM](https://github.com/0xMiden/miden-vm) in Miden assembly.

[Use the playground!](https://0xmiden.github.io/examples/)
[Use the playground!](https://playground.miden.xyz)

The goal of this playground is for developers to see how easy it is to write and execute code in Miden assembly. The examples come from the community and the team. If you come up with an example of your own, we are happy to include it in the list below. You can simply open a PR with your example adding the `.masm` and `.inputs` files.

Examples are written in Miden assembly, see [Miden assembly documentation](https://0xmiden.github.io/miden-docs/imported/miden-vm/src/user_docs/assembly/main.html). External inputs can be provided to the examples and the Miden VM in two ways as public inputs and via the advice provider, see [here](https://0xmiden.github.io/miden-docs/imported/miden-vm/src/intro/overview.html#inputs-and-outputs). Currently, in the playground you can use `operand_stack` as public input and the `advice_stack` as secret input.
Examples are written in Miden assembly, see [Miden assembly documentation](https://docs.miden.xyz/reference/miden-vm/overview). External inputs can be provided to the examples and the Miden VM in two ways as public inputs and via the advice provider, see [here](https://docs.miden.xyz/reference/protocol/architecture). Currently, in the playground you can use `operand_stack` as public input and the `advice_stack` as secret input.

In addition to running existing examples you can also write your own program and execute it. The examples can then serve as inspiration.

Expand Down Expand Up @@ -34,6 +34,8 @@ There are several examples in our repo and we hope we get more in the future. Th

- **Game-of-Life**: Implementation of Conway's Game of Life. But we can prove it. The static example runs on a 4x4 cell universe and 1000 generations.

- **Merkle Inclusion**: A program which verifies 1,000 Merkle inclusion paths in a Sparse Merkle Tree using `mtree_verify` in Miden assembly to confirm leaf membership against a root digest.

---

## Testing Examples
Expand Down