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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 37 commits into from
Feb 12, 2025
Merged

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

merged 37 commits into from
Feb 12, 2025
+933 −45

Conversation

greenhat
Copy link
Contributor

@greenhat greenhat commented Oct 23, 2024 •
edited
Loading

This PR adds miden-package crate with Package type ported from the compiler's ad-hoc implementation to represent a compiled Miden program/library.

Please consider reviewing this PR commit-by-commit. I crafted the commits to be focused on a single change and show the evolution of the implementation.

The reasons for the new crate are explained in 0xPolygonMiden/compiler#376

The compiler's PR that uses miden-package from this PR is 0xPolygonMiden/compiler#349

@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 mentioned this pull request Oct 30, 2024
Merged
@greenhat greenhat force-pushed the greenhat/miden-package branch from 9ff342e to 7c9b95b Compare October 30, 2024 10:14
@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 mentioned this pull request Nov 12, 2024
Open
@greenhat greenhat force-pushed the greenhat/miden-package branch 6 times, most recently from 211f34c to 84ea102 Compare November 19, 2024 08:49
@greenhat greenhat changed the base branch from next to greenhat/i1547-mastforest-add-advicemap November 19, 2024 08:49
@greenhat greenhat changed the title Add miden-package crate with Package type to represent a compiled Miden program/library. [2/2] Add miden-package crate with Package type to represent a compiled Miden program/library. Nov 19, 2024
@greenhat greenhat force-pushed the greenhat/i1547-mastforest-add-advicemap branch from eda4a01 to 006e03a Compare November 19, 2024 14:40
@greenhat greenhat force-pushed the greenhat/miden-package branch 2 times, most recently from 5ec902e to d6419ca Compare November 19, 2024 15:00
@greenhat greenhat force-pushed the greenhat/i1547-mastforest-add-advicemap branch from 006e03a to 92f3309 Compare November 20, 2024 07:05
greenhat and others added 18 commits February 11, 2025 16:58
@greenhat @plafer
docs: wording
6bfdf5f 
Co-authored-by: Philippe Laferrière <[email protected]>
@greenhat
chore: fix clippy, formatting, cleanup comments
94a1c31
@greenhat
refactor: rename types for resolved dependency for the Package
6881653
@greenhat
refactor: remove SystemLibraryId and use DependencyName(String)
9922fa2
@greenhat
chore: add license in package/README.md and fix docs.rs version in
6107776 
Cargo.toml
@greenhat
refactor: serialize Package with Serializable/Deserializable impls
9007128 
instead of `bitcode` and `serde`
@greenhat
refactor: make PackageExport::name to be QualifiedProcedureName,
f6e137e 
Implement `Serializable/Deserializable` and `Arbitrary`(proptest)
for `QualifiedProcedureName`. Add serialization roundtrip tests for
`LibraryPath` and `ProcedureName`.
@greenhat
chore: formatting
5c55f3c
@greenhat
chore: fix no_std build
1005214
@greenhat
fix: relax Ident and ProcedureName validation, use checked
d994978 
constructors in deserialization.
@greenhat
chore: export Digest, MastForest, Program in miden-package, c…
b5c198a 
…ode cleanup
@greenhat
refactor: move tests to serialization module, rename package.rs to
d516998 
`package/mod.rs`
@greenhat
refactor: remove LibraryPathparsing fallback on deserialization
bf59a29 
Because the relaxed `Ident` validation now parses Wasm Component Model
style module names.
@greenhat
chore: update miden-package version to 0.12.0
cc71cc6 
Update the description.
@greenhat
chore: error messages and comment formatting
bb6a974
@greenhat
chore: re-export assembly types used in the miden-mast-package
2dba461 
public interface
@greenhat
refactor: rename miden-package crate to miden-mast-package
944b6cc
@greenhat
chore: bump miden-mast-package version to 0.13.0
f236253
@greenhat greenhat force-pushed the greenhat/miden-package branch from 4d23f94 to f236253 Compare February 11, 2025 15:09
@greenhat greenhat changed the title Add miden-package crate with Package type to represent a compiled Miden program/library. Add miden-mast-package crate with Package type to represent a compiled Miden program/library. Feb 11, 2025
@greenhat
Copy link
Contributor Author

@bobbinth Thank you for the review! Thank you for your patience. I addressed all the notes, renamed the crate and rebased the branch. Please do another round.

@greenhat greenhat requested a review from bobbinth February 11, 2025 15:27
bobbinth
bobbinth approved these changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you! I left of very minor nit inline and also the change from #1544 (comment) somehow got reverted.

Once the above is done, should we merge it into next?

@greenhat greenhat force-pushed the greenhat/miden-package branch from 220ac5c to 5dfc510 Compare February 12, 2025 03:41
@greenhat
Copy link
Contributor Author

Looks good! Thank you! I left of very minor nit inline and also the change from #1544 (comment) somehow got reverted.

Thanks! Fixed.

Once the above is done, should we merge it into next?

Yes, we can merge it into next. I branched out https://github.com/0xPolygonMiden/miden-vm/tree/greenhat/miden-package-pre-eam-vm-for-compiler from this branch before the rebase to use the pre-element-addressable-memory version of this branch in the compiler until we migrate our memory model.

bobbinth
bobbinth approved these changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@bobbinth bobbinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good! Thank you!

@bobbinth bobbinth merged commit 007e350 into next Feb 12, 2025
9 checks passed
@bobbinth bobbinth deleted the greenhat/miden-package branch February 12, 2025 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plafer plafer plafer approved these changes

@bobbinth bobbinth bobbinth approved these changes

@bitwalker bitwalker Awaiting requested review from bitwalker

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@greenhat @bobbinth @plafer