This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
contracts: Reduce the API surface #8359
Merged
Conversation
This file contains 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
athei
added
A0-please_review
athei
added
the
D3-trivial 🧸
gui1117
approved these changes
Mar 22, 2021
5 tasks
athei
added
D2-notlive 💤
shawntabrizi
approved these changes
Mar 23, 2021
|
bot merge |
|
Trying merge. |
ghost
merged commit
hirschenberger
pushed a commit
to hirschenberger/substrate
that referenced
this pull request
Apr 14, 2021
* contracts: Remove types and storage from the public interface * contracts: Remove current_schedule() getter * contracts: Improve documentation * Update README.md * Fix integration test
This pull request was closed.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Originally, all storage items and the fields of the
Scheduledata structure were public. This means that every minor change like adding a new contract callable function would require releasing a new major version. This is because every contract callable function requires a new entry in theSchedule.With this PR users of the crate are required to construct the
Schedulethrough itsDefaultimplementation. Changes to this default constructedSchedulecan be done by calling associated function on theSchedule. This allows for changes to theSchedulewithout releasing a new major version. When the need arises we will add further functions to theScheduleor convert it to a builder pattern.The same is true for other storage items. When someone comes forward with a use case for accessing the raw storage of
pallet_contractswe will consider adding a public function to do so. But by default the data should be private in order to control the public API and prevent churning through major versions.