Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

greenhat
Copy link
Contributor

@greenhat greenhat commented Oct 23, 2024

This PR is stacked on #1554 and should be merged after it

TODO:

  • Finish/polish the naming and implementation;
  • Switch the compiler to this implementation and use the Package in LinkLibrary;
  • Loading Package in the VM;
  • 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 0xPolygonMiden/compiler#346
The compiler's PR that uses miden-package from this PR is 0xPolygonMiden/compiler#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.

@greenhat greenhat changed the title Ass miden-package crate with Package type to represent a compiled Miden program/library. Add miden-package crate with Package type to represent a compiled Miden program/library. Oct 23, 2024
@greenhat greenhat force-pushed the greenhat/miden-package branch 4 times, most recently from 76a4b7e to 9ff342e Compare October 30, 2024 09:44
@greenhat greenhat changed the base branch from next to greenhat/library-deser-uncheck-exports October 30, 2024 10:15
@greenhat greenhat force-pushed the greenhat/library-deser-uncheck-exports branch from 1ca8581 to 3581727 Compare November 4, 2024 17:37
Base automatically changed from greenhat/library-deser-uncheck-exports to next November 4, 2024 21:37
@greenhat greenhat force-pushed the greenhat/miden-package branch 7 times, most recently from 41b5f5d to c5ff6f0 Compare November 12, 2024 14:07
@greenhat greenhat force-pushed the greenhat/miden-package branch 4 times, most recently from 90162dd to e2c346f Compare November 13, 2024 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant