Conversation
…izing or is stalled. This lack of clarification in the documentation was identified when creating docs for RPC providers and exchanges.
There was a problem hiding this comment.
Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies how the /v2 APIs behave when Filecoin Fast Finality (F3) is not finalizing or falls behind EC finality, updating documentation and table of contents accordingly.
- Adds new FAQ sections and ToC entries about F3 non-finalization and EC fallback
- Expands the
finalizedtag description and flowchart to illustrate fallback logic - Fixes minor markdown and punctuation inconsistencies
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md | Clarified F3 fallback behavior, updated ToC and flowchart, tweaked copy |
| documentation/en/api-experimental-user-facing-v2-docs/CLAUDE.md | Updated related-code file descriptions |
Comments suppressed due to low confidence (1)
documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md:10
- [nitpick] The phrase 'if last finalized tipset is more than EC-finalized tipsets in the past' is ambiguous; consider rephrasing to clearly state the condition, for example: 'if the F3-finalized tipset is older than the EC-finalized tipset by more than the EC finality threshold.'
2025-06-06: Updated to make clear the impact on the APIs if F3 isn't finalizing or if last finalized tipset is more than EC-finalized tipsets in the past. This was reviewed in [PR #13161](https://github.com/filecoin-project/lotus/pull/13161).
documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md
Outdated
Show resolved
Hide resolved
documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md
Outdated
Show resolved
Hide resolved
documentation/en/api-experimental-user-facing-v2-docs/api-v2-experimental.md
Show resolved
Hide resolved
rjan90
left a comment
There was a problem hiding this comment.
Some typos caught by the copilot review that would be nice to commit, but else it looks good to me!
PR title now matches the required format.
…xperimental.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…xperimental.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This lack of clarification in the documentation was identified when creating docs for RPC providers and exchanges.