0xMiden/compiler

Write a guide "How to write small and fast Miden contracts in Rust"

Open

#1,060 opened on Apr 6, 2026

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)Rust (70 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

Stars
 (110 stars)
PR merge metrics
 (Avg merge 4d 7h) (51 merged PRs in 30d)

Description

@mooori mentioned that this topic came up in discussions.

I'm thinking:

  1. Avoid memory allocation.
  2. Avoid unaligned memory access (avoid small ints like i8 and i16).
  3. Avoid Vec and probably other high-level container types. Use arrays.

Felt arithmetic should have near-zero overhead but we want to discourage it (see #999) so I guess we should not promote it here either.

@bitwalker Thoughts?

/cc @bobbinth @Keinberger

Contributor guide

Research direction
Explore existing docs and examples, research Miden's performance constraints, and outline a guide covering the three tips: avoid dynamic allocation, avoid unaligned memory, and use arrays over high level containers.
Tech stack
rust
Domain
documentationblockchaincompilers
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75