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.

Sign up for GitHub

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

Jump to bottom

[Documentation] E2E Relay Validation Documentation #918

Closed
4 tasks
Olshansk opened this issue Jul 19, 2023 · 2 comments · Fixed by #938
Closed
4 tasks

[Documentation] E2E Relay Validation Documentation #918

Olshansk opened this issue Jul 19, 2023 · 2 comments · Fixed by #938
Assignees
@adshmh
Labels
documentation Improvements or additions to documentation utility Utility specific changes
Milestone
M3: Pocket RoS (R...

Comments

@Olshansk
Copy link
Member

Olshansk commented Jul 19, 2023 •
edited
Loading

Objective

Document (visually) the current & future state of relay validation.

Origin Document

July 18th Protocol Hour which demoed the first E2E trustless relay

Goals

  • Reduce cognitive load: Lower the barrier to entry to understand how relay validation currently works (on the client and servicer)
  • Accessible documentation: Make the documentation accessible to both technical and non-technical individuals
  • Identify gaps: Document future work w.r.t what we have in the context of relay validation today and what we need in the future

Deliverable

  • Use mermaid diagrams & bullet points (not lengthy paragraphs) to document the following:
    • Validation of relay on the client side
    • Validation of relay on the servicer side
    • Session caching & node selection
  • Optional: If using flowcharts blocks in diagram pointing to TODOs/tickets/placeholder

Non-goals / Non-deliverables

  • Making any code modifications
  • Creating/documenting an exhaustive list of everything we need to implement in the future

Creator: @Olshansk
Co-Owners: @adshmh
@Olshansk Olshansk added documentation Improvements or additions to documentation utility Utility specific changes labels Jul 19, 2023
@Olshansk
Copy link
Member Author

@adshmh Can you PTAL and let me know if things 👀 good to you?

@Olshansk Olshansk changed the title [Documentation] E2E Relay Validation Documentaiton [Documentation] E2E Relay Validation Documentation Jul 19, 2023
@adshmh
Copy link
Contributor

adshmh commented Jul 20, 2023

@adshmh Can you PTAL and let me know if things eyes good to you?

Thanks, LGTM. I will open the PR(s) needed to address this shortly.

@adshmh adshmh mentioned this issue Jul 26, 2023
Merged
20 tasks
adshmh added a commit that referenced this issue Jul 31, 2023
@adshmh
[Utility] Create trustless_relay_validation.md (#938)
75e0ea6 
## Description

Add diagrams to describe validations done on trustless relays. Part of
work on #918

## Issue

Fixes #918 

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Major breaking change
- [X] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Add a new markdown file to show trustless relay validations.

## Testing

- [ ] `make develop_test`; if any code changes were made
- [ ] `make test_e2e` on [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any code changes were made
- [ ] `e2e-devnet-test` passes tests on
[DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd);
if any code was changed
- [ ] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [ ] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made

## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)
red-0ne pushed a commit that referenced this issue Aug 2, 2023
@adshmh @red-0ne
[Utility] Create trustless_relay_validation.md (#938)
c903ca1 
## Description

Add diagrams to describe validations done on trustless relays. Part of
work on #918

## Issue

Fixes #918 

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Major breaking change
- [X] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Add a new markdown file to show trustless relay validations.

## Testing

- [ ] `make develop_test`; if any code changes were made
- [ ] `make test_e2e` on [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any code changes were made
- [ ] `e2e-devnet-test` passes tests on
[DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd);
if any code was changed
- [ ] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [ ] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made

## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adshmh adshmh

Labels
documentation Improvements or additions to documentation utility Utility specific changes
Projects
V1 Dashboard
Status: Done
Milestone
M3: Pocket RoS (Relay or Slash)
Development

Successfully merging a pull request may close this issue.

[Utility] Create trustless_relay_validation.md pokt-network/pocket
2 participants
@Olshansk @adshmh