@candledottv/agent-sdk 0.6.2 → 0.6.3

package/dist/hyperliquid-risk.d.ts

@@ -0,0 +1,425 @@
+/**
+ * Hyperliquid risk and visibility (Candle spec 2026-10-17-hyperliquid-phase1-a-risk-visibility-design.md,
+ * BE-1582): the one engine behind `candle perps account | positions | risk | watch`, the portfolio's
+ * Hyperliquid section, the SDK's `perpsRisk()` and `watchPerpsRisk()`, and the MCP's
+ * `candle_perps_risk` (spec A-1, invariant I1). No surface computes a level any other way.
+ *
+ * Every venue read goes from the caller's machine straight to Hyperliquid's public `/info`
+ * (`clearinghouseState`, `metaAndAssetCtxs`, `userAbstraction`, and for the account line's recent
+ * figures `userFillsByTime` and `userFunding`). Nothing here signs, builds or submits, and nothing
+ * here calls Candle: the caller passes the thresholds it read from `GET /keys/self/limits`.
+ *
+ * Money fields are decimal strings as Hyperliquid sent them, or computed from those strings with
+ * exact decimal arithmetic. Ratios and distances are reported as JSON numbers, but every level
+ * decision compares the decimal strings exactly (`a / b < bps / 10000` as `a * 10000 < bps * b`),
+ * so a value exactly on a threshold is the lower level and no float rounding moves a boundary.
+ *
+ * `metaAndAssetCtxs` is spec B's read (`readHyperliquidMarkets` in `hyperliquid-markets.ts`, BE-1581,
+ * which landed first): this engine imports it rather than adding a second one (BE-1582 constraint 6).
+ *
+ * `packages/cli/src/hyperliquid-risk.ts` and `packages/mcp/src/hyperliquid-risk.ts` are
+ * byte-identical copies of this file (drift tests enforce it). Its one import is
+ * `hyperliquid-markets.ts`, which sits beside it, byte for byte, in all three packages.
+ */
+import { type PerpsMarketFetch, type PerpsMarketSnapshot } from "./hyperliquid-markets";
+export type HyperliquidRiskNetwork = "mainnet" | "testnet";
+/** Hyperliquid's public `/info` per network; equal to `HYPERLIQUID_INFO_URLS` in hyperliquid.ts (a test checks). */
+export declare const HYPERLIQUID_RISK_INFO_URLS: Readonly<Record<HyperliquidRiskNetwork, string>>;
+export interface PerpsRiskThresholds {
+    /** A position is `warn` when its liquidation distance is under this (bps of the mark). */
+    warnDistanceBps: number;
+    /** A position is `critical` when its liquidation distance is under this. */
+    criticalDistanceBps: number;
+    /** The margin level is `warn` when the cross margin ratio is above this (bps; 10000 is liquidation). */
+    warnMarginRatioBps: number;
+    /** The margin level is `critical` when the cross margin ratio is above this. */
+    criticalMarginRatioBps: number;
+    /** `watch` only: how far past a threshold a level must move before it clears (bps). */
+    clearBandBps: number;
+}
+/** What a key stores (`userApiKeys.perpsRisk`): any subset; an absent field takes the default. */
+export type PerpsRiskSettings = Partial<PerpsRiskThresholds>;
+export declare const PERPS_RISK_FIELDS: readonly ["warnDistanceBps", "criticalDistanceBps", "warnMarginRatioBps", "criticalMarginRatioBps", "clearBandBps"];
+/**
+ * The defaults (D1: suggestions until Andrew confirms them, overridable per key). The same values
+ * live in `packages/db/convex/lib/perpsRiskPolicy.ts`; a test asserts the two are equal.
+ */
+export declare const HYPERLIQUID_RISK_DEFAULTS: Readonly<PerpsRiskThresholds>;
+export type PerpsRiskThresholdsSource = "defaults" | "key" | "defaults (server did not report)";
+export type PerpsRiskThresholdsReport = PerpsRiskThresholds & {
+    source: PerpsRiskThresholdsSource;
+};
+/** Defaults overlaid by the stored fields. */
+export declare function effectivePerpsRisk(stored: PerpsRiskSettings | null | undefined): PerpsRiskThresholds;
+/**
+ * Why an effective set cannot mean what it appears to, or null. The same rule as the Convex
+ * policy's `validatePerpsRisk`: whole numbers; distances 1 to 9900; ratios 1 to 9999; critical
+ * distance under warn distance; warn ratio under critical ratio; band 0 to 1000.
+ */
+export declare function perpsRiskProblem(t: PerpsRiskThresholds): string | null;
+/**
+ * The thresholds a `GET /keys/self/limits` answer gives this key: the server's effective set when it
+ * reports one, else the stored fields over the defaults, else the defaults with the source saying
+ * the server did not report (an API that predates `perpsRisk`, E6). Never a refusal.
+ */
+export declare function perpsRiskFromLimits(body: unknown): {
+    thresholds: PerpsRiskThresholdsReport;
+    stored: PerpsRiskSettings | null;
+};
+/** The fetch every read here takes; the same shape spec B's reader takes. */
+export type HyperliquidInfoFetcher = PerpsMarketFetch;
+/** A venue read that failed, timed out, or came back in a shape this engine does not know. */
+export declare class HyperliquidReadError extends Error {
+    readonly rateLimited: boolean;
+    readonly code = "PERPS_READ_FAILED";
+    constructor(message: string, rateLimited?: boolean);
+}
+export interface HyperliquidInfoOptions {
+    /** Per-request timeout; 5 s like the server's reader. */
+    timeoutMs?: number;
+    /** How a 429 waits its one retry (1 s). Injected so tests run without real time. */
+    sleep?: (ms: number) => Promise<void>;
+}
+/** One `/info` POST. A 429 is retried once after 1 s (E5); anything else that fails throws. */
+export declare function hyperliquidInfo(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, body: Record<string, unknown>, opts?: HyperliquidInfoOptions): Promise<unknown>;
+/** Hyperliquid's main perp universe and its contexts, as spec B's reader returns them. */
+export type HyperliquidMarkets = PerpsMarketSnapshot;
+/**
+ * The shared `metaAndAssetCtxs` read (spec B's `readHyperliquidMarkets`), retried once after 1 s
+ * (E5). That reader does not say why a read failed, so any failure is retried once, and a second
+ * failure is `PERPS_READ_FAILED`. Watch's doubling back-off follows a 429 on the account read.
+ */
+export declare function readHyperliquidMarketSnapshot(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, opts?: HyperliquidInfoOptions): Promise<HyperliquidMarkets>;
+/** The coin's mark price, or null when the coin is not in the universe or its mark is null or not positive (E3). */
+export declare function hyperliquidMark(markets: HyperliquidMarkets, coin: string): string | null;
+/** `clearinghouseState` for one address, shape-checked for every field the report reads. */
+export declare function readHyperliquidClearinghouse(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, address: string, opts?: HyperliquidInfoOptions): Promise<HyperliquidClearinghouse>;
+/** The account's abstraction mode (`default`, `disabled`, `unifiedAccount`, `portfolioMargin`, ...). */
+export declare function readHyperliquidAccountMode(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, address: string, opts?: HyperliquidInfoOptions): Promise<string>;
+/** The account modes whose perps collateral `clearinghouseState` describes (`perps-gate.ts`). */
+export declare const HYPERLIQUID_STANDARD_MODES: readonly string[];
+export interface HyperliquidPositionState {
+    coin: string;
+    szi: string;
+    entryPx: string;
+    positionValue: string;
+    unrealizedPnl: string;
+    returnOnEquity: string;
+    leverage: {
+        type: string;
+        value: number;
+    };
+    liquidationPx: string | null;
+    marginUsed: string;
+    cumFunding: {
+        sinceOpen: string;
+    };
+}
+export interface HyperliquidClearinghouse {
+    marginSummary: {
+        accountValue: string;
+        totalMarginUsed: string;
+    };
+    crossMarginSummary: {
+        accountValue: string;
+        totalMarginUsed: string;
+    };
+    crossMaintenanceMarginUsed: string;
+    withdrawable: string;
+    positions: HyperliquidPositionState[];
+}
+export declare function parseClearinghouse(body: unknown): HyperliquidClearinghouse;
+export type PerpsRiskLevel = "ok" | "warn" | "critical" | "unknown";
+export type PerpsPositionLevel = "ok" | "warn" | "critical" | "none";
+export type PerpsRiskReason = "PERPS_ACCOUNT_MODE" | "PERPS_READ_STALE" | "PERPS_READ_FAILED";
+export interface PerpsPositionRow {
+    coin: string;
+    side: "long" | "short";
+    size: string;
+    entryPx: string;
+    /** Null when the coin has no mark (E3, "unmarked"). */
+    markPx: string | null;
+    unrealizedPnlUsd: string;
+    returnOnEquity: string;
+    leverage: {
+        value: number;
+        type: string;
+    };
+    liquidationPx: string | null;
+    /** `abs(mark - liquidation) / mark`, unrounded; null when either price is null. */
+    liquidationDistance: number | null;
+    /**
+     * `cumFunding.sinceOpen`, Hyperliquid's sign: positive is funding the position PAID (verified
+     * read-only on mainnet, 2026-10-17, against `userFunding`; E8). The opposite of `fundingUsd` in
+     * the account's recent figures and in `candle pnl`, where positive is received.
+     */
+    fundingSinceOpenUsd: string;
+    marginUsedUsd: string;
+    positionValueUsd: string;
+    /** This position alone; `none` when its distance is null. */
+    level: PerpsPositionLevel;
+}
+export interface PerpsAccountLine {
+    /** `marginSummary.accountValue`: cross plus isolated margin and isolated P&L. */
+    accountValueUsd: string;
+    /** `marginSummary.totalMarginUsed`, including isolated margin. */
+    marginUsedUsd: string;
+    /** `crossMarginSummary.accountValue`: the cross side only, the margin ratio's denominator. */
+    crossAccountValueUsd: string;
+    /** `accountValueUsd - marginUsedUsd`, floored at 0. An estimate; `withdrawableUsd` is what can leave. */
+    freeMarginUsd: string;
+    /** Hyperliquid's `withdrawable`, never derived from account value (I5). */
+    withdrawableUsd: string;
+    crossMaintenanceMarginUsedUsd: string;
+    /** `crossMaintenanceMarginUsed / crossMarginSummary.accountValue`; liquidation at 1; 0 with no cross exposure; null only for E2. */
+    marginRatio: number | null;
+    unrealizedPnlUsd: string;
+    positionCount: number;
+    mode: string;
+    level: PerpsRiskLevel;
+}
+export type PerpsRiskDriver = {
+    kind: "position";
+    coin: string;
+    level: PerpsPositionLevel;
+    liquidationDistance: number | null;
+    threshold: number | null;
+    reason?: "unmarked";
+} | {
+    kind: "margin";
+    level: PerpsPositionLevel;
+    marginRatio: number | null;
+    threshold: number | null;
+    reason?: "no equity";
+};
+export declare const PERPS_RISK_NOTE = "Phase 1 has no server-side monitor: nothing warns you unless you poll this or run candle perps watch.";
+export interface PerpsRiskReport {
+    schema: "candle.perps.risk/1";
+    walletId: string;
+    address: string;
+    network: HyperliquidRiskNetwork;
+    mode: string | null;
+    /** The earlier of the reads' local completion times. */
+    readAt: string;
+    level: PerpsRiskLevel;
+    reason: PerpsRiskReason | null;
+    drivers: PerpsRiskDriver[];
+    /** At `ok`, the driver nearest to warn; otherwise null. */
+    closest: PerpsRiskDriver | null;
+    thresholds: PerpsRiskThresholdsReport;
+    /** Null when no level could be computed from the data (`unknown`). */
+    account: PerpsAccountLine | null;
+    positions: PerpsPositionRow[];
+    note: string;
+}
+export interface PerpsRiskIdentity {
+    walletId: string;
+    address: string;
+    network: HyperliquidRiskNetwork;
+}
+/**
+ * The pure rule (A-5): one report from one read, no memory. `market` is spec B's market snapshot,
+ * `state` is `clearinghouseState` (raw or parsed). A mode outside `default` and `disabled`
+ * gives `unknown` with `PERPS_ACCOUNT_MODE` and no level from the data (A-7).
+ */
+export declare function hyperliquidRiskReport(state: unknown, market: HyperliquidMarkets, mode: string, thresholds: PerpsRiskThresholdsReport, now: number, identity?: PerpsRiskIdentity): PerpsRiskReport;
+/** A report with no level: a failed or stale read (I4). */
+export declare function unknownRiskReport(identity: PerpsRiskIdentity, thresholds: PerpsRiskThresholdsReport, reason: PerpsRiskReason, now: number, mode?: string | null): PerpsRiskReport;
+/** Two halves completing further apart than this yield no level (design 4, A-8). */
+export declare const PERPS_RISK_STALE_MS = 30000;
+export interface ReadPerpsRiskOptions extends HyperliquidInfoOptions {
+    fetcher: HyperliquidInfoFetcher;
+    network: HyperliquidRiskNetwork;
+    walletId: string;
+    address: string;
+    thresholds: PerpsRiskThresholdsReport;
+    now: () => number;
+    /** A mode already read (watch reads it every 5 minutes); omitted, it is read with the rest. */
+    mode?: string;
+}
+/**
+ * The A-8 read: `clearinghouseState`, `metaAndAssetCtxs` and (unless given) `userAbstraction` in
+ * parallel, then the pure rule. Halves completing more than 30 s apart are `PERPS_READ_STALE`.
+ * A failed read throws `HyperliquidReadError`; callers turn it into `PERPS_READ_FAILED`.
+ */
+export declare function readPerpsRisk(opts: ReadPerpsRiskOptions): Promise<PerpsRiskReport>;
+/** The exit code a level carries (A-8): 0 ok, 10 warn, 11 critical, 1 for unknown. */
+export declare function perpsRiskExitCode(level: PerpsRiskLevel): 0 | 1 | 10 | 11;
+export interface PerpsRecentFigures {
+    /** Epoch ms. */
+    startTime: number;
+    endTime: number;
+    /** Sum of `closedPnl` over main-perp fills in the window. */
+    realizedPnlUsd: string;
+    /** Venue fees, builder fees included; negative is a rebate. */
+    feesUsd: string;
+    /** Positive is received, negative is paid. */
+    fundingUsd: string;
+    fills: number;
+    fundingPayments: number;
+    /** Hyperliquid's response cap was hit (2,000 fills or 500 funding rows): the figures are partial. */
+    truncated: boolean;
+}
+export declare const PERPS_FILLS_RESPONSE_CAP = 2000;
+export declare const PERPS_FUNDING_RESPONSE_CAP = 500;
+export declare const PERPS_RECENT_MAX_MS: number;
+/** Main perps only: not a builder dex (`dex:COIN`), not spot (`@n` or `A/B`); the P&L section's filter. */
+export declare function isMainPerpCoin(coin: unknown): boolean;
+export declare function readPerpsRecent(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, address: string, window: {
+    startTime: number;
+    endTime: number;
+}, opts?: HyperliquidInfoOptions): Promise<PerpsRecentFigures>;
+export declare function summarizePerpsRecent(fills: unknown, funding: unknown, window: {
+    startTime: number;
+    endTime: number;
+}): PerpsRecentFigures;
+/** `candle perps account --json` and `perpsAccount()` (A-10). */
+export interface PerpsAccountReport extends PerpsAccountLineFields {
+    schema: "candle.perps.account/1";
+    walletId: string;
+    address: string;
+    network: HyperliquidRiskNetwork;
+    mode: string | null;
+    readAt: string;
+    recent: PerpsRecentFigures;
+    risk: {
+        level: PerpsRiskLevel;
+        reason: PerpsRiskReason | null;
+        drivers: PerpsRiskDriver[];
+    };
+}
+type PerpsAccountLineFields = Partial<Omit<PerpsAccountLine, "mode" | "level">>;
+/** One report plus the recent window, in the A-10 shape. */
+export declare function perpsAccountReport(report: PerpsRiskReport, recent: PerpsRecentFigures): PerpsAccountReport;
+/**
+ * Whether every measured position and the margin ratio sit inclusively past `level`'s thresholds by
+ * the band: distance `>=` threshold + band, ratio `<=` threshold - band. A null distance never
+ * blocks (E1); an unmarked position blocks leaving `warn` (E3), since it holds the level there.
+ */
+export declare function perpsRiskClears(report: PerpsRiskReport, leaving: "warn" | "critical"): boolean;
+/**
+ * One watch step: the level after `report`, given the level before it. Rising is immediate (the pure
+ * rule). Falling goes in one poll to the lowest level whose clear condition holds, so `critical` may
+ * go straight to `ok`; if none holds, the level stays. From `unknown` (start, or after a stale
+ * read) the pure rule decides, with no band. A one-shot `risk` never calls this.
+ */
+export declare function perpsRiskStep(previous: PerpsRiskLevel, report: PerpsRiskReport): PerpsRiskLevel;
+export type PerpsWatchEvent = {
+    event: "start";
+    walletId: string;
+    address: string;
+    network: HyperliquidRiskNetwork;
+    at: string;
+    intervalSeconds: number;
+    heartbeatSeconds: number;
+    thresholds: PerpsRiskThresholdsReport;
+    /** Hyperliquid request weight one watcher spends per minute at this interval (of 1,200 per IP). */
+    weightPerMinute: number;
+} | (Omit<PerpsRiskReport, "level"> & {
+    event: "level";
+    level: PerpsRiskLevel;
+    /** What the pure rule says for this read; `level` is held by hysteresis. */
+    ruleLevel: PerpsRiskLevel;
+    previous: PerpsRiskLevel;
+    cleared?: true;
+}) | (Omit<PerpsRiskReport, "level"> & {
+    event: "heartbeat";
+    level: PerpsRiskLevel;
+    ruleLevel: PerpsRiskLevel;
+}) | {
+    event: "error";
+    at: string;
+    code: string;
+    message: string;
+    nextPollSeconds: number;
+};
+export declare const PERPS_WATCH_DEFAULT_INTERVAL_MS = 10000;
+export declare const PERPS_WATCH_MIN_INTERVAL_MS = 5000;
+export declare const PERPS_WATCH_MAX_INTERVAL_MS = 300000;
+export declare const PERPS_WATCH_DEFAULT_HEARTBEAT_MS = 60000;
+/** Thresholds and the account mode are re-read this often (I8: Candle is called at start and then every 5 minutes). */
+export declare const PERPS_WATCH_REFRESH_MS = 300000;
+/**
+ * Hyperliquid's weights (rate-limit page, read 2026-10-17): `clearinghouseState` 2; `metaAndAssetCtxs`
+ * and `userAbstraction` are not named there, so they take the default 20. A poll is the first two;
+ * the mode is read every 5 minutes.
+ */
+export declare const HYPERLIQUID_INFO_WEIGHTS: {
+    readonly clearinghouseState: 2;
+    readonly metaAndAssetCtxs: 20;
+    readonly userAbstraction: 20;
+};
+export declare function perpsWatchWeightPerMinute(intervalMs: number): number;
+export interface WatchPerpsRiskOptions {
+    fetcher: HyperliquidInfoFetcher;
+    network: HyperliquidRiskNetwork;
+    walletId: string;
+    address: string;
+    /** Called at start and every 5 minutes; a failed re-read keeps the last (A-9). */
+    thresholds: () => Promise<PerpsRiskThresholdsReport>;
+    intervalMs?: number;
+    /** 0 turns heartbeats off. */
+    heartbeatMs?: number;
+    now: () => number;
+    sleep: (ms: number) => Promise<void>;
+    signal?: AbortSignal;
+    /** Return at the first level change after the first reading, with that level. */
+    onceLevelChange?: boolean;
+    onEvent: (event: PerpsWatchEvent) => void | Promise<void>;
+}
+/**
+ * The loop `candle perps watch` wraps, and an always-on bot can run as is. Polls until `signal`
+ * aborts (or the first change with `onceLevelChange`) and resolves with the last known level.
+ */
+export declare function watchPerpsRisk(opts: WatchPerpsRiskOptions): Promise<{
+    level: PerpsRiskLevel;
+}>;
+export interface PerpsPortfolioAccount {
+    address: string;
+    label?: string;
+    walletId?: string;
+    accountValueUsd: string;
+    unrealizedPnlUsd: string;
+    positionCount: number;
+    /** At the default thresholds (portfolio is account-wide; thresholds are per key). */
+    level: PerpsRiskLevel;
+}
+export type PerpsPortfolioSection = {
+    read: true;
+    network: HyperliquidRiskNetwork;
+    /** Accounts with a position or a non-zero account value. */
+    accounts: PerpsPortfolioAccount[];
+    /** Sum of the total (`marginSummary`) account value and unrealized P&L of the accounts read. */
+    subtotal: {
+        accountValueUsd: string;
+        unrealizedPnlUsd: string;
+    };
+    /** Read, holding nothing on Hyperliquid: counted, not listed. */
+    empty: number;
+    /** Not read: a failed read, or past the 100-address cap. Never zero. */
+    unread: {
+        address: string;
+        label?: string;
+        walletId?: string;
+        reason: string;
+    }[];
+    thresholds: "defaults";
+} | {
+    read: false;
+    reason: string;
+};
+export declare const PERPS_PORTFOLIO_MAX_ACCOUNTS = 100;
+/**
+ * One shared `metaAndAssetCtxs`, then `clearinghouseState` per address, at most 8 in flight and at
+ * most 100 addresses. Every level is at the defaults. A failed market read leaves the whole section
+ * unread; a failed account read leaves that account unread. Not added to any portfolio total (D4).
+ */
+export declare function perpsPortfolioSection(fetcher: HyperliquidInfoFetcher, network: HyperliquidRiskNetwork, wallets: readonly {
+    address: string;
+    label?: string;
+    walletId?: string;
+}[], opts?: HyperliquidInfoOptions & {
+    now?: () => number;
+}): Promise<PerpsPortfolioSection>;
+export {};
+//# sourceMappingURL=hyperliquid-risk.d.ts.map

