12 releases (5 breaking)

new 0.6.2 Nov 21, 2024
0.6.1 Nov 8, 2024
0.5.1 Aug 29, 2024
0.4.0 Jul 4, 2024
0.1.1 Mar 7, 2024

#986 in Magic Beans

Download history 43/week @ 2024-08-01 44/week @ 2024-08-08 54/week @ 2024-08-15 567/week @ 2024-08-22 773/week @ 2024-08-29 314/week @ 2024-09-05 117/week @ 2024-09-12 80/week @ 2024-09-19 71/week @ 2024-09-26 34/week @ 2024-10-03 22/week @ 2024-10-10 28/week @ 2024-10-17 27/week @ 2024-10-24 350/week @ 2024-10-31 919/week @ 2024-11-07 362/week @ 2024-11-14

1,667 downloads per month
Used in 13 crates (12 directly)

MIT license

515KB
10K SLoC

Miden Objects

This crates contains core components defining the Miden rollup protocol.

Modules

Here is a broad overview of each module, with links to additional documentation.

Accounts

Structures used to define accounts, including abstractions over its code, storage, and vault.

Documentation.

Assets

Structures used to define fungible and non-fungible assets. Accounts own assets and store them in their vaults.

Documentation

Block

Structures used to define a block. These objects contain authentication structures, merkle trees, used to represent the state of the rollup at a given point in time.

Notes

Structures used to define notes. Notes are messages that contain code and assets. They describe their own behavior and allow for interaction among accounts. Notes come in multiple flavors, refer to the docs for additional details.

Documentation

Transaction

Structures used to define Miden rollup transactions. Transactions describe changes to an account, and may include consumption and production of notes. The objects in this module allow for the representation of transactions at multiple stages of its lifecycle, from creation, to data aggregation, execution with trace collection, and finally an executed transaction with a corresponding STARK proof.

Documentation.

Features

Description of this crate's feature:

Features Description
std Enable usage of Rust's std, use --no-default-features for no-std support.
concurrent Enables concurrent code to speed up runtime execution.
testing Enables testing utilities and reduces proof-of-work requirements to speed up tests' runtimes.

License

This project is MIT licensed.

Dependencies

~14–41MB
~646K SLoC