@waterx/sdk 4.3.2 → 4.3.3

package/dist/cjs/src/oracle/rules/waterx-rule.d.ts

@@ -1,35 +1,59 @@
 /**
  * `WaterxRule` — `PriceUpdateRule` for the first-party WaterX quote-center
- * (Nautilus-TEE, ed25519), plus `feedWaterxRule`, the collector-feed leg
- * `aggregateTicker` appends per waterx-routed ticker. Pulls one enclave-signed
- * batch envelope covering every requested ticker from the quote-center
- * (`GET /v1/quotes/update?symbols=…`, endpoint from `host.waterx` — the
- * `waterxEndpoint`/`waterxFetch` create options — else its own `WATERX_INFRA`), then —
- * unlike Pyth Lazer, whose verify is a single shared PTB step — verifies AND
- * feeds in ONE `waterx_rule::collect_batch_latest` call per collector (the Move
- * API bundles the two). So `buildUpdateCalls` emits nothing and the signed
- * envelope is handed straight to the per-ticker feed leg.
+ * (Nautilus-TEE, ed25519), plus the collector-feed legs `aggregateTicker`
+ * appends per waterx-routed ticker. Endpoint comes from `host.waterx` (the
+ * `waterxEndpoint`/`waterxFetch` create options), else this source's own
+ * `WATERX_INFRA`. Unlike Pyth Lazer, whose verify is a single shared PTB step,
+ * the Move API bundles verify AND feed into ONE call per collector, so
+ * `buildUpdateCalls` emits nothing and the signed data is handed straight to
+ * the per-ticker feed leg.
  *
- * `collect_batch_latest` is the dual-rule path: it feeds the item matching
- * `collector.symbol()` WITHOUT aggregating, so a waterx-routed ticker composes
- * onto the same collector as Pyth/Supra (compose-then-aggregate). On-chain a
- * FRESHNESS miss ABSTAINS (the other weighted rules cover); a config/
- * integrity mismatch, bad signature, future timestamp — or a REPLAYED signed
- * timestamp — ABORTS (`EReplayedSignature`, audit F-014: a signed tuple is
- * single-use per symbol, enforced by a per-symbol high-water mark BEFORE any
- * weight arbitration). Consequence for concurrent builds: two PTBs carrying
- * the same envelope for the same symbol cannot both land — the second aborts
- * even if the rule is unweighted for that ticker. Never share one fetched
- * envelope across builds that may execute concurrently for the same symbol.
+ * TWO wire shapes carry the same prices, and this rule prefers the first:
+ *
+ * 1. **Merkle leaves** (default) — `GET /v1/quotes/leaves?symbols=…` returns one
+ *    `SignedLeaf` per symbol: the price fields, a Merkle `proof`, and the
+ *    enclave's signature over the snapshot ROOT (`MERKLE_ROOT_INTENT`). Fed via
+ *    {@link feedWaterxRuleWithProof} → `waterx_rule::collect_single_with_proof`,
+ *    which re-derives the root from the leaf + proof. One symbol costs ONE
+ *    `new_batch_item` plus ~log2(n) 32-byte proof hashes.
+ * 2. **Batch envelope** (fallback) — `GET /v1/quotes/update?symbols=…` returns
+ *    ONE signature over the whole item vector (`BATCH_PRICE_INTENT`). It is
+ *    indivisible: {@link feedWaterxRule} must rebuild EVERY item in-PTB for
+ *    `waterx_rule::collect_batch_latest` to re-verify, even to use one symbol's
+ *    price. With the 29-feed mainnet registry that is 58 extra moveCalls and
+ *    ~320 extra pure inputs on every trade, which is why it is no longer the
+ *    default. Used only when the quote-center has no leaf route yet (404),
+ *    and by callers that still push whole batches.
+ *
+ * Both collect entries are the dual-rule path: they feed `collector.symbol()`
+ * WITHOUT aggregating, so a waterx-routed ticker composes onto the same
+ * collector as Pyth/Supra (compose-then-aggregate). Their abort-vs-abstain
+ * disposition is identical: a config/integrity mismatch, a bad signature or a
+ * signed timestamp AHEAD of the on-chain `Clock` ABORTS; a freshness miss
+ * ABSTAINS so the other weighted rules cover a lagging TEE, and so does a
+ * REPLAYED signed timestamp (the per-symbol high-water mark of audit F-014 —
+ * already-recorded means the chain holds a price at least this fresh, so two
+ * PTBs carrying the same snapshot for the same symbol no longer kill each
+ * other; only the single-rule `feed_*` entries abort on a replay).
  */
 import type { Transaction, TransactionArgument } from "@mysten/sui/transactions";
 import type { Network } from "../../constants.ts";
 import type { OracleHost } from "../host.ts";
 import { type PriceUpdateRule, type RuleUpdateData } from "../price-update-rule.ts";
