docs: add intent lifecycle diagram, error reference table, DataKey rustdoc, and security threat model - #165
Open
abdegenius wants to merge 1 commit into
Conversation
…stdoc, and security threat model Closes stellar-vortex-protocol#83 Closes stellar-vortex-protocol#84 Closes stellar-vortex-protocol#85 Closes stellar-vortex-protocol#86
|
@abdegenius Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Closes #83
Closes #84
Closes #85
Closes #86
Summary
Errorvariants to their triggering function and exact condition (Document every Error variant with its exact trigger condition #84)DataKeyenum variant explaining storage tier and lifecycle (Add rustdoc for every DataKey variant explaining its storage type and lifecycle #86)SECURITY.mdwith a threat-model section covering assets, trust assumptions, and known limitations forintent_settlement(Write a SECURITY.md threat-model section specific to intent_settlement #85)Validation