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

Protocol V2 docs #45

Merged
merged 12 commits into from
Jul 1, 2024
Merged

Protocol V2 docs #45

merged 12 commits into from
Jul 1, 2024

Conversation

anomit
Copy link
Member

@anomit anomit commented Jun 19, 2024

Add documentation on the new components and approaches in the second version of the protocol

Checklist

  • My branch is up-to-date with upstream/main branch.
  • Everything works and tested for major version of Python/NodeJS/Go and above.
  • I ran pre-commit checks against my changes.
  • I've written tests against my changes and all the current present tests are passing.

Current behaviour

NA

New expected behaviour

NA

Change logs

Added

Protocol V2 docs:

  • Overview
  • Sequencer
  • Relayer
  • Validator
  • Protocol State

Fixes PowerLoom/product#141

Deployment Instructions

NA

@anomit anomit self-assigned this Jun 19, 2024
@anomit anomit marked this pull request as ready for review June 20, 2024 13:48
Copy link
Collaborator

@Seth-Schmidt Seth-Schmidt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall content is clear as far as highlighting the differences between v1 and v2 of the protocol. Starting with why the changes need to be made and breaking down each additional component into it's own section made it easy to follow as someone who hasn't use v2 yet.

I did find some minor changes to be made while going through it, made a secondary PR here:

#46

Copy link
Member

@xadahiya xadahiya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good after 735f4c9

Copy link

@Sulejman Sulejman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, in sync with changes.

@anomit anomit merged commit c4c6c0a into main Jul 1, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants