Skip to content

docs: remove order-based swap flow (keep atomic + LSPS1)#24

Open
bitwalt wants to merge 2 commits into
docs/accuracy-sweepfrom
docs/remove-swap-orders
Open

docs: remove order-based swap flow (keep atomic + LSPS1)#24
bitwalt wants to merge 2 commits into
docs/accuracy-sweepfrom
docs/remove-swap-orders

Conversation

@bitwalt

@bitwalt bitwalt commented Jul 9, 2026

Copy link
Copy Markdown
Member

The maker API's order-based swap endpoints (/api/v1/swaps/orders/*) have been retired — they now 404 on the live service. This removes the corresponding documentation and aligns the SDK/CLI docs with kaleido-sdk 0.1.12 (kaleido-sdk#33) and kaleido-cli 0.1.1 (kaleido-cli#20).

Changed

  • API Reference — dropped the order-flow sections and the SwapOrderStatus state machine from swap-protocol / swap-apis; fixed the atomic status path to POST /api/v1/swaps/atomic/status (was mislabeled GET /swaps/status); pruned openapi.json (swaps/orders paths + SwapOrder*/OrderHistory*/OrderStats*/RateDecision* schemas).
  • SDK — removed createSwapOrder/waitForSwapCompletion/etc. and the SwapOrder* types from api-reference, types, examples, how-to-swap, error-handling, websocket; added the v0.1.12 changelog entry.
  • CLI — removed the swap order tables/examples from market-and-swaps and command-reference.
  • Overview — removed the SwapOrderStatus glossary entry; fixed the API routing table and the "swap stuck" troubleshooting bullet.

Kept (unrelated)

  • Atomic swap docs, and all LSPS1 channel order docs (create_order/get_order, channel order …, rgb-lsps1-apis).

Verification

  • No residual swaps/orders / SwapOrderStatus / swap order references (except the extension's own internal swap-status label, which is unrelated).
  • No broken internal links; openapi.json is valid JSON.

Stacked on #23 (base docs/accuracy-sweep) to stay conflict-free, since #23 also edits these files. Retarget to main once #23 merges.

🤖 Generated with Claude Code

bitwalt and others added 2 commits July 9, 2026 08:39
The maker API's order-based swap endpoints (/api/v1/swaps/orders/*) were
retired (they now 404). Remove the corresponding docs and align the SDK/CLI
docs with kaleido-sdk 0.1.12 and kaleido-cli 0.1.1.

- API Reference: drop the order-flow sections and the SwapOrderStatus state
  machine from swap-protocol/swap-apis; fix the atomic status path to
  POST /api/v1/swaps/atomic/status; prune openapi.json swaps/orders paths +
  SwapOrder*/OrderHistory*/OrderStats*/RateDecision* schemas.
- SDK: remove createSwapOrder/waitForSwapCompletion/etc. and the SwapOrder*
  types from api-reference, types, examples, how-to-swap, error-handling,
  websocket; add the 0.1.12 changelog entry.
- CLI: remove the `swap order` command tables/examples from
  market-and-swaps and command-reference.
- Overview: drop the SwapOrderStatus glossary entry; fix the routing table
  and the "swap order stuck" troubleshooting bullet.

Kept: atomic swaps and LSPS1 channel orders (create_order/get_order,
`channel order …`) — unrelated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

1 participant