docs: remove order-based swap flow (keep atomic + LSPS1)#24
Open
bitwalt wants to merge 2 commits into
Open
Conversation
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>
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.
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
SwapOrderStatusstate machine fromswap-protocol/swap-apis; fixed the atomic status path toPOST /api/v1/swaps/atomic/status(was mislabeledGET /swaps/status); prunedopenapi.json(swaps/orderspaths +SwapOrder*/OrderHistory*/OrderStats*/RateDecision*schemas).createSwapOrder/waitForSwapCompletion/etc. and theSwapOrder*types fromapi-reference,types,examples,how-to-swap,error-handling,websocket; added the v0.1.12 changelog entry.swap ordertables/examples frommarket-and-swapsandcommand-reference.SwapOrderStatusglossary entry; fixed the API routing table and the "swap stuck" troubleshooting bullet.Kept (unrelated)
create_order/get_order,channel order …,rgb-lsps1-apis).Verification
swaps/orders/SwapOrderStatus/swap orderreferences (except the extension's own internal swap-status label, which is unrelated).openapi.jsonis valid JSON.🤖 Generated with Claude Code