@mysten/deepbook-v3 2.6.4 → 2.8.0

package/CHANGELOG.md

@@ -1,5 +1,158 @@
 # @mysten/deepbook-v3
 
+## 2.8.0
+
+### Minor Changes
+
+- 84b81a4: Record the Mainnet Predict v4 rollout (delayed execution) in the Mainnet config. Mainnet
+  Predict trading moves to queued orders, as Testnet did in 2.7.0.
+
+  - Predict: `0x08fa3ef1…ee53` (v3) →
+    `0x98235c5842831c9b5f51dc637cf34c91db2aca5510802eb6ebfec63f5b71a7bb` (v4), which is also
+    `packages.predictDelayedExecution`
+  - `deepbook_predict_orders`: `0x7cd41de311f8f3efb2c239b38773a4010fce3bef0120cd55f479843077c98903`
+    (v1), with its `OrderDesk` `0x87b0a87262aacf58eaff567eed2fb7cb0f9cbc1f5ce33ef79216cd26d13a1b5b`
+    and `QueueRegistry` `0x8d4f0c671862f065ac7f2c2cb24abc47cf75ed8fc8e5e52c1d4bdfa53eee164f`
+  - `deepbook_predict_math`: `0x19262d18a3ce9f1c304defbacc89f36585152acde73e626231200d10617fb9a7`
+    (v1)
+  - Pyth Lazer `State`: `0xd0db9c1e9212a98120384bf78d8b8c985d87b9ee6921dffcf9d1394062911573`
+  - Sessions: `0xec678aee…0a1a` (v2) →
+    `0xfd9ef53ca443517d6a3a4d8742e00eaa1e7f35b0997697caab8c3e62870c0ce5` (v3)
+
+  `predictV1` and `sessionsPackageIdV1` keep the original IDs.
+
+  **Move every Mainnet session client to this release before the cutover, spot included.** The
+  Mainnet cutover transaction raises the Sessions version watermark to 3. From then on, every call
+  into Sessions v1 or v2 aborts with `session_config::EPackageVersionDisabled`. That includes spot
+  session-key trading (`sessionsMoveCalls.placeLimitOrder`, `placeMarketOrder`, `cancelLiveOrder`,
+  `cancelLiveOrders` and `withdrawSettledAmounts`), `authorizeSession` and the Predict wrappers.
+  Older releases call v2. This release calls v3 for every Sessions builder: the `SessionsContract`
+  wrappers, and the `sessionsMoveCalls` builders given `getSessionsConfig('mainnet')`. v3 is a
+  compatible upgrade, so the spot builders' arguments are unchanged. Only `revokeSession` and
+  `sessionExpirationMs` aren't version-gated, so they keep working on every version. Queued Predict
+  orders through a session key need v3 too, because the `enqueue*` wrappers exist only there.
+
+  **Migrate off the immediate trades.** The Mainnet call target is now Predict v4, which always
+  aborts them with `EDelayedExecutionRequired`. On Mainnet, `tx.mint`, `tx.mintAmount`,
+  `tx.mintCost`, `tx.redeem` and `read.quoteRedeem` stop working, and so do the `SessionsContract`
+  wrappers `mintExactQuantity`, `mintExactAmount`, `mintExactCost` and `redeemLive`. Place orders
+  with `tx.enqueueMint`, `tx.enqueueMintAmount`, `tx.enqueueMintCost` and `tx.enqueueSell`, or with
+  `read.planMint` / `read.planSell` and `tx.enqueuePlan`. Follow each order with `read.order` or
+  `read.waitForOutcome`. Session keys use the `SessionsContract` `enqueue*` wrappers.
+  `tx.claimSettled` is unchanged. Staying on an older release doesn't keep the immediate trades: the
+  cutover raises Predict's version watermark to 4, which retires the v3 package those releases call.
+
+  `getConfig('mainnet')` now turns on the queued-order surface. Until the cutover, neither path
+  trades on Mainnet. Trading is paused, `read.executionMode()` reads `'awaiting-cutover'` until
+  Mainnet's version watermark reaches 4, and Predict's admission refuses enqueues until then.
+
+## 2.7.0
+
+### Minor Changes
+
+- 352a0cc: Add the Predict delayed-execution order flow (DBU-885). Queued mints and early sells fill
+  at Pyth's signed price for a tick shortly after placement. Delayed execution spans three packages:
+  the Predict upgrade, the order-flow package `deepbook_predict_orders` (each market's
+  `MarketQueue`, the shared `OrderDesk`, every queued-order entry point and the queue events) and
+  the math library `deepbook_predict_math`.
+
+  - `PredictClient.tx` gains `enqueueMint`, `enqueueMintAmount`, `enqueueMintCost`, `enqueueSell`,
+    `refund`, `fill`, and the permissionless `claimParked` and `payOpen` for USDC a denied receive
+    address couldn't take. Each enqueue builder reads the market first and refuses an order the
+    queue or protocol gates would abort with a typed `PredictPreflightError`, and returns the
+    transaction with a preview of τ, the deadline, the escrow and the order fee. A sell whose cash
+    need is above spare cash gets `rebalance_expiry_cash` after the enqueue by default.
+  - `PredictClient.read` gains `queue`, `order`, `orders`, `waitForOutcome`, `quoteSell`,
+    `executionMode`, `pendingFunds` and `lazerPackages`, and `PredictClient` gains `queueIdFor`.
+    `executionMode` is `'retired'`, and the enqueue builders refuse with the `retired` code, once
+    Predict's version watermark is above the version this SDK calls
+    (`queue.PREDICT_PACKAGE_VERSION`) or the desk's is above the order-flow package's.
+  - `PredictClient.read.settlement(market)` reads a market's settlement price, which still works
+    after expiry, when `read.market` and the quotes abort `ELivePricingExpired`.
+    `cost.settledPayout(orderId, settlementPriceRaw, tickSizeRaw)` gives what an order pays at that
+    price, mirroring `strike_exposure::settled_order_payout`. Together they show a queued fill's
+    result once the keeper has paid and cleaned up its record.
+  - `PredictClient.read.feePolicy(market)` reads the fee policy a market snapshotted at creation,
+    which the `cost` functions take as `fees`. `cost.SHIPPED_FEE_POLICY` matches neither recorded
+    deployment's template any more, so its costs for a live market come out low.
+  - `PredictClient.read` gains `planMint` and `planSell` for order forms. A plan quotes the order at
+    the current price, also for a visitor without an account, and turns `slippageCents` (cents per
+    contract, never a percentage, or `'auto'` from `queue.slippageBand`) into the enqueue limits,
+    sized from the price without the fee subsidy, which is what enqueue admission checks. It returns
+    the payout, the payout multiple, the order fee read from the desk, the escrow and debit, the
+    balance, the most the market takes now, the timing, and the refusal the enqueue builder's own
+    preflight would give the plan's order (with the new `cost-above-payout` code). `planMint` throws
+    `entry-band` (a new code) for a strike outside the market's entry band, `min-premium` for a
+    budget or quantity below the minimum premium, and `past-cutoff` for a market past its expiry.
+    `PredictClient.tx.enqueuePlan` queues the order a plan describes. A plan carries its `target`
+    (owner, market, strike or record), and `enqueuePlan` refuses it for another order, after the
+    order fee rose, or when the balance escrows less than its budget. Each facade enqueue starts
+    with `queueTx.assertOrderFeeAtMost`, which aborts the transaction when the desk's fee rose above
+    the previewed one before it executes. `snapStrike` snaps a strike to a market's admission grid,
+    and `queue.budgetMintLimits`, `queue.exactMintLimits` and `queue.sellLimits` are the pure limit
+    helpers. Where the config records delayed execution, `quoteMint` and `quoteMintCost` read the
+    chain's quote functions and preview a queued fill.
+  - `decodeMoveAbort` names Predict's `pricing` aborts (such as `EBlockScholesPriceUnavailable`) the
+    admission, position and LP aborts (such as `strike_payout_tree::EMaxPayoutTreeNodes`), and the
+    `sessions`, `session_config` and `account_registry` aborts (such as `ESessionNotAuthorized`),
+    and `describePredictError` gives the oracle-unavailable and stale ones a retry text and the
+    session ones a readable one. The plan types (`MintPlan`, `SellPlan`, `PlanMintOptions`,
+    `PlanSellOptions`, `SlippageOptions`, `AppliedSlippage`) are exported.
+  - `PredictClient.decode` gains the queue event decoders (matched against the order-flow package's
+    original ID, including `recordFunds` for parked and claimed USDC), `policyUpdates` and
+    `expiryPnlRealized`. Refund reason 9 is a denied receive address. A held position carries its
+    `quantityRaw`, decoded from its order ID, so a partial sell's remainder is readable without
+    `cost.decodeOrderRange`. `realizedPnlRaw` sums the realized P&L changes.
+  - New config: `packages.predictDelayedExecution`, `packages.predictOrders`,
+    `packages.predictOrdersV1`, `packages.predictMath`, `objects.orderDesk` and
+    `objects.queueRegistry`, all optional. Queue IDs derive from the queue registry.
+  - New `queue` namespace (order codes, refund reasons, settlement phases, cash-need math,
+    `maxMintNow`, timing previews, `orderView`, `reduceOrderEvents`, `slippageBand`), `queueTx`
+    thunks (the enqueues, `createQueue`, `commit`, `resolve`, `refund`, `adminRefund`, `settleStep`,
+    `payOpen`, `claimParked`, `cleanup`, `fill`), `toOrdersConfig`, `deriveQueueId`,
+    `orderFlowWitnessType` and `describePredictError`, plus the generated bindings of both new
+    packages.
+  - `SessionsContract` gains `enqueueExactQuantity`, `enqueueExactAmount`, `enqueueExactCost` and
+    `enqueueRedeemOpen`, which take the order desk and the queue registry and need Sessions v3.
+  - The cost previews take the admin-set `feeIncentiveSubsidyRate`.
+  - Deprecated: the immediate `mint`, `mintAmount`, `mintCost` and `redeem` builders, their thunks
+    and Sessions wrappers, `read.quoteRedeem` and `FEE_INCENTIVE_SUBSIDY_RATE`. Predict v4 always
+    aborts the immediate trades.
+
+  The Testnet config records the Testnet rollout: Predict v5, Sessions v3,
+  `deepbook_predict_orders`, `deepbook_predict_math`, the order desk, the queue registry and the
+  Pyth Lazer state. The Mainnet config doesn't record delayed execution yet, so the queued surface
+  needs a custom `config` there until the Mainnet rollout is synced. `sync-deployment` now reads the
+  two new packages' `Published.toml` records.
+
+## 2.6.8
+
+## 2.6.7
+
+### Patch Changes
+
+- 2ba222a: Upgrade axios to require version 1.20.0 or later, fixing reported security
+  vulnerabilities.
+
+## 2.6.6
+
+## 2.6.5
+
+### Patch Changes
+
+- d5d8f63: Point Predict at its latest published packages and pick up `add_usdc_to_plp`:
+
+  - Mainnet Predict: `0x1cacb9bf…a837` (v2) →
+    `0x08fa3ef1b047d87b0b4ce1c7e5f8b42d8bfdea9a70547efe3cce5d8d6e47ee53` (v3)
+  - Testnet Predict: `0x30a03c33…25ce` (v2) →
+    `0x6c2c2d3c2394cf282f4b8462a99c2e814bda0c223796de10b47b36d35fd878f5` (v4)
+
+  `predictV1` keeps the original ids, and Sessions is already on its latest package on both
+  networks.
+
+  The regenerated Predict bindings add `plpMoveCalls.addUsdcToPlp`, which pays USDC into the pool
+  without minting PLP, and the `vaultEvents.UsdcAddedToPlp` event layout.
+
 ## 2.6.4
 
 ## 2.6.3