doc: add a sequence diagram of the snap invocation #1356
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
Codecov Report
@@ Coverage Diff @@
## main #1356 +/- ##
==========================================
+ Coverage 96.20% 96.34% +0.14%
==========================================
Files 149 151 +2
Lines 4555 4598 +43
Branches 743 747 +4
==========================================
+ Hits 4382 4430 +48
+ Misses 173 168 -5 |
naugtur
force-pushed
the
naugtur/diagram
branch
from
f9fe931
to
8ae5058
Compare
|
I fixed a few things and added some detail as to how responses are returned. I'm not sure all the notes are still relevant to include though 🤔 |
Mrtenz
requested changes
May 3, 2023
diagram.md
Outdated
|
|
||
| `subjectType` is being checked before a middleware gets to handle an RPC request. The snap is going through the same permission mechanism in the provider as a dApp would. | ||
|
|
||
| PermissionsController is fed the snapId as origin, but the snapId is coming from |
There was a problem hiding this comment.
oh no, a lost stream of consciousness. gonna be hard to finish now :D
Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
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.
This is a sequence diagram based on a security-focused walkthrough we had on 2023-02-20
The level of detail is arbitrary, but adding more would seem like rewriting the code into a diagram.
Descriptions and notes might need clarification.
@FrederikBolding I left you a todo at the bottom because I didn't want to make things up ;)
Preview:
https://github.com/MetaMask/snaps-monorepo/blob/naugtur/diagram/diagram.md