@waterx/sdk 2.1.0 → 2.4.0

package/dist/src/utils/pyth.js

@@ -19,8 +19,10 @@ import { bcs } from "@mysten/sui/bcs";
 // the market's `request_checklist` contains `PythSponsorRule`.
 // ============================================================================
 import { reimburse as sponsorReimburse, request as sponsorRequest, } from "../generated/pyth_sponsor_rule/pyth_sponsor_rule.js";
+import { feed as constantRuleFeed } from "../generated/waterx_constant_rule/constant_rule.js";
 import { aggregate as aggregateCall, newCollector } from "../generated/waterx_oracle/oracle.js";
 import { feed as pythRuleFeed } from "../generated/waterx_pyth_rule/pyth_rule.js";
+import { feed as supraRuleFeed } from "../generated/waterx_supra_rule/supra_rule.js";
 export class PythCache {
     pythStateInfo;
     wormholePackageId;
@@ -226,54 +228,128 @@ export async function updatePythPrices(tx, client, feedIds, cache, sponsorFund)
 // Per-ticker refresh: collector → pyth_rule::feed → oracle::aggregate
 // ============================================================================
 /**
- * For a given ticker, build the collector → feed → aggregate chain that
- * refreshes the on-chain `Oracle` aggregator for that ticker.
+ * Aggregate one ticker's price into the shared `Oracle`: build a collector, feed
+ * every rule the ticker is configured for, then `aggregate`. The fed rule set must
+ * match the on-chain weighted set for the ticker — `aggregator::remove_outliers`
+ * aborts `EMissingPriceSource` if a weighted rule is missing from the collector:
  *
- * Caller must have first called `buildPythPriceUpdateCalls` /
- * `updatePythPrices` so the corresponding `PriceInfoObject` is fresh.
+ * - **Pyth** — fed when `priceInfoObjectId` is supplied (i.e. the ticker has a
+ *   `pyth_rule.feeds` entry). Caller must run the Pyth update first so the
+ *   `PriceInfoObject` is fresh.
+ * - **Supra** — fed alongside Pyth when supra is enabled + wired (abstains on-chain
+ *   for symbols it has no pair for).
+ * - **Constant** — fed when the ticker is a constant ticker
+ *   ({@link WaterXClient.isConstantTicker}).
+ *
+ * "Dual-feed" (Pyth + Constant) and "constant-only" are not special cases — they
+ * fall out of which rules the ticker is in: a constant ticker that also has a Pyth
+ * feed gets both; one with no Pyth feed (no `priceInfoObjectId`) gets constant only.
+ * Throws if no rule applies to the ticker.
  */
-export function aggregateTickerWithPyth(tx, client, args) {
+export function aggregateTicker(tx, client, args) {
+    const oraclePkg = client.config.packages.waterx_oracle.published_at;
     const collector = newCollector({
-        package: client.config.packages.waterx_oracle.published_at,
+        package: oraclePkg,
         arguments: { symbol: args.ticker },
     })(tx);
-    pythRuleFeed({
-        package: client.config.packages.pyth_rule.published_at,
+    let fed = false;
+    if (args.priceInfoObjectId) {
+        pythRuleFeed({
+            package: client.config.packages.pyth_rule.published_at,
+            arguments: {
+                collector,
+                config: tx.object(client.config.packages.pyth_rule.config),
+                pythState: tx.object(client.pyth.state_id),
+                pythPriceInfo: tx.object(args.priceInfoObjectId),
+            },
+        })(tx);
+        // Supra rides on the same collector when enabled (abstains on-chain otherwise).
+        maybeFeedSupra(tx, client, collector);
+        fed = true;
+    }
+    if (client.isConstantTicker(args.ticker)) {
+        const constant = client.config.packages.constant_rule;
+        constantRuleFeed({
+            package: constant.published_at,
+            arguments: { collector, config: tx.object(constant.config) },
+        })(tx);
+        fed = true;
+    }
+    if (!fed) {
+        throw new Error(`no oracle rule configured for ticker '${args.ticker}' (no pyth feed, not a constant ticker)`);
+    }
+    aggregateCall({
+        package: oraclePkg,
         arguments: {
-            collector: collector,
-            config: tx.object(client.config.packages.pyth_rule.config),
-            pythState: tx.object(client.pyth.state_id),
-            pythPriceInfo: tx.object(args.priceInfoObjectId),
+            oracle: tx.object(client.config.packages.waterx_oracle.oracle),
+            collector,
         },
     })(tx);
-    aggregateCall({
-        package: client.config.packages.waterx_oracle.published_at,
+}
+/**
+ * Thin wrapper over {@link aggregateTicker} for a Pyth-fed ticker. Kept for
+ * back-compat (e.g. WLP mint builds). Caller must run the Pyth update first.
+ */
+export function aggregateTickerWithPyth(tx, client, args) {
+    aggregateTicker(tx, client, args);
+}
+/**
+ * Append a `supra_rule::feed` on `collector` when the deployment has supra
+ * enabled + wired (see {@link WaterXClient.getSupraRule}). No-op otherwise, so
+ * Pyth-only deployments are unchanged.
+ */
+function maybeFeedSupra(tx, client, collector) {
+    const supra = client.getSupraRule();
+    if (!supra)
+        return;
+    supraRuleFeed({
+        package: supra.published_at,
         arguments: {
-            oracle: tx.object(client.config.packages.waterx_oracle.oracle),
-            collector: collector,
+            collector,
+            config: tx.object(supra.config),
+            oracleHolder: tx.object(supra.oracle_holder),
         },
     })(tx);
 }
 /**
- * Refresh multiple tickers via Pyth in one PTB. Updates Pyth on-chain
- * first (one accumulator), then runs the collector → feed → aggregate
- * cycle for each ticker.
+ * {@link aggregateTicker} for a **constant-only** ticker (no Pyth update needed —
+ * the price comes from the on-chain `constant_rule::Config`).
+ *
+ * Throws if the ticker ALSO has a `pyth_rule.feeds` entry (a dual-feed transition
+ * ticker): feeding only the constant leg would leave the still-weighted Pyth rule
+ * absent from the collector and abort `aggregate` with `EMissingPriceSource`. Such
+ * tickers must go through {@link aggregateTicker} with a `priceInfoObjectId` (or
+ * {@link refreshOraclePrices}), which feeds both.
+ */
+export function aggregateTickerWithConstant(tx, client, args) {
+    if (client.config.packages.pyth_rule?.feeds?.[args.ticker] !== undefined) {
+        throw new Error(`'${args.ticker}' is in pyth_rule.feeds (dual-feed) — feed both via aggregateTicker({ priceInfoObjectId }) / refreshOraclePrices, not aggregateTickerWithConstant`);
+    }
+    aggregateTicker(tx, client, { ticker: args.ticker });
+}
+/**
+ * Refresh multiple tickers in one PTB. For each ticker {@link aggregateTicker}
+ * feeds whichever rules it is configured for (Pyth if it has a `pyth_rule.feeds`
+ * entry, Supra when enabled, Constant when it's a constant ticker). Tickers with a
+ * Pyth feed are updated on-chain via one shared Pyth accumulator first; the rest
+ * (constant-only) skip Pyth entirely.
  */
 export async function refreshOraclePrices(tx, client, tickers, opts = {}) {
     if (tickers.length === 0)
         return;
-    // tickers are oracle tickers (e.g. "BTCUSD"); look up each one's pyth feed
-    // entry from config — both feed_id (off-chain) and price_info_object
-    // (on-chain) are consumed by the per-ticker aggregate cycle.
-    const entries = tickers.map((t) => client.getPythFeed(t));
-    const feedIds = entries.map((e) => e.feed_id);
-    await updatePythPrices(tx, client, feedIds, opts.cache, opts.sponsorFund);
-    tickers.forEach((ticker, i) => {
-        aggregateTickerWithPyth(tx, client, {
-            ticker,
-            priceInfoObjectId: entries[i].price_info_object,
-        });
-    });
+    // Every ticker with a pyth_rule.feeds entry needs the on-chain Pyth update
+    // first (one shared accumulator). Constant-only tickers (no pyth feed) skip it.
+    const pythTickers = tickers.filter((t) => client.config.packages.pyth_rule?.feeds?.[t] !== undefined);
+    const priceInfoByTicker = new Map();
+    if (pythTickers.length > 0) {
+        const entries = pythTickers.map((t) => client.getPythFeed(t));
+        await updatePythPrices(tx, client, entries.map((e) => e.feed_id), opts.cache, opts.sponsorFund);
+        pythTickers.forEach((t, i) => priceInfoByTicker.set(t, entries[i].price_info_object));
+    }
+    // Aggregate each ticker, feeding whichever rules it is configured for.
+    for (const ticker of tickers) {
+        aggregateTicker(tx, client, { ticker, priceInfoObjectId: priceInfoByTicker.get(ticker) });
+    }
 }
 /**
  * Opens a `Fund` hot potato from the shared PythSponsor pool. Pass the

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@waterx/sdk",
-  "version": "2.1.0",
-  "description": "WaterX Perpetual Protocol SDK",
+  "version": "2.4.0",
+  "description": "WaterX SDK — perpetuals and prediction markets on Sui",
   "license": "MIT",
   "author": "WaterX",
   "repository": {
@@ -9,8 +9,51 @@
     "url": "https://github.com/WaterXProtocol/waterx-sdk.git"
   },
   "type": "module",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "dist/src/sdk.js",
+  "types": "dist/src/sdk.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/sdk.d.ts",
+      "import": "./dist/src/sdk.js"
+    },
+    "./perp": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./perp/*": {
+      "types": "./dist/src/*.d.ts",
+      "import": "./dist/src/*.js"
+    },
+    "./prediction": {
+      "types": "./dist/src/prediction/index.d.ts",
+      "import": "./dist/src/prediction/index.js"
+    },
+    "./prediction/user": {
+      "types": "./dist/src/prediction/user/index.d.ts",
+      "import": "./dist/src/prediction/user/index.js"
+    },
+    "./prediction/user/*": {
+      "types": "./dist/src/prediction/user/*.d.ts",
+      "import": "./dist/src/prediction/user/*.js"
+    },
+    "./prediction/utils": {
+      "types": "./dist/src/prediction/utils/index.d.ts",
+      "import": "./dist/src/prediction/utils/index.js"
+    },
+    "./prediction/utils/*": {
+      "types": "./dist/src/prediction/utils/*.d.ts",
+      "import": "./dist/src/prediction/utils/*.js"
+    },
+    "./prediction/*": {
+      "types": "./dist/src/prediction/*.d.ts",
+      "import": "./dist/src/prediction/*.js"
+    },
+    "./generated/*": {
+      "types": "./dist/src/generated/*.d.ts",
+      "import": "./dist/src/generated/*.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist",
     "LICENSE",
@@ -21,46 +64,98 @@
     "codegen": "tsx scripts/codegen-summaries.ts && npx sui-ts-codegen generate && tsx scripts/fix-generated-imports.ts",
     "lint": "pnpm lint:eslint && pnpm lint:prettier",
     "lint:eslint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\"",
-    "lint:prettier": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\" \"eslint.config.mjs\" \"sui-codegen.config.mjs\"",
+    "lint:prettier": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\" \"eslint.config.mjs\" \"sui-codegen.config.mjs\" \"packages/predict-stress/**/*.{ts,mjs,json,md}\"",
     "lint:fix": "eslint \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\" --fix",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\" \"eslint.config.mjs\" \"sui-codegen.config.mjs\"",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"scripts/**/*.ts\" \"examples/**/*.ts\" \"vitest.config.ts\" \"eslint.config.mjs\" \"sui-codegen.config.mjs\" \"packages/predict-stress/**/*.{ts,mjs,json,md}\"",
     "env:init": "tsx scripts/init-local-env.ts",
     "typecheck": "tsc --noEmit",
-    "test:integration": "tsx scripts/run-integration.ts --testnet",
-    "test:integration:mainnet": "tsx scripts/run-integration.ts --mainnet",
-    "test:integration:lifecycle": "tsx scripts/run-integration.ts --testnet test/integration/user/trader-position-lifecycle.test.ts",
-    "test:integration:market-config": "tsx scripts/run-integration.ts --testnet test/integration/user/trader-market-onchain-config.test.ts",
-    "test:integration:persistent-state": "tsx scripts/run-integration.ts --testnet test/integration/user/trader-e2e-persistent-state.test.ts",
-    "test:integration:gap": "tsx scripts/run-integration.ts --testnet test/integration/user/trader-wlp-redeem.test.ts test/integration/user/trader-staking.test.ts test/integration/user/trader-keeper-roundtrip.test.ts test/integration/user/trader-custody.test.ts test/integration/user/trader-credit-pipeline.test.ts",
-    "test:integration:onboarding": "tsx scripts/run-integration.ts --testnet test/integration/user/trader-full-onboarding.test.ts",
+    "check": "pnpm lint && pnpm typecheck && pnpm test:unit",
+    "test": "vitest run --project unit --project predict-unit",
+    "test:unit": "vitest run --project unit --project predict-unit",
+    "test:unit:perp": "vitest run --project unit",
+    "test:unit:predict": "vitest run --project predict-unit",
+    "test:post-build": "vitest run --project post-build",
+    "test:e2e": "tsx scripts/run-e2e.ts --testnet --predict",
+    "test:e2e:perp": "tsx scripts/run-e2e.ts --testnet",
+    "test:e2e:predict": "tsx scripts/run-e2e.ts --testnet --predict-only",
+    "test:e2e:testnet": "tsx scripts/run-e2e.ts --testnet --predict",
+    "test:e2e:mainnet": "tsx scripts/run-e2e.ts --mainnet --predict",
+    "test:integration": "pnpm test:integration:perp && pnpm test:integration:predict",
+    "test:integration:perp": "tsx scripts/run-integration.ts --testnet",
+    "test:integration:predict": "vitest run --project predict-integration",
+    "test:integration:predict:keeper": "vitest run --project predict-integration-keeper",
+    "test:integration:predict:admin": "vitest run --project predict-integration-admin",
+    "test:integration:predict:all": "vitest run --project predict-integration --project predict-integration-keeper --project predict-integration-admin",
+    "test:api": "node test/prediction/scripts/run-api-tests.mjs",
+    "test:api:local": "node test/prediction/scripts/run-api-tests.mjs --env local",
+    "test:api:staging": "node test/prediction/scripts/run-api-tests.mjs --env staging",
+    "test:integration:predict:crosscheck": "E2E_API_ENV=staging E2E_API_CROSSCHECK=1 vitest run --project predict-integration-crosscheck",
+    "test:integration:predict:settlement-crosscheck": "E2E_API_ENV=staging E2E_SETTLEMENT_CROSSCHECK=1 vitest run --project predict-integration-settlement-crosscheck",
+    "test:integration:predict:headless": "E2E_API_ENV=staging E2E_HEADLESS_BET=1 vitest run --project predict-integration-headless",
+    "test:integration:predict:journey": "vitest run --project predict-integration test/prediction/integration/user-betting-journey.test.ts",
+    "test:integration:perp:mainnet": "tsx scripts/run-integration.ts --mainnet",
+    "test:integration:perp:lifecycle": "tsx scripts/run-integration.ts --testnet test/perp/integration/user/trader-position-lifecycle.test.ts",
+    "test:integration:perp:market-config": "tsx scripts/run-integration.ts --testnet test/perp/integration/user/trader-market-onchain-config.test.ts",
+    "test:integration:perp:persistent-state": "tsx scripts/run-integration.ts --testnet test/perp/integration/user/trader-e2e-persistent-state.test.ts",
+    "test:integration:perp:gap": "tsx scripts/run-integration.ts --testnet test/perp/integration/user/trader-wlp-redeem.test.ts test/perp/integration/user/trader-staking.test.ts test/perp/integration/user/trader-keeper-roundtrip.test.ts test/perp/integration/user/trader-custody.test.ts test/perp/integration/user/trader-credit-pipeline.test.ts",
+    "test:integration:perp:onboarding": "tsx scripts/run-integration.ts --testnet test/perp/integration/user/trader-full-onboarding.test.ts",
     "smoke:chain": "tsx scripts/run-smoke-chain.ts",
-    "smoke:chain:dry": "tsx scripts/run-smoke-chain.ts --dry-run"
+    "smoke:chain:dry": "tsx scripts/run-smoke-chain.ts --dry-run",
+    "seed:testnet": "tsx test/prediction/scripts/seed-testnet.ts",
+    "predict:list-accounts": "tsx test/prediction/scripts/list-accounts.ts",
+    "predict:bootstrap-stress-accounts": "tsx test/prediction/scripts/bootstrap-stress-accounts.ts",
+    "predict:bootstrap-stress-deposits": "tsx test/prediction/scripts/bootstrap-stress-deposits.ts",
+    "mint:api-jwt": "node test/prediction/scripts/mint-api-jwt.mjs",
+    "mint:api-jwt:staging": "node test/prediction/scripts/fetch-staging-api-jwt.mjs",
+    "diagnose:bets-api": "tsx test/prediction/scripts/diagnose-bets-chain-api.ts",
+    "predict:scan-claimable": "E2E_API_ENV=staging tsx test/prediction/scripts/scan-claimable-crosscheck.ts",
+    "predict:place-all-markets": "E2E_API_ENV=staging tsx test/prediction/scripts/place-all-catalog-markets.ts",
+    "predict:place-dry-run": "E2E_API_ENV=staging E2E_PLACE_ALL_DRY_RUN=1 tsx test/prediction/scripts/place-all-catalog-markets.ts",
+    "predict:place-broker-only": "E2E_API_ENV=staging E2E_PLACE_ALL_BROKER_ONLY=1 E2E_PLACE_ALL_ONE_SIDE=1 E2E_PLACE_ALL_LIMIT=1 tsx test/prediction/scripts/place-all-catalog-markets.ts",
+    "predict:place-and-watch": "E2E_API_ENV=staging E2E_STAGING_BET_USD=1.12 E2E_PLACE_ALL_PLACE_ONLY=1 E2E_PLACE_ALL_ONE_SIDE=1 E2E_PLACE_ALL_LIMIT=1 tsx test/prediction/scripts/place-all-catalog-markets.ts",
+    "predict:place-stress": "E2E_API_ENV=staging tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-dry-run": "E2E_API_ENV=staging E2E_STRESS_DRY_RUN=1 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-smoke": "E2E_API_ENV=staging E2E_STRESS_PHASES=1 E2E_STRESS_PLACE_ONLY=1 E2E_STRESS_COOLDOWN_MS=0 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-smoke-fill": "E2E_API_ENV=staging E2E_STRESS_PHASES=1 E2E_STRESS_COOLDOWN_MS=0 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-ramp": "E2E_API_ENV=staging tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-timing": "E2E_API_ENV=staging E2E_STRESS_PHASES=1,2,4,8 E2E_STRESS_COOLDOWN_MS=30000 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-timing-max": "E2E_API_ENV=staging E2E_STRESS_PHASES=8 E2E_STRESS_COOLDOWN_MS=0 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-hammer": "E2E_API_ENV=staging E2E_STRESS_HAMMER=1 E2E_STRESS_PLACE_ONLY=1 E2E_STRESS_COOLDOWN_MS=0 E2E_STRESS_ROUNDS=10 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict:place-stress-hammer-smoke": "E2E_API_ENV=staging E2E_STRESS_HAMMER=1 E2E_STRESS_PLACE_ONLY=1 E2E_STRESS_COOLDOWN_MS=0 E2E_STRESS_ROUNDS=1 tsx test/prediction/scripts/place-stress-multi-wallet.ts",
+    "predict-stress": "pnpm --dir packages/predict-stress",
+    "predict:refund-probe": "E2E_API_ENV=staging tsx test/prediction/scripts/probe-catalog-refund.ts",
+    "predict:broker-matrix": "E2E_API_ENV=staging tsx test/prediction/scripts/probe-broker-matrix.ts",
+    "test:integration:predict:refund": "E2E_API_ENV=staging E2E_CATALOG_REFUND=1 vitest run --project predict-integration-refund",
+    "test:integration:predict:broker-matrix": "E2E_API_ENV=staging E2E_BROKER_MATRIX=1 vitest run --project predict-integration-broker-matrix"
+  },
+  "dependencies": {
+    "@noble/hashes": "^2.2.0"
   },
   "peerDependencies": {
     "@mysten/bcs": "^1.9.0",
     "@mysten/sui": "^2.9.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.4",
-    "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
-    "@mysten/bcs": "^1.9.2",
-    "@mysten/sui": "^2.9.1",
-    "@mysten/codegen": "^0.8.3",
-    "@types/node": "^24.12.0",
-    "@typescript-eslint/eslint-plugin": "^8.58.0",
-    "@typescript-eslint/parser": "^8.58.0",
-    "eslint": "^9.39.4",
-    "eslint-config-prettier": "^10.1.8",
-    "globals": "^17.4.0",
-    "prettier": "^3.8.1",
-    "tsc-alias": "^1.8.16",
-    "tsconfig-paths": "^4.2.0",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.58.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "dotenv": "^17.4.0",
-    "vitest": "^3.2.4"
+    "@eslint/js": "10.0.1",
+    "@ianvs/prettier-plugin-sort-imports": "4.7.1",
+    "@mysten/bcs": "1.9.2",
+    "@mysten/codegen": "0.10.6",
+    "@mysten/sui": "2.17.0",
+    "@types/node": "25.9.1",
+    "@typescript-eslint/eslint-plugin": "8.60.0",
+    "@typescript-eslint/parser": "8.60.0",
+    "@vitest/coverage-v8": "4.1.8",
+    "dotenv": "17.4.2",
+    "eslint": "10.4.1",
+    "eslint-config-prettier": "10.1.8",
+    "globals": "17.6.0",
+    "prettier": "3.8.3",
+    "tsc-alias": "1.8.17",
+    "tsconfig-paths": "4.2.0",
+    "tsx": "4.22.4",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.60.0",
+    "vitest": "4.1.8"
   },
   "packageManager": "pnpm@9.15.0"
 }