package/dist/hyperliquid-risk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyperliquid-risk.d.ts","sourceRoot":"","sources":["../src/hyperliquid-risk.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EAEzB,MAAM,uBAAuB,CAAA;AAE9B,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,SAAS,CAAA;AAE1D,oHAAoH;AACpH,eAAO,MAAM,0BAA0B,EAAE,QAAQ,CAAC,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAGvF,CAAA;AAID,MAAM,WAAW,mBAAmB;IAClC,0FAA0F;IAC1F,eAAe,EAAE,MAAM,CAAA;IACvB,4EAA4E;IAC5E,mBAAmB,EAAE,MAAM,CAAA;IAC3B,wGAAwG;IACxG,kBAAkB,EAAE,MAAM,CAAA;IAC1B,gFAAgF;IAChF,sBAAsB,EAAE,MAAM,CAAA;IAC9B,uFAAuF;IACvF,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,kGAAkG;AAClG,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAE5D,eAAO,MAAM,iBAAiB,qHAMpB,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,QAAQ,CAAC,mBAAmB,CAMnE,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,UAAU,GAAG,KAAK,GAAG,kCAAkC,CAAA;AAE/F,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAAE,MAAM,EAAE,yBAAyB,CAAA;CAAE,CAAA;AAEnG,8CAA8C;AAC9C,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,GAAG,mBAAmB,CAOpG;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI,CAiBtE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG;IAClD,UAAU,EAAE,yBAAyB,CAAA;IACrC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAA;CACjC,CAaA;AAUD,6EAA6E;AAC7E,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAA;AAErD,8FAA8F;AAC9F,qBAAa,oBAAqB,SAAQ,KAAK;IAI3C,QAAQ,CAAC,WAAW;IAHtB,QAAQ,CAAC,IAAI,uBAAsB;gBAEjC,OAAO,EAAE,MAAM,EACN,WAAW,UAAQ;CAK/B;AAED,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oFAAoF;IACpF,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACtC;AAKD,+FAA+F;AAC/F,wBAAsB,eAAe,CACnC,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,GAAE,sBAA2B,GAChC,OAAO,CAAC,OAAO,CAAC,CAkClB;AAED,0FAA0F;AAC1F,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAA;AAEpD;;;;GAIG;AACH,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,IAAI,GAAE,sBAA2B,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAsB7B;AAED,oHAAoH;AACpH,wBAAgB,eAAe,CAAC,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAMxF;AAED,4FAA4F;AAC5F,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,sBAA2B,GAChC,OAAO,CAAC,wBAAwB,CAAC,CAInC;AAED,wGAAwG;AACxG,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,sBAA2B,GAChC,OAAO,CAAC,MAAM,CAAC,CAIjB;AAED,iGAAiG;AACjG,eAAO,MAAM,0BAA0B,EAAE,SAAS,MAAM,EAA4B,CAAA;AAEpF,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,CAAA;IAChE,kBAAkB,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,CAAA;IACrE,0BAA0B,EAAE,MAAM,CAAA;IAClC,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,wBAAwB,EAAE,CAAA;CACtC;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,wBAAwB,CA4C1E;AAID,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;AACnE,MAAM,MAAM,kBAAkB,GAAG,IAAI,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAA;AACpE,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,kBAAkB,GAAG,mBAAmB,CAAA;AAE7F,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,uDAAuD;IACvD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,mFAAmF;IACnF,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,CAAA;IACxB,6DAA6D;IAC7D,KAAK,EAAE,kBAAkB,CAAA;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,iFAAiF;IACjF,eAAe,EAAE,MAAM,CAAA;IACvB,kEAAkE;IAClE,aAAa,EAAE,MAAM,CAAA;IACrB,8FAA8F;IAC9F,oBAAoB,EAAE,MAAM,CAAA;IAC5B,yGAAyG;IACzG,aAAa,EAAE,MAAM,CAAA;IACrB,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAA;IACvB,6BAA6B,EAAE,MAAM,CAAA;IACrC,oIAAoI;IACpI,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,cAAc,CAAA;CACtB;AAED,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,kBAAkB,CAAA;IACzB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB,GACD;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,EAAE,kBAAkB,CAAA;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB,CAAA;AAEL,eAAO,MAAM,eAAe,0GAC6E,CAAA;AAEzG,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,qBAAqB,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,sBAAsB,CAAA;IAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,cAAc,CAAA;IACrB,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAC9B,OAAO,EAAE,eAAe,EAAE,CAAA;IAC1B,2DAA2D;IAC3D,OAAO,EAAE,eAAe,GAAG,IAAI,CAAA;IAC/B,UAAU,EAAE,yBAAyB,CAAA;IACrC,sEAAsE;IACtE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAChC,SAAS,EAAE,gBAAgB,EAAE,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,sBAAsB,CAAA;CAChC;AAQD;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,yBAAyB,EACrC,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,iBAAqE,GAC9E,eAAe,CAmKjB;AAED,2DAA2D;AAC3D,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,iBAAiB,EAC3B,UAAU,EAAE,yBAAyB,EACrC,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,MAAM,GAAG,IAAW,GACzB,eAAe,CAejB;AAED,oFAAoF;AACpF,eAAO,MAAM,mBAAmB,QAAS,CAAA;AAEzC,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE,OAAO,EAAE,sBAAsB,CAAA;IAC/B,OAAO,EAAE,sBAAsB,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,yBAAyB,CAAA;IACrC,GAAG,EAAE,MAAM,MAAM,CAAA;IACjB,+FAA+F;IAC/F,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC,CAkBxF;AAED,sFAAsF;AACtF,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAExE;AAID,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,cAAc,EAAE,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;IACf,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,EAAE,MAAM,CAAA;IACvB,qGAAqG;IACrG,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,eAAO,MAAM,wBAAwB,OAAQ,CAAA;AAC7C,eAAO,MAAM,0BAA0B,MAAM,CAAA;AAC7C,eAAO,MAAM,mBAAmB,QAA4B,CAAA;AAE5D,2GAA2G;AAC3G,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAErD;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAC9C,IAAI,GAAE,sBAA2B,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAiB7B;AAED,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC7C,kBAAkB,CAqCpB;AAED,iEAAiE;AACjE,MAAM,WAAW,kBAAmB,SAAQ,sBAAsB;IAChE,MAAM,EAAE,wBAAwB,CAAA;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,sBAAsB,CAAA;IAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,kBAAkB,CAAA;IAC1B,IAAI,EAAE;QAAE,KAAK,EAAE,cAAc,CAAC;QAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;CAC5F;AAED,KAAK,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAA;AAE/E,4DAA4D;AAC5D,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAa1G;AAID;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAsB9F;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,eAAe,GAAG,cAAc,CAO/F;AAED,MAAM,MAAM,eAAe,GACvB;IACE,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,sBAAsB,CAAA;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,yBAAyB,CAAA;IACrC,mGAAmG;IACnG,eAAe,EAAE,MAAM,CAAA;CACxB,GACD,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAChC,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,cAAc,CAAA;IACrB,4EAA4E;IAC5E,SAAS,EAAE,cAAc,CAAA;IACzB,QAAQ,EAAE,cAAc,CAAA;IACxB,OAAO,CAAC,EAAE,IAAI,CAAA;CACf,CAAC,GACF,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAAE,KAAK,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,cAAc,CAAC;IAAC,SAAS,EAAE,cAAc,CAAA;CAAE,CAAC,GAC3G;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1F,eAAO,MAAM,+BAA+B,QAAS,CAAA;AACrD,eAAO,MAAM,2BAA2B,OAAQ,CAAA;AAChD,eAAO,MAAM,2BAA2B,SAAU,CAAA;AAClD,eAAO,MAAM,gCAAgC,QAAS,CAAA;AACtD,uHAAuH;AACvH,eAAO,MAAM,sBAAsB,SAAU,CAAA;AAE7C;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;CAAgF,CAAA;AAErH,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAOpE;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,sBAAsB,CAAA;IAC/B,OAAO,EAAE,sBAAsB,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,kFAAkF;IAClF,UAAU,EAAE,MAAM,OAAO,CAAC,yBAAyB,CAAC,CAAA;IACpD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,EAAE,MAAM,MAAM,CAAA;IACjB,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpC,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,iFAAiF;IACjF,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1D;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAAC,CA4GpG;AAiBD,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,qFAAqF;IACrF,KAAK,EAAE,cAAc,CAAA;CACtB;AAED,MAAM,MAAM,qBAAqB,GAC7B;IACE,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,sBAAsB,CAAA;IAC/B,4DAA4D;IAC5D,QAAQ,EAAE,qBAAqB,EAAE,CAAA;IACjC,gGAAgG;IAChG,QAAQ,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/D,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAChF,UAAU,EAAE,UAAU,CAAA;CACvB,GACD;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnC,eAAO,MAAM,4BAA4B,MAAM,CAAA;AAG/C;;;;GAIG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,sBAAsB,EAC/B,OAAO,EAAE,SAAS;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,EAC1E,IAAI,GAAE,sBAAsB,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAA;CAAO,GACzD,OAAO,CAAC,qBAAqB,CAAC,CAmEhC"}