-/** The single signing intent the quote-center emits — exported so read-plane
- *  consumers can mirror the rule's own envelope intent check (a mispointed
- *  endpoint must be rejected by reads exactly as tx-builds reject it). */
+/** Intent the quote-center signs a whole BATCH payload under — exported so
+ *  read-plane consumers can mirror the rule's own envelope intent check (a
+ *  mispointed endpoint must be rejected by reads exactly as tx-builds reject it). */
 export declare const BATCH_PRICE_INTENT = 1;
+/**
+ * Intent the quote-center signs a snapshot's Merkle ROOT under
+ * (`waterx_rule::MERKLE_ROOT_INTENT`). Distinct from
+ * {@link BATCH_PRICE_INTENT} on purpose: the intent byte is the first field of
+ * the signed `IntentMessage`, so a batch signature can never be replayed as a
+ * root signature or vice versa. Leaves carry no `intent` field of their own —
+ * they are only ever submitted through `collect_single_with_proof`, which pins
+ * the intent on-chain — so this exists to name the scheme, not to gate a parse.
+ */
+export declare const MERKLE_ROOT_INTENT = 2;
 /**
  * WaterX quote-center external infra — owned by THIS source, by network.
  * Mirrors `PYTH_CORE_INFRA` (oracle/pyth.ts) and `LAZER_INFRA`
@@ -88,39 +112,104 @@ export interface WaterxSignedEnvelope {
     /** ed25519 signature over `BCS(IntentMessage<BatchPricePayload>)`, hex (± `0x`). */
     signature: string;
 }
