feat: add CI gate for contract ABI compatibility - #131
Open
Cerome360 wants to merge 1 commit into
Open
Conversation
Contributor
|
Rebase against |
Contributor
|
Conflicts against develop from the recent merge batch. Rebase and force-push. |
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 #111
Summary
This PR adds a CI workflow step to prevent accidental and silent changes to contract ABIs, which can break downstream indexers and SDKs.
What Changed
stellar/scripts/generate-abis.shto extract the ABI for the four main smart contracts usingstellar contract inspect.abi:snapshotscript tostellar/package.jsonfor easy updates.stealth_announcer,stealth_registry,stealth_sender, andwraith_namesunderstellar/abi/..github/workflows/ci.ymlto generate the ABIs during thestellarCI job and fail if they differ from the committed snapshots usinggit diff --exit-code abi/.stellar/abi/to instruct contributors on how to intentionally update the ABI.Design Decisions & Notes
stellar contract inspectas specified by the issue.Acceptance Criteria
stellar/abi/README.mdexplains the flow