Skip to content

docs: correct the deposit/withdraw error statuses in signing-flow.md - #667

Open
funmilayo-ui wants to merge 1 commit into
drydocs:mainfrom
funmilayo-ui:docs/661-signing-flow-500
Open

docs: correct the deposit/withdraw error statuses in signing-flow.md#667
funmilayo-ui wants to merge 1 commit into
drydocs:mainfrom
funmilayo-ui:docs/661-signing-flow-500

Conversation

@funmilayo-ui

Copy link
Copy Markdown

Summary

docs/signing-flow.md's "Error responses" note claimed /tx/deposit and /tx/withdraw return 503 when the vault contract is not configured. Neither handler has a 503 path.

closes #661

Changes

  • docs/signing-flow.md: unconfigured vault on these two endpoints is a 500, not a 503, and the response carries the sanitized message Vault not configured: <vaultId>. Add it to KNOWN_POOLS with a contractId.
  • Added a one-line pointer to why (handleDepositRequest/handleWithdrawRequest wrap the whole build call in a single try/catch that always answers 500), so the claim is checkable against the code.

Verification

  • packages/api-core/src/tx.ts: both handlers return 400 on Zod failure and 500 in catch; no other status.
  • packages/stellar-sdk-helpers/src/orchestration.ts resolveVaultEntry throws a plain Error for a missing contractId, so it lands in that same catch.
  • packages/shared/src/utils.ts sanitizeTxError: the thrown message has no newline, no URL and no C-address, so INTERNAL_DETAIL does not match and it passes through verbatim rather than falling back.
  • 503 in packages/api-core/src/positions.ts belongs to the positions endpoint and is untouched.
  • prettier --check docs/signing-flow.md → clean. Docs-only change.

/tx/deposit and /tx/withdraw have no 503 path: both handlers wrap the
build call in one try/catch that returns 500, unconfigured vault
included. 503 is only used by the positions endpoint.
@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@funmilayo-ui 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! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@funmilayo-ui is attempting to deploy a commit to the Collins' projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] signing-flow.md claims a 503 status deposit/withdraw never actually return

1 participant