Add `miden-package` crate with `Package` type to represent a compiled Miden program/library. - Githubissues

0xPolygonMiden / miden-vm

STARK-based virtual machine

MIT License

632 stars 161 forks source link

Add `miden-package` crate with `Package` type to represent a compiled Miden program/library. #1544

Open greenhat opened 1 month ago

greenhat commented 1 month ago

TODO:

[x] Finish/polish the naming and implementation;
[x] Switch the compiler to this implementation and use the Package in LinkLibrary;
[ ] High-level type function signatures (move midenc-hir-type crate to VM repo);
[ ] Impl Arbitrary for the Package (and all used types including MastForest);
[ ] Tests for roundtrip serialization/deserialization;
[ ] Document the binary format and the packaging in the README.md;
[ ] Enable ignored tests;

Describe your changes

This PR adds miden-package crate with Package type ported from the compiler's ad-hoc implementation to represent a compiled Miden program/library. The reasons for the new crate are explained in https://github.com/0xPolygonMiden/compiler/issues/346 The compiler's PR that uses miden-package from this PR is https://github.com/0xPolygonMiden/compiler/pull/349

Checklist before requesting a review

Repo forked and branch created from next according to naming convention.
Commit messages and codestyle follow conventions.
Relevant issues are linked in the PR description.
Tests added for new functionality.
Documentation/comments updated according to changes.