-/** `waterx_rule`'s narrowed `RuleUpdateData.payload` shape. */
-export interface WaterxUpdatePayload {
+/**
+ * One enclave-signed Merkle leaf from `GET /v1/quotes/leaves` — identical shape
+ * to the `/v1/quote/stream/signed` SSE/WS events (quote-center serves both from
+ * one conversion), so a leaf from either transport submits the same way.
+ *
+ * It is the batch item's fields PLUS its membership proof: on-chain,
+ * `collect_single_with_proof` recomputes `keccak256(0x00 || BCS(item))`, folds
+ * it through `proof` (sorted pairs, no direction flags), and verifies the
+ * enclave's signature over THAT root — so every item field must round-trip
+ * byte-for-byte, exactly as for the batch path.
+ */
+export interface WaterxSignedLeaf extends WaterxBatchItem {
+    /**
+     * Enclave signing timestamp of the SNAPSHOT ROOT (ms) — the on-chain
+     * `timestamp_ms` argument. Shared by every leaf of one snapshot, and distinct
+     * from `price_timestamp_ms` (when the price itself was observed).
+     */
+    signed_timestamp_ms: bigint;
+    /** keccak256 Merkle root (hex). Diagnostic only — the chain re-derives it. */
+    root: string;
+    /** Sibling hashes (hex, 32 bytes each) folding this leaf to `root`. Empty for a one-leaf snapshot. */
+    proof: string[];
+    /** ed25519 signature over `BCS(IntentMessage<MerkleRoot>)`, hex (± `0x`). */
+    signature: string;
+}
+/** Leaf variant of `waterx_rule`'s `RuleUpdateData.payload` — the default path. */
+export interface WaterxLeafPayload {
+    readonly leaves: readonly WaterxSignedLeaf[];
+}
+/** Batch-envelope variant of `waterx_rule`'s `RuleUpdateData.payload` — the fallback path. */
+export interface WaterxEnvelopePayload {
     readonly envelope: WaterxSignedEnvelope;
 }
+/**
+ * `waterx_rule`'s narrowed `RuleUpdateData.payload` shape: a per-symbol leaf set
+ * OR one indivisible batch envelope. The variant a payload carries decides which
+ * on-chain entry the feed leg emits, so consumers must route on it via
+ * {@link waterxLeavesOf} / {@link waterxEnvelopeOf} rather than assuming either.
+ */
+export type WaterxUpdatePayload = WaterxLeafPayload | WaterxEnvelopePayload;
 /**
  * Parse a quote-center `/v1/quotes/update` response body into a
- * {@link WaterxSignedEnvelope} with the u64 fields decoded as `bigint`, exact.
- *
- * The signature is over `BCS(IntentMessage<BatchPricePayload>)`, so every u64
- * the SDK rebuilds in-PTB must equal the enclave's byte-for-byte or
- * `collect_batch_latest` aborts the whole trade PTB (bad signature — not an
- * abstain). A plain `JSON.parse` yields IEEE-754 doubles that lose precision
- * above 2^53, so instead we recover each integer's exact source literal via the
- * ES2023 reviver `context.source` (Node 21+ / modern browsers) and `BigInt()`
- * it. On an older runtime that passes no `context`, a value within 2^53 is
- * still exact (`BigInt(number)`); a value ABOVE it throws loudly here rather
- * than silently corrupting the payload into an on-chain abort. `num_sources`
- * (u8) and `intent` are coerced back to `number` — both are tiny.
+ * {@link WaterxSignedEnvelope} with the u64 fields decoded as `bigint`, exact
+ * (see {@link parseWithExactIntegers}). `num_sources` (u8) and `intent` are
+ * coerced back to `number` — both are tiny.
  */
 export declare function parseSignedEnvelope(text: string): WaterxSignedEnvelope;
-/** Narrow a `RuleUpdateData` to its `WaterxSignedEnvelope`, or `null`. */
+/**
+ * Parse a quote-center `/v1/quotes/leaves` response body (`{ leaves: [...] }`)
+ * into {@link WaterxSignedLeaf}s, u64s exact as `bigint`, rejecting a malformed
+ * leaf or proof element on the wire — before any PTB is touched.
+ */
+export declare function parseSignedLeaves(text: string): WaterxSignedLeaf[];
+/**
+ * Narrow a `RuleUpdateData` to its per-symbol {@link WaterxSignedLeaf}s, or
+ * `null` when it carries a batch envelope instead (the fallback shape).
+ */
+export declare function waterxLeavesOf(data: RuleUpdateData): readonly WaterxSignedLeaf[] | null;
+/**
+ * Narrow a `RuleUpdateData` to its `WaterxSignedEnvelope`, or `null` when it
+ * carries per-symbol leaves instead (the default shape).
+ */
 export declare function waterxEnvelopeOf(data: RuleUpdateData): WaterxSignedEnvelope | null;
+/**
+ * `waterx_rule::collect_single_with_proof(collector, config, clock,
+ * enclave_config, enclave, timestamp_ms, item, proof, sig)` — the DEFAULT feed
+ * leg. Rebuilds ONE item in-PTB and hands it over with its Merkle proof; on-chain
+ * the leaf is hashed, folded through the proof, and the enclave's signature over
+ * the resulting root is verified before the price reaches the collector.
+ *
+ * Cost is what makes this the default: one item + `proof.length` 32-byte hashes
+ * (~log2 of the snapshot width — 4 to 5 for the 29-feed mainnet registry),
+ * against {@link feedWaterxRule}'s obligation to rebuild every item the batch
+ * signature covers.
+ *
+ * Abort vs abstain is identical to the batch path (see the module header): a
+ * mismatched root, a bad signature, a future signed timestamp, or a config
+ * mismatch ABORTS; a freshness miss or a replayed signed timestamp abstains. One
+ * extra abort of its own — `ECollectorSymbolMismatch` if the leaf's symbol isn't
+ * the collector's — which `aggregateTicker` prevents by construction, since it
+ * looks the leaf up BY the ticker it just built the collector for.
+ */
+export declare function feedWaterxRuleWithProof(tx: Transaction, host: OracleHost, collector: TransactionArgument, leaf: WaterxSignedLeaf): void;
 /**
  * `waterx_rule::collect_batch_latest(collector, config, clock, enclave_config,
- * enclave, timestamp_ms, payload, sig)` — rebuild the enclave-signed batch
- * payload in-PTB (`new_batch_payload` + one `new_batch_item`/`push_batch_item`
- * per item, the exact shape the enclave signed) and contribute the price for
- * `collector.symbol()` to the collector. One collect call re-verifies the batch
- * signature and picks this collector's symbol out of the batch; on-chain it
- * abstains (records `none`) when the symbol is stale or absent from the batch,
- * but ABORTS `EReplayedSignature` when the symbol's signed timestamp was
- * already accepted (per-symbol high-water mark, audit F-014) — see the module
- * header for the concurrent-build consequence.
+ * enclave, timestamp_ms, payload, sig)` — the FALLBACK feed leg, for a
+ * quote-center with no leaf route (and for callers that hold a whole batch).
+ * Rebuilds the enclave-signed batch payload in-PTB (`new_batch_payload` + one
+ * `new_batch_item`/`push_batch_item` per item, the exact shape the enclave
+ * signed) and contributes the price for `collector.symbol()` to the collector.
+ *
+ * Every item must be rebuilt, not just this collector's: the signature covers
+ * `BCS(IntentMessage)` over the whole vector, so a missing item is a failed
+ * verify. That is the cost {@link feedWaterxRuleWithProof} exists to avoid.
+ *
+ * On-chain it abstains (records `none`) when the symbol is stale, absent from the
+ * batch, or already recorded at this signed timestamp; it ABORTS on a bad
+ * signature, a signed timestamp ahead of the `Clock`, or a config mismatch.
  */
 export declare function feedWaterxRule(tx: Transaction, host: OracleHost, collector: TransactionArgument, envelope: WaterxSignedEnvelope): void;
 export declare const WaterxRule: PriceUpdateRule;