@stable_sea/sdk 0.1.4 → 0.1.6

package/README.md

@@ -8,13 +8,12 @@ https://docs.stablesea.com/api/.
 ## Install
 
 ```sh
-npm install @stable_sea/sdk@0.1
+npm install @stable_sea/sdk
 ```
 
-The package follows semantic versioning. Pin a minor version for pre-1.0 releases;
-minor releases may contain breaking SDK API changes. The dated API contract is
-independent of the npm package version and must be selected explicitly when you
-create a client:
+These examples use the latest published SDK. The dated API contract is
+independent of the npm package version. Set `version` to pin the dated contract;
+omitting it uses the server default:
 
 ```ts
 import { createStableSeaClient } from "@stable_sea/sdk";
@@ -31,10 +30,10 @@ Ask your Stable Sea contact to enable API access, then create a named `sk_live_
 credential in Stable Sea Terminal. The credential identifies one business and
 carries fixed scopes, so do not send a `Stable-Sea-Account` header.
 
-| SDK | API contract | Credentials |
+| Environment | Base URL | Key |
 |---|---|---|
-| `0.1.x` | `2026-07-23` | `sk_live_…` on production |
-| `0.1.x` | `2026-07-23` | `sk_test_…` on sandbox |
+| Production | `https://api.stablesea.com` | `sk_live_…` |
+| Sandbox | `https://sandbox-api.stablesea.com` | `sk_test_…` |
 
 API access enables both Live and Sandbox. In Terminal, open **API keys** and
 create a key under **Test keys**. Set `baseUrl` to
@@ -51,10 +50,8 @@ two-factor code; Test keys do not. The first
 Test key prepares isolated balances of 100,000 USDC and 50,000 WTGXX; additional
 keys and rotations reuse that data.
 
-Available funds and settlement modes follow the production contract: WTGXX
-supports standard and instant settlement; FLTTX uses standard settlement. An
-unsupported instant order must produce the normal refusal rather than simulated
-liquidity that would not exist in production.
+WTGXX supports standard and instant settlement. FLTTX supports standard
+settlement; instant orders are refused in both production and sandbox.
 
 ## Idempotent writes
 
@@ -80,7 +77,7 @@ requires a different window.
 ```ts
 import { verifyWebhookSignature } from "@stable_sea/sdk";
 
-const valid = await verifyWebhookSignature(
+const valid = verifyWebhookSignature(
   rawBody,
   request.headers.get("Stable-Sea-Signature") ?? "",
   process.env.STABLE_SEA_WEBHOOK_SECRET!,
@@ -91,6 +88,76 @@ API request, response, pagination, and error types are generated from
 `services/backend/api/openapi.public.json` and exported as `paths`, `operations`,
 and `components`.
 
+## Money controls and rate limits
+
+Read `GET /v1/policies` with a key that has `money:read`.
+These are current observations, not a guarantee that a later order is permitted.
+
+```ts
+const policies = await client.GET("/v1/policies");
+if (policies.error) throw new Error(policies.error.error.message);
+console.log(policies.data.data);
+```
+
+Responses after credential rate limiting include `X-RateLimit-Limit`,
+`X-RateLimit-Remaining`, and `X-RateLimit-Reset` (Unix seconds). They describe
+the key’s budget on the server instance handling the request, not a fleet-wide
+quota. Authentication and IP/edge refusals omit them; outer timeout, cancellation,
+and response-size failures may also omit them. On HTTP 429, wait at least
+`Retry-After` seconds. For mutation retries, reuse the same idempotency key.
+
+## Manage bank accounts
+
+Select **Manage bank accounts** and **Read financial data** when creating the key
+in Terminal. Submit registration with `POST /v1/bank_accounts`, poll the returned
+`baop_` ID at `GET /v1/bank_account_operations/{id}`, then read the resulting
+`bacc_` account. Registration preserves Terminal's screening rules and does not
+enable funding or payouts. Remove an account with
+`POST /v1/bank_accounts/{id}/remove`; pending transactions prevent removal.
+
+See [the bank account guide](../../docs/api/bank-accounts.md) for examples and retry behavior.
+
+## Read saved bank accounts
+
+Use a key with `money:read`:
+
+```ts
+const banks = await client.GET("/v1/bank_accounts");
+if (banks.error) throw new Error(banks.error.error.message);
+console.log(banks.data.data);
+```
+
+Account numbers and holder identity are masked by default. For complete values,
+select **Read full bank details** alongside **Read financial data** when creating
+or rotating the key in Terminal. Existing keys keep their permissions.
+
+Use the returned `bacc_` ID with `GET /v1/bank_accounts/{id}`. Removed and
+cross-business accounts return not found. Newly added or changed details can
+briefly return 503; retry the read. Test keys read only their isolated sandbox
+bank accounts.
+
+## Funding and deposits
+
+Select **Read financial data** and **Create deposits** in Terminal. Read
+`GET /v1/funding` for current ACH limits, wire instructions and on-chain
+addresses. For ACH, create a quote with `POST /v1/deposit_quotes`, poll its
+`qt_` ID until ready, then review and acknowledge its bank authorization before
+submitting `POST /v1/deposits`. Poll the `depo_` resource and its transaction for
+the actual outcome. A quote expires five minutes after creation and can fund
+one deposit. Keep the same mutation object and body for retries.
+
+Authorization text is redacted on ordinary reads. To retrieve and review it,
+select **Read full bank details** (`money:bank_accounts_sensitive_read`)
+for the reading key, or obtain authorization through Terminal.
+
+Declare an on-chain source address with `POST /v1/source_wallet_declarations`.
+Poll its `swdec_` ID, check `cleared`, then read funding again. A declaration
+does not send funds; replay does not renew clearance. Wire quotes estimate fees,
+and wire transfers use the instructions returned by funding.
+
+See [the funding guide](../../docs/api/funding.md) for the complete sequence,
+permissions and retry behavior.
+
 ## Contract changes
 
 - `GET /v1/balances`: `chain` gains the value `solana`. A USDC balance held on