@pulsepairs/sdk 0.9.0 → 0.9.2

package/DOCUMENTATION.md

@@ -1,6 +1,6 @@
 # `@pulsepairs/sdk` — Reference Documentation
 
-**Version:** 0.7.0 · **License:** UNLICENSED · **Runtime:** Node ≥ 18 or a modern browser
+**Version:** 0.9.2 · **License:** UNLICENSED · **Runtime:** Node ≥ 18 or a modern browser
 
 Complete reference for the UpDown TypeScript SDK: every export, its
 units, its failure modes, and the protocol it speaks.
@@ -43,10 +43,14 @@ returns, what unit a number is in, or why a signature is being rejected.
 ## 1. What this SDK is
 
 UpDown is a binary prediction market: *will BTC-USD (or ETH-USD) be UP or DOWN at
-the end of this 5-minute / 15-minute / 1-hour cycle?* Trading is an **off-chain
+the end of this 5-minute or 15-minute cycle?* Trading is an **off-chain
 central limit order book** (the "matcher"); settlement is **on-chain** on
 Arbitrum.
 
+60-minute cycles were retired on 2026-08-18 and no new ones are created. The
+`3600` timeframe is still accepted and still returns the historical rounds — see
+`getMarkets` under [§5 `UpDownHttpClient`](#5-updownhttpclient--rest-client).
+
 The SDK gives you three layers, usable independently:
 
 | Layer | Modules | What it does |

package/README.md

@@ -1,7 +1,7 @@
 # @pulsepairs/sdk
 
 Standalone SDK for the **UpDown** up/down prediction markets —
-BTC-USD / ETH-USD, UP or DOWN, on 5-minute / 15-minute / 1-hour cycles.
+BTC-USD / ETH-USD, UP or DOWN, on 5-minute and 15-minute cycles.
 
 > **On the name:** the product is **UpDown**. "PulsePairs" is a retired name that
 > survives in two places for compatibility reasons only — this npm package's name
@@ -456,6 +456,32 @@ for (const f of bulkFailures(res)) {
 
 `index` is the position in the array you sent — results are positional.
 
+**On success the order is NESTED, and the single routes spread it.** This is
+the one asymmetry that bites, because nothing about the call site hints at it:
+
+```ts
+const single = await api.amendOrder({ cancelOrderId, order });
+single.id;                       // flat — the replacement's id
+
+const bulk = await api.amendOrdersBulk({ amends });
+for (const r of bulk.results) {
+  if (!r.ok) continue;           // narrow first; failures have no `order`
+  r.order.id;                    // NESTED — `r.id` is undefined
+  r.replaced;                    // the id that was retired
+  r.priorityKept;                // false when queue position was forfeited
+  r.remaining;                   // atomic USDT carried to the replacement
+}
+```
+
+`postOrdersBulk` nests the same way: `results[i].order`, never `results[i].id`.
+
+Reading `results[i].id` yields `undefined` rather than throwing, so the mistake
+survives to wherever that id is used — usually a later cancel that silently
+matches nothing. SDK **0.9.0 typed the bulk result flat** and shipped that
+mistake into the types themselves; 0.9.1 corrected them. The wire shape never
+changed, so no server behaviour depends on which version you are on — but on
+0.9.0 the compiler will agree with you while you read the wrong field.
+
 Two behavioural differences worth knowing, because they change how latency
 scales:
 
@@ -475,11 +501,25 @@ would otherwise see each other's half-applied state. Both cap at 20 per request.
 UPND_INTEGRATION=1 PRIVATE_KEY=0x… npm run test:integration
 ```
 
-It rests an order, amends it, bulk-places two, bulk-amends those, and cancels
-everything in a `finally` — including on failure. It defaults to dev and refuses
-to run against prod without `UPND_ALLOW_PROD=1`, because it places real orders
-and only dev's USDT is play money. Needs a live 5m market with >120s left, so
-the keeper has to be cycling.
+It grants the collateral allowance, rests an order, amends it, bulk-places two,
+bulk-amends those, and cancels everything in a `finally` — including on failure.
+It defaults to dev and refuses to run against prod without `UPND_ALLOW_PROD=1`,
+because it places real orders and only dev's USDT is play money. Needs a live 5m
+market with >120s left, so the keeper has to be cycling.
+
+The key needs mock USDT and a little gas ETH. On dev the public faucet gives
+both in one call:
+
+```bash
+curl -X POST https://dev-api-updown.rain.trade/test/devmint \
+  -H 'Content-Type: application/json' \
+  -d '{"address":"0x…","amount":"100000000"}'
+```
+
+The **allowance is granted by the test itself**, not by hand — a freshly
+deployed Settlement has no approvals from anyone, and requiring a manual
+approve made "run the acceptance test" a two-step nobody had written down. Use a
+throwaway key: the faucet is public, so nothing valuable should sit on it.
 
 ---
 

package/dist/http.d.ts

@@ -112,7 +112,10 @@ export declare class UpDownHttpClient {
      * amend's outcome in the body, so a rejection never reaches `parseJson`'s
      * throw. `bulkFailures()` below exists to make that hard to forget.
      *
-     * Results are positional: `results[i]` is the outcome of `amends[i]`.
+     * Results are positional: `results[i]` is the outcome of `amends[i]`, and a
+     * successful entry NESTS the replacement — `results[i].order.id`, not
+     * `results[i].id`. That differs from the single `amendOrder` above, which
+     * spreads the order at the top level; the asymmetry is the server's.
      *
      * Server-side these run SERIALLY, not concurrently — two amends racing on
      * neighbouring price levels would otherwise see each other's half-applied

package/dist/http.js

@@ -215,7 +215,10 @@ export class UpDownHttpClient {
      * amend's outcome in the body, so a rejection never reaches `parseJson`'s
      * throw. `bulkFailures()` below exists to make that hard to forget.
      *
-     * Results are positional: `results[i]` is the outcome of `amends[i]`.
+     * Results are positional: `results[i]` is the outcome of `amends[i]`, and a
+     * successful entry NESTS the replacement — `results[i].order.id`, not
+     * `results[i].id`. That differs from the single `amendOrder` above, which
+     * spreads the order at the top level; the asymmetry is the server's.
      *
      * Server-side these run SERIALLY, not concurrently — two amends racing on
      * neighbouring price levels would otherwise see each other's half-applied

package/dist/index.d.ts

@@ -7,4 +7,4 @@ export { readOnChainHolderShares, reconcileFills, reportedFromPositions, type On
 export { UpDownAccountKitSigner, bareErc1271Signer, stripErc6492Wrapper, isErc6492Signature, type UpDownAccountKitConfig, type Eip1193Provider, type GrantSessionResult, type RawTypedDataSigner, } from "./accountKit.js";
 export { buildApproveSettlementTx, buildInstallOrderSessionTx, signWithOrderSession, type RawTransaction, type OrderSessionRecord, } from "./accountKit.js";
 export { PRICE_BPS_SCALE, WIN_MARK_BPS, LOSE_MARK_BPS, DEFAULT_USDT_DECIMALS, atomicToUsdt, markValueAtomic, midBps, markForOption, isResolvedWinner, positionPnl, feesPaidByWallet, portfolioPnl, computePortfolioPnl, type MarkSource, type PositionPnl, type PortfolioPnl, type PositionPnlOptions, } from "./pnl.js";
-export { OrderType, OrderSide, Option, takerPriceBps, type AmendOrderBody, type AmendOrderResult, type ApiConfig, type Balance, type BulkAmendBody, type BulkAmendResults, type BulkFailure, type BulkOrdersBody, type BulkOrdersResults, type CancelOrderBody, type Eip712Domain, type MarketDetail, type MarketListItem, type OptionValue, type OrderBookFull, type OrderBookLevel, type OrderBookSide, type OrderRow, type OrderSideKey, type OrderSideValue, type OrderStatus, type OrderTypeKey, type OrderTypeValue, type OrdersResponse, type PairConfig, type PairSymbol, type PostOrderBody, type Position, type SubmittedOrder, type Stats, type Trade, type Version, } from "./types.js";
+export { OrderType, OrderSide, Option, takerPriceBps, type AmendOrderBody, type AmendOrderResult, type ApiConfig, type Balance, type BulkAmendBody, type BulkAmendResults, type BulkAmendSuccess, type BulkFailure, type BulkOrdersBody, type BulkOrdersResults, type CancelOrderBody, type Eip712Domain, type MarketDetail, type MarketListItem, type OptionValue, type OrderBookFull, type OrderBookLevel, type OrderBookSide, type OrderRow, type OrderSideKey, type OrderSideValue, type OrderStatus, type OrderTypeKey, type OrderTypeValue, type OrdersResponse, type PairConfig, type PairSymbol, type PostOrderBody, type Position, type SubmittedOrder, type Stats, type Trade, type Version, } from "./types.js";

package/dist/types.d.ts

@@ -315,10 +315,35 @@ export type AmendOrderResult = SubmittedOrder & {
 export type BulkAmendBody = {
     amends: AmendOrderBody[];
 };
+/**
+ * One successful entry of a bulk amend.
+ *
+ * NOTE THE SHAPE DIFFERS FROM THE SINGLE ROUTE, and this is the server's
+ * asymmetry rather than a choice made here. `POST /orders/amend` SPREADS the
+ * replacement order at the top level, so its id is `res.id`.
+ * `POST /orders/amend/bulk` NESTS it, so the id is `results[i].order.id` —
+ * matching `POST /orders/bulk`, which also nests.
+ *
+ * Typed wrongly in 0.9.0 (as the single route's flat shape), which made
+ * `results[i].id` read `undefined` for every entry. Caught by the live
+ * round-trip against dev, not by the stubbed tests — those used a fixture
+ * written from the same wrong assumption, so they agreed with themselves.
+ */
+export type BulkAmendSuccess = {
+    ok: true;
+    /** The replacement, nested — NOT spread, unlike `POST /orders/amend`. */
+    order: SubmittedOrder;
+    /** Echo of the `cancelOrderId` that was retired. */
+    replaced: string;
+    /** Whether the replacement kept the original's queue position. */
+    priorityKept: boolean;
+    /** Atomic USDT already filled on the ORIGINAL before it was retired. */
+    filled: string;
+    /** Atomic USDT that was still resting and has moved to the replacement. */
+    remaining: string;
+};
 export type BulkAmendResults = {
-    results: Array<({
-        ok: true;
-    } & AmendOrderResult) | BulkFailure>;
+    results: Array<BulkAmendSuccess | BulkFailure>;
 };
 /** `POST /orders/bulk` — orders fan out CONCURRENTLY server-side. */
 export type BulkOrdersBody = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pulsepairs/sdk",
-  "version": "0.9.0",
-  "description": "Standalone SDK for the UpDown (PulsePairs) up/down prediction markets \u2014 matcher REST/WS client, EIP-712 order signing, trade-math, and Alchemy Account Kit (smart-account) order signing for rain.trade integration.",
+  "version": "0.9.2",
+  "description": "Standalone SDK for the UpDown (PulsePairs) up/down prediction markets — matcher REST/WS client, EIP-712 order signing, trade-math, and Alchemy Account Kit (smart-account) order signing for rain.trade integration.",
   "license": "UNLICENSED",
   "type": "module",
   "main": "dist/index.js",