@stable_sea/sdk 0.2.41 → 0.2.42

package/README.md

@@ -188,6 +188,12 @@ Test-key Sandbox does not serve member sessions. Test approval review and
 business-rule management use this same business client and session. Your existing
 member permissions apply.
 
+The member client also reads `GET /money/maintenance` using the signed-in
+business session. Its customer response contains `paused`, the custody `revision`
+and optional `updated_ts`, excluding operator reasons or actors. Pause new money
+actions and withhold cached deposit instructions while paused or when this
+authority cannot be read; scope instruction caches by business and revision.
+
 ```ts
 import { createStableSeaSessionClient } from "@stable_sea/sdk";
 
@@ -744,3 +750,40 @@ a queued fee refund is separate from both principal recovery and a settled refun
 The [Sandbox test project](consumer-test/README.md#test-a-withdrawal) includes
 `npm run test:withdrawal` for a saved Test destination. It preserves request keys
 and receipts so an interrupted run can resume without creating a new withdrawal.
+
+## Swap stablecoins
+
+Swaps between USDC and USDT on Ethereum run in your Go Account once Stable Sea
+enables them for your business. Create a key with **Swap stablecoins**
+(`money:swaps_write`) and **Read financial data** (`money:read`). The permission
+appears only while swaps are enabled.
+
+Read `GET /v1/swap_routes` for whether swaps are enabled, each route's limits,
+your swap fee rate and the available balance of each asset. Estimates, quotes and
+swaps are processed in the background: poll each until `status` leaves `pending`.
+
+```ts
+const quoting = client.mutation();
+const { data: quote } = await quoting.POST("/v1/swap_quotes", {
+  body: { route: "ethereum_usdc_usdt", from_asset: "USDC", to_asset: "USDT", amount: "1000" },
+});
+// Retrieve GET /v1/swap_quotes/{id} until status is ready, then review terms.
+const swapping = client.mutation();
+const { data: swap } = await swapping.POST("/v1/swaps", { body: { quote_id: quote!.id } });
+```
+
+`POST /v1/swap_estimates` prices a swap without a binding quote; its `result`
+names the first check a quote would fail in `refusal_reason`. A firm quote lives
+for at most a minute, so submit it promptly; a swap that starts after
+`expires_ts` fails with `quote_expired`. Each quote executes once. A refused
+estimate, quote or swap reports why in `failure_code`.
+
+Follow `GET /v1/swaps/{id}` to `completed` or `failed`. Once booked,
+`transaction_id` names the transaction whose legs carry the amounts actually sent,
+received and charged. After a lost response, resend the same body with the same
+`Idempotency-Key`, or find the swap with `GET /v1/swap_submissions?idempotency_key=…`.
+Never submit the quote again under a new key.
+
+Signed-in members use the member client's `/money/swap_routes`,
+`/money/swap_estimate`, `/money/swap_quotes`, `/money/swaps` and
+`/money/swap_submissions`, with their own buy or sell permission.