Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

full-stack RUN protocol transaction diagram #4813

Open
dckc opened this issue Mar 10, 2022 · 2 comments
Open

full-stack RUN protocol transaction diagram #4813

dckc opened this issue Mar 10, 2022 · 2 comments
Assignees
Labels
audit-restival Purple Team review of RUN Protocol cosmic-swingset package: cosmic-swingset documentation Improvements or additions to documentation enhancement New feature or request Inter-protocol Overarching Inter Protocol

Comments

@dckc
Copy link
Member

dckc commented Mar 10, 2022

What is the Problem Being Solved?

Understanding the full path that a transaction takes through our system is a considerable challenge.

This issue is on behalf of @danwt , inspired by a comment from @rowgraus in the architecture scratchpad:

I would love to see a diagram of the life cycle of a transaction from the moment a user approves it in his/her wallet including delivery to validators, inclusion in mempool and consensus, entering the swingset runqueue and being processed [and accordingly leading to some meaningful action in the RUN protocol].

Description of the Design

Create an oboarding material to understand the lifecycle of a transaction from beginning to end.

Specifically: a sequence diagram(s) of a transaction that makes a swap using the AMM, starting with approval and ending some sensible time later.

@warner @michaelfig we will be interested in your help filling in the details.

I think we have a couple of somewhat relevant diagrams, FWIW:

Security Considerations

A full picture should provide awareness of risks in various parts of the system.

Test Plan

Constructing the diagram should let us reflect on the level of test coverage in the various parts.

@dckc dckc added documentation Improvements or additions to documentation enhancement New feature or request cosmic-swingset package: cosmic-swingset Inter-protocol Overarching Inter Protocol audit-restival Purple Team review of RUN Protocol labels Mar 10, 2022
@dckc dckc self-assigned this Mar 10, 2022
@dckc
Copy link
Member Author

dckc commented Mar 11, 2022

@danwt , @warner , and I had a good discussion today, but I'm not sure what expectations to set going forward. I'm somewhat inclined to close this and let @informalsystems track any further work, but I'll leave this open for a bit.

cc @jessysaurusrex @arirubinstein

p.s. recording available internally.

@dckc dckc removed their assignment Mar 11, 2022
@danwt
Copy link

danwt commented Mar 11, 2022

I think that's fine @dckc, we mostly accomplished the goal. I will post the resulting diagram(s) here and that will be sufficient.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audit-restival Purple Team review of RUN Protocol cosmic-swingset package: cosmic-swingset documentation Improvements or additions to documentation enhancement New feature or request Inter-protocol Overarching Inter Protocol
Projects
None yet
Development

No branches or pull requests

3 participants