Miden core library

Core library for Miden VM.

Miden core library provides a set of procedures which can be used by any Miden program. These procedures build on the core instruction set of Miden assembly expanding the functionality immediately available to the user.

The goals of Miden core library are:

• Provide highly-optimized and battle-tested implementations of commonly-used primitives.
• Reduce the amount of code that needs to be shared between parties for proving and verifying program execution.

The second goal can be achieved because calls to procedures in the core library can always be serialized as 32 bytes, regardless of how large the procedure is.

CoreLibrary also bundles precompile-backed verification support used internally by core wrappers, so users do not need any separate precompile-package wiring for standard Miden programs. Users should call the stable facades under miden::core::*.

Generated core-library MASM can be inspected locally:

cargo run -p miden-core-lib-codegen -- --out target/miden-core-lib-generated-asm

Available modules

Currently, Miden core library contains just a few modules, which are listed below. Over time, we plan to add many more modules which will include various cryptographic primitives, additional numeric data types and operations, and many others.

• miden::core::collections::mmr
• miden::core::collections::smt
• miden::core::collections::sorted_array
• miden::core::crypto::dsa::ecdsa_k256_keccak
• miden::core::crypto::dsa::falcon512_poseidon2
• miden::core::crypto::hashes::poseidon2
• miden::core::crypto::hashes::blake3
• miden::core::crypto::hashes::keccak256
• miden::core::crypto::hashes::sha256
• miden::core::math::u256
• miden::core::math::u64
• miden::core::mem
• miden::core::pcs::fri::frie2f4
• miden::core::stark
• miden::core::stark::constants
• miden::core::stark::deep_queries
• miden::core::stark::ood_frames
• miden::core::stark::public_inputs
• miden::core::stark::random_coin
• miden::core::stark::utils
• miden::core::stark::verifier
• miden::core::sys
• miden::core::word

Status

At this point, all implementations listed above are considered to be experimental and are subject to change.

License

This project is dual-licensed under the MIT and Apache 2.0 licenses.