Adding `miden_core` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add miden-core

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

miden-core = "0.21.2"

The miden_core library will be automatically available globally. Read the miden_core library documentation.

Readme

This crate contains core components used by Miden VM. These components include:

Miden VM instruction set, defined in the Operation struct.
Miden VM program kernel, defined in Kernel struct which contains a set of roots of kernel routines.
Miden VM program structure, defined in Program struct and described here.
Miden VM program metadata, defined in ProgramInfo struct which contains a program's MAST root and the kernel used by the program.
Input and output containers for Miden VM programs, defined in StackInputs and StackOutputs structs.
Constants describing the shape of the VM's execution trace.
Various minor utility functions used by other VM crates.

The racy_lock module found under core/src/utils/sync is based on the once_cell crate's implementation of race::OnceBox.

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