feat: remove shared contract error collisions#75
Open
OkeyAmy wants to merge 1 commit into
Open
Conversation
|
I'd like to work on this. Approach:
Estimated effort: ~1-2 hours. PR incoming shortly. |
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
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.
Closes #41
Motivation
#[contracterror]enums (common::ErrorCodeandcampaign::Error) whose discriminants overlapped, risking mis-attributed on-chain error codes when both crates are present in a downstream dependency graph.ErrorCodefromcommonand makes the campaign crate the canonical owner of campaign error discriminants.Description
#[contracterror]enumErrorCodefromcommon/src/lib.rsand stop importingcontracterrorthere socommonbecomes a pure shared data-types crate.commoncrate metadata (common/Cargo.toml) and crate docs to document that it intentionally does not publish a#[contracterror]enum.campaign/src/types.rsdocs to state thatcampaign::Erroris the canonical campaign error enum and cannot collide with a shared error space.campaign::types::error_code_tests::campaign_error_discriminants_are_unique_without_common_error_space) that asserts campaign error discriminants are internally unique.docs/deployment.mdexplaining the decision and that no migration sequencing is required because no campaign discriminants were renumbered.