chore!: Restrict packages to contain at most a single contract#2668
Merged
kevaundray merged 2 commits intomasterfrom Sep 12, 2023
Merged
chore!: Restrict packages to contain at most a single contract#2668kevaundray merged 2 commits intomasterfrom
kevaundray merged 2 commits intomasterfrom
Conversation
Contributor
|
Does this break anything in aztec-packages? |
Member
Author
|
Nope, they've been following this by convention already. |
kevaundray
reviewed
Sep 12, 2023
kevaundray
previously approved these changes
Sep 12, 2023
Contributor
kevaundray
left a comment
kevaundray
left a comment
There was a problem hiding this comment.
LGTM - I can see us needing a type alias for (CompiledContract, DebugArtifact) in the future
* master: chore: Embed a file map into `CompiledProgram`/`CompiledContract` (#2666)
Member
Author
Not anymore. |
5 tasks
kevaundray
approved these changes
Sep 12, 2023
TomAFrench
added a commit
that referenced
this pull request
Sep 12, 2023
* master: chore!: Restrict packages to contain at most a single contract (#2668)
TomAFrench
added a commit
that referenced
this pull request
Sep 13, 2023
* master: chore: fix npm token for abi_wasm publishing (#2633) chore(ci): switch to using `Swatinem/rust-cache` action (#2671) feat: compile circuits and query circuit sizes in parallel for `nargo info` (#2665) chore(ci): use mock backend for all tests (#2670) chore!: Restrict packages to contain at most a single contract (#2668) chore: Embed a file map into `CompiledProgram`/`CompiledContract` (#2666) feat: Compile workspace packages in parallel (#2612) fix(wasm): Avoid requesting stdlib paths from the source-resolver (#2650) chore: add abi_wasm to release-please (#2664) chore: refactor `execute_cmd` (#2656) chore: defer reporting of errors until after compilation and optimization is finished (#2659) fix: fix compilation using `aztec` feature flag (#2663) fix: remove duplicate file extension in stack trace (#2655) chore: use `DebugArtifact`s instead of `FileManager` to report errors (#2641) chore: Fix clippy warnings for rust version 1.67.0 (#2661) fix(wasm): Apply transformation map to circuit debug information in `noir_wasm` (#2635) fix: Fix `update_acir` deleting all debug information (#2643)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Problem*
Resolves #2329
Summary*
We currently allow an unlimited number of contracts in a single package despite it being generally agreed that packages should contain a single contract.
We should start enforcing this before people start relying on this behaviour. It's also much more convenient for us to encode this expectation into the type system so we don't need to pass around
Vec<(CompiledContract, DebugArtifact)>everywhere and instead have it match binary packages.I've then added an error which is returned if we find more than one contract within a package. Attempting to compile a contract package with multiple contracts will now print an error as below:
Documentation
This PR requires documentation updates when merged.
Contracts packages must only contain a single contract.
Additional Context
PR Checklist*
cargo fmton default settings.