docs: correct replayFromLedger idempotency claims in JSDoc and swagge…#969
Open
CHKM001 wants to merge 1 commit into
Open
docs: correct replayFromLedger idempotency claims in JSDoc and swagge…#969CHKM001 wants to merge 1 commit into
CHKM001 wants to merge 1 commit into
Conversation
…r summary Updates the replayFromLedger JSDoc to clarify that the @@unique([transactionHash, eventType]) constraint guarantees StreamEvent row dedup, but Stream.withdrawnAmount increments in handleTokensWithdrawn are NOT idempotent on replay. Updates the /v1/admin/indexer/replay swagger summary to match. Refs LabsCrypt#808
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.
PR #808 [Docs] Correct
replayFromLedgeridempotency claims in JSDoc & swagger summaryCloses #808
Summary
The
replayFromLedgerJSDoc falsely claimed that worker deduplication guarantees idempotent replay. This is only true forStreamEventrows (via the@@unique([transactionHash, eventType])constraint), but not for stream state mutations likeStream.withdrawnAmountinhandleTokensWithdrawn.Changes
backend/src/services/indexerService.tsreplayFromLedgerJSDoc to:@@unique([transactionHash, eventType])constraint guarantees no duplicateStreamEventrows on replayCAVEATnoting that stream state mutations (e.g.,Stream.withdrawnAmountinhandleTokensWithdrawnatsoroban-event-worker.ts:635) are not idempotent — they execute unconditionally on every replaywithdrawnAmountidempotency fixbackend/src/routes/v1/admin.routes.ts/v1/admin/indexer/replayswagger summary from(idempotent)to(StreamEvent rows deduplicated; stream mutations not idempotent — see indexerService.ts JSDoc)Non-idempotent mutations
handleTokensWithdrawnStream.withdrawnAmountincrementhandleStreamToppedUpdepositedAmount/endTimeupdatehandleStreamCancelledisActive/withdrawnAmountupdatehandleStreamCompletedisActiveupdatehandleStreamPausedisPausedupdatehandleStreamResumedtotalPausedDurationupdatehandleStreamCreatedstream.upserthandleFeeCollectedstreamEvent.upsertonlyhandleFeeConfigUpdatedstreamEvent.upsertonlyhandleAdminTransferredstreamEvent.upsertonlyFiles touched
backend/src/services/indexerService.tsbackend/src/routes/v1/admin.routes.tsOut of scope
handleTokensWithdrawnlogic itself (tracked in [Docs] replayFromLedger JSDoc falsely claims worker dedup guarantees idempotent replay #808)Closes #808