Struct CoreLibrary

Source

pub struct CoreLibrary(/* private fields */);

Expand description

The Miden core library, providing a set of optimized procedures for Miden programs.

This library wraps a Package containing highly-optimized and battle-tested implementations of commonly-used primitives. When the core library is dynamically linked during assembly time, procedures can be called from any Miden program and are serialized as 32 bytes, reducing the amount of code that needs to be shared between parties for proving and verifying program execution.

§Contents

The core library provides several categories of functionality:

Cryptographic primitives: Hash functions (Keccak256, SHA-512), digital signature verification (ECDSA, EdDSA-Ed25519, Falcon), and authenticated encryption (AEAD decryption).
Mathematical operations: Division operations for u64, u128, and u256.
Data structures: Sparse Merkle Tree operations, Merkle Mountain Range (MMR), and sorted array utilities with lower-bound search capabilities.
Memory operations: Efficient hashing and “un-hashing” of large amounts of data.

Many of these operations are implemented as precompiles - special procedures that execute outside the Miden VM but are verified as part of the proof. Precompiles allow for efficient execution of complex operations that would be expensive to compute directly in the VM, while maintaining the security guarantees of the Miden proof system. The core library includes precompiles for cryptographic operations like hash functions and signature verification.

§Usage

The core library is typically used with the assembler to enable core library procedures in compiled programs:

use miden_assembly::{Assembler, Linkage};
use miden_core_lib::CoreLibrary;

let core_lib = CoreLibrary::default();
let assembler = Assembler::new(source_manager)
    .with_package(core_lib.package(), Linkage::Dynamic)
    .unwrap();

For program execution, you’ll also need to register the event handlers:

let handlers = core_lib.handlers();
// Register handlers with your host...

Stack and memory print-style debug handlers are registered with stdout writers by default. These handlers can print private values if a program moves witness data onto the operand stack or into memory. Privacy-sensitive hosts should replace or unregister these handlers. Advice debug handlers can expose witness data directly, so hosts must opt into those explicitly.

For proof verification, use verifier_registry() to get the precompile verifiers required to validate core library precompile requests.

Struct CoreLibrary Copy item path

§Contents

§Usage

Implementations§

impl CoreLibrary

pub fn mast_forest(&self) -> &Arc<MastForest>

pub fn package(&self) -> Arc<Package>

pub fn handlers(&self) -> Vec<(EventName, Arc<dyn EventHandler>)>

pub fn verifier_registry(&self) -> PrecompileVerifierRegistry

Trait Implementations§

impl AsRef<Package> for CoreLibrary

fn as_ref(&self) -> &Package

impl Clone for CoreLibrary

fn clone(&self) -> CoreLibrary

fn clone_from(&mut self, source: &Self)

impl Default for CoreLibrary

fn default() -> Self

impl From<&CoreLibrary> for HostLibrary

fn from(core_lib: &CoreLibrary) -> Self

Auto Trait Implementations§

impl Freeze for CoreLibrary

impl RefUnwindSafe for CoreLibrary

impl Send for CoreLibrary

impl Sync for CoreLibrary

impl Unpin for CoreLibrary

impl UnsafeUnpin for CoreLibrary

impl UnwindSafe for CoreLibrary

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Struct CoreLibrary

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,