docs: diagram the three-phase billing deduct lifecycle - #1404
Open
samuelelijah585 wants to merge 4 commits into
Open
samuelelijah585 wants to merge 4 commits into
samuelelijah585 wants to merge 4 commits into
Conversation
|
@samuelelijah585 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Overview
This PR documents the three-phase billing deduct lifecycle implemented in
src/services/billing.ts(Phase 1 pending insert, Phase 2 Soroban deduct with retries, Phase 3 tx-hash persistence) so that client developers can implement correct retries and operators know which rows reconciliation must repair. It adds a row-state table, a sequence diagram, a per-flag meaning matrix, per-status retry guidance, and an explicit statement of the single-process semaphore limitation, and links the new section from the billing docs index.Related Issue
Changes
📄 Billing lifecycle documentation
[MODIFY]
docs/billing-idempotency.mdpending,applied, andfailedstates, including which phase writes each state and which fields (alreadyProcessed,deductionApplied,reconciliationRequired) are expected in each.alreadyProcessed,deductionApplied, andreconciliationRequired.[MODIFY]
docs/sdk/billing-deduct.md[MODIFY]
docs/billing-index.mdVerification Results
docs/billing-idempotency.mddocs/sdk/billing-deduct.mddocs/billing-idempotency.mddocs/billing-index.mdlinks the sectionCloses #1331