Add snap_getState, snap_setState, snap_clearState methods
#2916
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
Mrtenz
force-pushed
the
mrtenz/state-methods
branch
2 times, most recently
from
b620e54 to
0e32390
Compare
Co-authored-by: Frederik Bolding <[email protected]>
Co-authored-by: Frederik Bolding <[email protected]>
Co-authored-by: Frederik Bolding <[email protected]>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Co-authored-by: Frederik Bolding <[email protected]>
FrederikBolding
previously approved these changes
Dec 18, 2024
FrederikBolding
approved these changes
Dec 18, 2024
Mrtenz
added a commit
that referenced
this pull request
Dec 19, 2024
) This adds support for the state methods introduced in #2916 to `snaps-simulation` (and `snaps-jest`), and updates the example to test these methods as well. ## Breaking changes - The middleware hooks in `snaps-simulation` were separated into two separate types, `PermittedMiddlewareHooks` and `RestrictedMiddlewareHooks`. - The `MiddlewareHooks` type was removed.
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.
snap_manageStateis currently the only way to manage state in a Snap. We added it as a single method initially, because it was complicated to add separate methods with a single permission. In addition,snap_manageStateonly supports operations on the entire state, it's not possible to get or set partial state.Instead, I've added new methods, which will eventually replace
snap_manageState. Thesnap_getStateandsnap_setStatemethods accept an optionalkey, which can be an object property-style key (e.g.,some.nested.value), and returns or updates the value at that location in the state. This makes it possible to do partial updates, or receive a small part of the state easily.Currently these methods require the
snap_manageStatepermission. In the future (when we removesnap_manageState) this could be replaced by an endowment.