Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
funmilayo-ui wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/signing-flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,13 @@ Response `200`: same shape as deposit — `{ "xdr": "...", "fee": "..." }`.
### Error responses

Both endpoints return `400` with `{ "error": "<message>" }` for validation failures
(bad public key, malformed amount, missing fields), `503` if the vault contract is not
configured, and `500` with the simulation/build error message otherwise.
(bad public key, malformed amount, missing fields), and `500` with the
simulation/build error message for anything else that throws — including a vault whose
contract address is not configured, which surfaces as
`Vault not configured: <vaultId>. Add it to KNOWN_POOLS with a contractId.`
There is no `503` on these two endpoints: `handleDepositRequest`/`handleWithdrawRequest`
in [`packages/api-core/src/tx.ts`](../packages/api-core/src/tx.ts) wrap the whole build
call in one `try/catch` that always answers `500`.

## What the frontend must do between receiving the XDR and submitting

Expand Down