docs: clarify which ProjectStatus variants are currently produced (Closes #329) - #358
Open
laurentketterle-hub wants to merge 1 commit into
Open
Conversation
…oses Heliobond#329) Active, Funded, and Completed are unreachable today (only Pending and Archived are written). Document them as reserved for future vault-managed transitions so downstream consumers do not branch on dead states. Signed-off-by: laurentketterle-hub <laurentketterle-hub@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents which ProjectStatus variants this contract can actually produce.
Problem
ProjectStatus defines Pending, Active, Funded, Completed, and Archived, but only Pending (creation) and Archived (archive_project) are ever written. Active, Funded, and Completed are unreachable dead states that downstream indexers or logic may incorrectly branch on.
Change
Adds a doc comment on the ProjectStatus enum stating explicitly that Pending and Archived are the only variants produced today, and that Active/Funded/Completed are reserved for a future vault-managed lifecycle transition (the cross-contract funding-status call tracked as a separate dependency).
Closes #329