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

[Docs] Relay session & claim/proof diagrams #478

Merged
merged 14 commits into from
Jun 24, 2024
Merged

Conversation

bryanchriswhite
Copy link
Contributor

@bryanchriswhite bryanchriswhite commented Apr 11, 2024

Summary

Incorporates RPC Session Life-Cycle into docusaurus docs.

Issue

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR. THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
  • Documentation changes: make docusaurus_start

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and referenced any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@bryanchriswhite bryanchriswhite added the documentation Improvements or additions to documentation label Apr 11, 2024
@bryanchriswhite bryanchriswhite self-assigned this Apr 11, 2024
@bryanchriswhite bryanchriswhite mentioned this pull request Apr 11, 2024
10 tasks
@bryanchriswhite bryanchriswhite linked an issue Apr 11, 2024 that may be closed by this pull request
10 tasks
@bryanchriswhite bryanchriswhite marked this pull request as ready for review April 12, 2024 19:06
@Olshansk
Copy link
Member

@bryanchriswhite Aiming to review this by mid week.

@Olshansk
Copy link
Member

Olshansk commented May 2, 2024

@bryanchriswhite Just a heads up that I started reviewing this!

Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

@bryanchriswhite I haven't had a chance to review this in detail and don'tw ant to keep the PR sitting any longer.

Can you merg it in as is w/ a TODO_TECHDEBT(@Olshansk): review in detail due to auto-approval in #478?

@bryanchriswhite
Copy link
Contributor Author

%% ---
%% displayMode: compact
%% ---
gantt    
    title Session Relay / Claim / Proof Windows
    dateFormat ss
    axisFormat %S
    tickInterval 1second

    section Relays
        Session N Start : milestone, sns, 00, 0s
        num_blocks_per_session          :nbps, 00, 4s
        Session N End :milestone, sne, after nbps, 0s
        grace_period_end_offset_blocks : gpof, after sne, 2s
        Session N+1 Start : milestone, after sne, 0s
    section Claim Window
        claim_window_open_offset_blocks : cwob, after sne, 10ms
        Session N Claim Window Open : milestone, cwo, after cwob, 0s
        claim_window_close_offset_blocks : cwcb, after cwo, 4s
        Session N Claim Window Close : milestone, cwc, after cwcb, 0s
    section Proof Window
        proof_window_open_offset_blocks : pwob, after cwc, 10ms
        Session N Proof Window Open : milestone, pwo, after pwob, 0s
        proof_window_close_offset_blocks : pwcb, after pwo, 4s
        Session N PRoof Window Close : milestone, pwc, after pwcb, 0s

Loading
timeline
    title Session Claim/Proof Windows
    
    section Session
    Session
    : session N starts
    : relays for session N
    : num_blocks_per_session blocks elapse 
    : session N ends    
    section Claim Window
    Claim window & grace period
    : late relays for session N
    : session_grace_period blocks elapse
    : grace period ends
    
    : claim_window_open _offset_blocks - session_grace_period blocks elapse
    : claim window opens
    : claims for session N
    : claim_window_close _offset_blocks - session_grace_period blocks elapse
    : claim window closes
    section Proof Window
    Proof window
    : proof_window_open _offset_blocks  blocks elapse
    : proof window opens
    : proofs for session N
    : proof_window_close _offset_blocks blocks elapse
    : proof window closes

Loading

@bryanchriswhite bryanchriswhite merged commit 9e50319 into main Jun 24, 2024
11 of 12 checks passed
@bryanchriswhite bryanchriswhite deleted the docs/diagrams branch June 24, 2024 10:46
bryanchriswhite added a commit that referenced this pull request Jun 26, 2024
…02/refactor/relayminer

* pokt/issues/402/feat/rng:
  [Code Health] refactor: tx hash encoding (#617)
  [Docs] Relay session & claim/proof diagrams (#478)
  Empty commit
  [Code Health] refactor: block query client interface (#616)
  [TODO] chore: cleanup done TODOs (#627)
  [TODOs] chore: cleanup validate session ID TODOs (#608)
  [LocalNet] Switch to CosmosSDK defaults (#609)
  [Relay Mining] Emit events and refactor test helpers (#610)
  [Docs] Minor improvements to `adding_params.md` (#623)
  [Telemetry] chore: add probabilistic proof telemetry (#605)
bryanchriswhite added a commit that referenced this pull request Jun 26, 2024
…period

* pokt/main:
  [Code Health] refactor: random number generation (#618)
  [Code Health] refactor: tx hash encoding (#617)
  [Docs] Relay session & claim/proof diagrams (#478)
  [Code Health] refactor: block query client interface (#616)
bryanchriswhite added a commit that referenced this pull request Jun 27, 2024
…aim-proof-distribution

* issues/402/refactor/relayminer: (21 commits)
  fix: unflake and speed up tests
  chore: speed up & improve tests
  chore: update comments
  chore: simplify
  [E2E] Add logging output from the init-container step (#635)
  fix: failing test
  Empty commit
  [Code Health] refactor: random number generation (#618)
  chore: review improvements
  chore: review improvments
  [Code Health] refactor: tx hash encoding (#617)
  [Docs] Relay session & claim/proof diagrams (#478)
  Empty commit
  [Code Health] refactor: block query client interface (#616)
  chore: review feedback improvements
  [TODO] chore: cleanup done TODOs (#627)
  [TODOs] chore: cleanup validate session ID TODOs (#608)
  [LocalNet] Switch to CosmosSDK defaults (#609)
  [Relay Mining] Emit events and refactor test helpers (#610)
  [Docs] Minor improvements to `adding_params.md` (#623)
  ...
@bryanchriswhite bryanchriswhite linked an issue Jun 28, 2024 that may be closed by this pull request
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

[TODO] @bryanchriswhite's Iteration16 TODOs [Docs] RPC session life-cycle
2 participants