package/dist/hyperliquid-withdraw.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Hyperliquid withdrawals (Candle spec 2026-10-17-hyperliquid-withdrawals-design.md, "Client checks
+ * before each signature"): the client half of a withdrawal from the key's HyperCore balance,
+ * through Relay, to the same key's own Solana or Hood TEE wallet.
+ *
+ * Candle's server builds both signatures; this machine checks each one before it asks the relay to
+ * sign, and refuses with no relay call when anything differs from what it asked for:
+ *
+ *   - Before the NonceMapping: the domain and type list are Relay's, `wallet` and `depositor` are
+ *     this key's own EVM TEE address, `id` is the build's Relay request, and the destination the
+ *     build names is one of this key's own wallets on the chain asked for. Then Relay's own record
+ *     of the request (`GET /requests/v3?id=`) must name that same recipient: the recipient is in
+ *     neither signed message, so this is the only place the client can see it (threat model).
+ *   - Before the SendAsset: the nonce is the mapping's, the amount parses exactly to the micros
+ *     asked for (no float, no string compare), `fromSubAccount` and `sourceDex` are empty, `token`
+ *     and `destinationDex` are the pinned values, `destination` is on the pinned depository
+ *     allow-list, and the primary type, domain and action all match.
+ *
+ * The pins (`token`, `destinationDex`, the depository allow-list and the amount's string form) are
+ * the values three live `/quote/v2` reads recorded on 2026-10-18 (V-A part 2). With no pins every
+ * check refuses: nothing is guessed.
+ *
+ * `packages/cli/src/hyperliquid-withdraw.ts` is a byte-identical copy of this file (a drift test
+ * enforces it). Self-contained on purpose: it imports nothing.
+ */
+export type WithdrawAmountForm = "canonical" | "fixed6";
+export interface PerpsWithdrawPins {
+    token: string;
+    destinationDex: string;
+    /** Lowercase depository addresses. */
+    depositories: readonly string[];
+    amountForm: WithdrawAmountForm;
+}
+/**
+ * V-A part 2 (three live `/quote/v2` reads, 2026-10-18). One depository only, by the owner's D10
+ * decision: if Relay rotates it, every withdrawal check refuses until a release records the new one.
+ * Relay's guide example depository (0x865eb9ba...7081) is not on it.
+ */
+export declare const CANDLE_PERPS_WITHDRAW_PINS: PerpsWithdrawPins | null;
+export declare const RELAY_API_URL = "https://api.relay.link";
+export declare const RELAY_NONCE_MAPPING_TYPES: {
+    readonly NonceMapping: readonly [{
+        readonly name: "chainId";
+        readonly type: "string";
+    }, {
+        readonly name: "wallet";
+        readonly type: "address";
+    }, {
+        readonly name: "depositor";
+        readonly type: "address";
+    }, {
+        readonly name: "id";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }];
+};
+export declare const HYPERLIQUID_SEND_ASSET_TYPES: {
+    readonly "HyperliquidTransaction:SendAsset": readonly [{
+        readonly name: "hyperliquidChain";
+        readonly type: "string";
+    }, {
+        readonly name: "destination";
+        readonly type: "string";
+    }, {
+        readonly name: "sourceDex";
+        readonly type: "string";
+    }, {
+        readonly name: "destinationDex";
+        readonly type: "string";
+    }, {
+        readonly name: "token";
+        readonly type: "string";
+    }, {
+        readonly name: "amount";
+        readonly type: "string";
+    }, {
+        readonly name: "fromSubAccount";
+        readonly type: "string";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint64";
+    }];
+};
+/** A withdrawal amount in USDC, at most 6 dp, as micros. Null when it is not one, or zero. */
+export declare function parseWithdrawAmount(value: string): bigint | null;
+/** Micros as the canonical decimal: `5`, `5.5`, `0.000001`. */
+export declare function formatWithdrawAmount(micros: bigint): string;
+/** `sendAsset.amount` parsed exactly to micros, in the pinned form only. Null otherwise. */
+export declare function parseSendAssetAmount(value: unknown, form: WithdrawAmountForm): bigint | null;
+export type WithdrawCheck = {
+    ok: true;
+} | {
+    ok: false;
+    reason: string;
+};
+/** What `POST /agent/perps/withdraw` answers for a quoted withdrawal. */
+export interface PerpsWithdrawBuild {
+    id: string;
+    status: string;
+    from: {
+        walletId: string;
+        address: string;
+        network: string;
+    };
+    to: {
+        chain: "solana" | "hood";
+        walletId: string;
+        address: string;
+    };
+    amountUsdc: string;
+    feesUsdc: string;
+    netUsdc: string;
+    minimumOutUsdc: string;
+    relayRequestId: string;
+    nonce: number;
+    expiresAt: number;
+    typedData?: {
+        domain: unknown;
+        types: unknown;
+        primary_type: string;
+        message: Record<string, unknown>;
+    };
+}
+/** What `POST /agent/perps/withdraw/authorize` answers once Relay accepted the mapping. */
+export interface PerpsWithdrawAuthorization {
+    id: string;
+    status: string;
+    nonce: number;
+    typedData: {
+        domain: unknown;
+        types: unknown;
+        primary_type: string;
+        message: Record<string, unknown>;
+    };
+    action: Record<string, unknown>;
+}
+/**
+ * Before the NonceMapping is signed. `account` is this key's EVM TEE address; `ownDestinations`
+ * holds this key's own wallet addresses on the chain asked for (the Solana TEE wallet, or the EVM
+ * TEE wallet itself for Hood).
+ */
+export declare function verifyWithdrawMapping(build: PerpsWithdrawBuild, expect: {
+    id: string;
+    account: string;
+    to: "solana" | "hood";
+    amountMicros: bigint;
+    ownDestinations: readonly string[];
+    pins: PerpsWithdrawPins | null;
+}): WithdrawCheck;
+/** Before the SendAsset is signed: everything pinned, the nonce the mapping's, the amount exact. */
+export declare function verifyWithdrawSendAsset(authorization: PerpsWithdrawAuthorization, expect: {
+    mappingNonce: number;
+    amountMicros: bigint;
+    pins: PerpsWithdrawPins | null;
+}): WithdrawCheck;
+/**
+ * The threat model's recipient lookup: Relay's own record of the request must name `recipient`.
+ * Read from `GET /requests/v3?id=<requestId>` (`requests[].recipient`). A request Relay does not
+ * list, another recipient, or a read that fails is a refusal: the client cannot see the recipient
+ * any other way.
+ */
+export declare function relayRecipientProblem(fetchImpl: (input: string, init?: {
+    method?: string;
+    headers?: Record<string, string>;
+}) => Promise<{
+    ok: boolean;
+    status: number;
+    json(): Promise<unknown>;
+}>, requestId: string, recipient: string, relayUrl?: string): Promise<string | null>;
+//# sourceMappingURL=hyperliquid-withdraw.d.ts.map

package/dist/hyperliquid-withdraw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyperliquid-withdraw.d.ts","sourceRoot":"","sources":["../src/hyperliquid-withdraw.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,QAAQ,CAAA;AAEvD,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,MAAM,CAAA;IACtB,sCAAsC;IACtC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAA;IAC/B,UAAU,EAAE,kBAAkB,CAAA;CAC/B;AAED;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,iBAAiB,GAAG,IAK5D,CAAA;AAED,eAAO,MAAM,aAAa,2BAA2B,CAAA;AAMrD,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;CAQ5B,CAAA;AAEV,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;CAW/B,CAAA;AAUV,8FAA8F;AAC9F,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKhE;AAED,+DAA+D;AAC/D,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG3D;AAED,4FAA4F;AAC5F,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,GAAG,MAAM,GAAG,IAAI,CAK5F;AAID,MAAM,MAAM,aAAa,GAAG;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AA6CxE,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAC5D,EAAE,EAAE;QAAE,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IACnE,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;CACxG;AAED,2FAA2F;AAC3F,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;IACtG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,kBAAkB,EACzB,MAAM,EAAE;IACN,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,EAAE,EAAE,QAAQ,GAAG,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,eAAe,EAAE,SAAS,MAAM,EAAE,CAAA;IAClC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC/B,GACA,aAAa,CA4Bf;AAED,oGAAoG;AACpG,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,0BAA0B,EACzC,MAAM,EAAE;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE,GACrF,aAAa,CAiCf;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CACzC,SAAS,EAAE,CACT,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,KACzD,OAAO,CAAC;IACX,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;CACzB,CAAC,EACF,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,MAAsB,GAC/B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAexB"}