-
Notifications
You must be signed in to change notification settings - Fork 6
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
Conversation
@bryanchriswhite Aiming to review this by mid week. |
@bryanchriswhite Just a heads up that I started reviewing this! |
There was a problem hiding this 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
?
%% ---
%% 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
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
|
…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)
…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) ...
Summary
Incorporates RPC Session Life-Cycle into docusaurus docs.
Issue
Type of change
Select one or more:
Testing
make go_develop_and_test
make test_e2e
devnet-test-e2e
label to the PR. THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.make docusaurus_start
Sanity Checklist