[Docs] Claim expiration

[bryanchriswhite]

Summary

• Add "Claim Expiration" sub-section to "Session Window & On-Chain Parameters".
• Update the table of contents.

Issue

• [Docs] Claim & Proof expiration Documentation #419

Type of change

Select one or more:

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

Testing

Documentation changes (only if making doc changes)

• make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

• Unit Tests: make go_develop_and_test
• LocalNet E2E Tests: make test_e2e
• See quickstart guide for instructions

PR Testing (only if making code changes)

• 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.
  • Optionally run make trigger_ci if you want to re-trigger tests without any code changes
  • If tests fail, try re-running failed tests only using the GitHub UI as shown here

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 reference any new tickets, if applicable
• I have left TODOs throughout the codebase, if applicable

Summary by CodeRabbit

• Documentation
  • Enhanced the explanation of claim expiration due to a missing proof within the proof window, leading to forfeiture of rewards by the supplier.
  • Added a new subsection on claim expiration under "Session Windows & On-Chain Parameters."
  • Detailed the consequences of claim expiration and the importance of closing the proof window for operational efficiency.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

This update enhances documentation on claim expiration by detailing the process and reasons for expiring claims when proofs are not submitted within the proof window, leading to forfeiture of rewards. It elaborates on operational efficiency and the necessity of timely closing the proof window.

Changes

File Path	Change Summary
docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md	Added [Claim Expiration] under [Session Windows & On-Chain Parameters]. Detailed the expiration process, consequences, and reasons for closing the proof window.

Possibly related issues

• [Docs] Claim & Proof expiration Documentation #419: Documenting the claim and proof expiration process aligns well with the objective of understanding and implementing this mechanism.

Poem

In the realm of chains, claims must expire,
Proofs unspoken, dreams retire.
Timely windows, close with grace,
Rewards forlorn, a distant trace.
Efficiency reigns, with purpose clear,
The network hums, no burden to bear.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aec367e and 442c8c3.

Files selected for processing (1)

• docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md (3 hunks)

Additional context used

LanguageTool

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md

[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...Claim Expiration](#claim-expiration) - Session - Session Duration - [Sessi...

(ENGLISH_WORD_REPEAT_RULE)

---

[style] ~134-~134: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...a Supplier fails to submit a Proof prior to the Proof Window closing, the claim w...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

---

[grammar] ~140-~140: The plural noun “claims” cannot be used with the article “a”. Did you mean “a claim” or “claims”?
Context: ...lement SHOULD be limited to considering a claims created within a rolling window of bloc...

(A_NNS)

---

[uncategorized] ~349-~349: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... the Proof Window, the Claim will expire and the supplier will forfeit rewards for t...

(COMMA_COMPOUND_SENTENCE_2)

Markdownlint

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md

133-133: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

350-350: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

Additional comments not posted (1)

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md (1)

18-19: Update Table of Contents for Consistency

Ensure that the new section "Claim Expiration" is consistently formatted and aligned with other sections in the Table of Contents.

[coderabbitai]

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 442c8c3 and 7f58e06.

Files selected for processing (1)

• docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md (3 hunks)

Additional context used

LanguageTool

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md

[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...Claim Expiration](#claim-expiration) - Session - Session Duration - [Sessi...

(ENGLISH_WORD_REPEAT_RULE)

---

[uncategorized] ~139-~139: Possible missing comma found.
Context: ...ur while the application stake is still locked and applications must be allowed comple...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~139-~139: Possible missing preposition found.
Context: ...locked and applications must be allowed complete unstaking in finite time. 1. Claim sett...

(AI_HYDRA_LEO_MISSING_TO)

Markdownlint

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md

142-142: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

141-141: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Additional comments not posted (5)

docusaurus/docs/protocol/primitives/claim_and_proof_lifecycle.md (5)

131-132: Remove trailing space.

Trailing spaces should be removed to maintain clean formatting.

-### Claim Expiration 
+### Claim Expiration

---

133-135: Add comma before "and".

Use a comma before “and” if it connects two independent clauses.

-submit a `Proof` during the Proof Window, the Claim will expire and the supplier will forfeit rewards for the claimed
+submit a `Proof` during the Proof Window, the Claim will expire, and the supplier will forfeit rewards for the claimed

---

133-135: Simplify wording.

Replace "prior to" with "before" to improve readability.

-If a claim requires a proof (as determined by [Probabilistic Proofs](probabilistic_proofs.md)) and a `Supplier` fails 
-to submit a `Proof` prior to the `Proof Window` closing, the claim will expire and the `Supplier` will forfeit any
-rewards for the work done.
+If a claim requires a proof (as determined by [Probabilistic Proofs](probabilistic_proofs.md)) and a `Supplier` fails
+to submit a `Proof` before the `Proof Window` closes, the claim will expire and the `Supplier` will forfeit any
+rewards for the work done.

---

140-140: Fix grammar issue.

The plural noun “claims” cannot be used with the article “a”. Use "claims" without the article "a".

-1. Claim settlement SHOULD be limited to considering a claims created within a rolling window of blocks to decouple settlement from a long-tail accumulation of unsettled claims.
+1. Claim settlement SHOULD be limited to considering claims created within a rolling window of blocks to decouple settlement from a long-tail accumulation of unsettled claims.

---

18-19: Fix duplicated word in the table of contents.

Remove the repeated "Session" word for clarity.

- - [Session](#session)
+ - [Session](#session)

Likely invalid or redundant comment.

[Olshansk]

Did you ever merge in your mermaid diagram with the sequence of steps for the window that you left in a PR comment once?

[bryanchriswhite]

I rewrote it as the gantt chart that's in this section. The timeline diagram doesn't support concurrent events, which is necessary to describe the grace period.

[Olshansk]

General feedback (not actionable right now).

This sort of documentation is very accurate and very correct but it reminds me of IEEE RFCs: https://datatracker.ietf.org/doc/html/rfc7951

If we're doing is as a reference for ourselves and AIs, no changes.

As you iterate on docs in the future, just keep in mind that 99% of people will want to:

1. Read 1-2 sentences
2. See colors and titles
3. Look at pictures
4. Move on

[bryanchriswhite]

The deliverable was to capture this detail. This seemed like the most appropriate place to do so. I couldn't think of a way to make a picture out of this at the time.