docs: add ABI overview to artifacts #30
Open
Conversation
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
Added a README to the artifacts directory to explain what the JSON files represent and when they should be updated. This should make it clearer to new contributors that these are Solidity ABI files and how they relate to the exchange contracts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Added a README to the artifacts directory to explain what the JSON files represent and when they should be updated. This should make it clearer to new contributors that these are Solidity ABI files and how they relate to the exchange contracts
Note
Low Risk
Documentation-only change with no effect on runtime behavior or security.
Overview
Adds a new
artifacts/README.mddocumenting that the committed JSON files inartifacts/are Solidity contract ABI artifacts forCTFExchangeandConditionalTokens, and noting they should be kept in sync when contracts are regenerated.Written by Cursor Bugbot for commit 93b69ff. This will update automatically on new commits. Configure here.