@xochi/client 0.0.0-stage → 0.1.1

package/dist/cjs/shared/intents.js

@@ -0,0 +1,227 @@
+"use strict";
+/**
+ * Intent Types
+ *
+ * Status types, order types, and state machine transitions
+ * for the cross-chain intent system.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIMIT_ORDER_EXPIRY_PRESETS = exports.LIMIT_ORDER_STATUS_TRANSITIONS = exports.LIMIT_ORDER_STATUSES = exports.INTENT_STATUS_TRANSITIONS = exports.NOT_EXECUTED_SUBSTATUS = exports.INTENT_STATUSES = void 0;
+exports.isSettlementType = isSettlementType;
+exports.isOrderType = isOrderType;
+exports.isTriggerCondition = isTriggerCondition;
+exports.isIntentStatus = isIntentStatus;
+exports.canTransitionTo = canTransitionTo;
+exports.getStatusLabel = getStatusLabel;
+exports.getRefundReasonLabel = getRefundReasonLabel;
+exports.isLimitOrderStatus = isLimitOrderStatus;
+exports.canLimitOrderTransitionTo = canLimitOrderTransitionTo;
+exports.getLimitOrderStatusLabel = getLimitOrderStatusLabel;
+exports.isDestinationType = isDestinationType;
+function isSettlementType(value) {
+    return value === "public" || value === "shielded" || value === "stealth";
+}
+function isOrderType(value) {
+    return value === "market" || value === "limit";
+}
+function isTriggerCondition(value) {
+    return value === "gte" || value === "lte";
+}
+/** All valid intent statuses */
+exports.INTENT_STATUSES = [
+    "idle",
+    "pending",
+    "quoting",
+    "quoted",
+    "signing",
+    "awaiting_deposit",
+    "executing",
+    "bridging",
+    "settling",
+    "completed",
+    "refunded",
+    "failed",
+    "expired",
+];
+function isIntentStatus(value) {
+    return typeof value === "string" && exports.INTENT_STATUSES.includes(value);
+}
+/**
+ * The `substatus` the worker puts on a `failed` it wrote knowing nothing
+ * moved. The one list of its sources is docs/contracts/xochi-intent-api.md,
+ * "The worker's `not_executed` marker"; this mirrors it. Writers:
+ * 1. an intent read (`GET /api/intent/{id}`, the status poll) of an unsigned
+ *    market `quoted` row (never a Tron deposit route or a limit order; never
+ *    claimed, or every claim undone) past its signed deadline +
+ *    `QUOTED_EXPIRY_GRACE_SECS`;
+ * 2. the quote sweep's finish of a touched `quoted` row past its 30 s quote
+ *    expiry + 60 s;
+ * 3. the resend budget's finish after the solver's not-accepted refusals;
+ * 4. a not-accepted refusal finished because its un-claim's write failed
+ *    (`NOT_ACCEPTED_FAULT_FINISH_ERROR`);
+ * 5. an execute refused because no solver is configured;
+ * 6. a solver refusal of the execute whose body says
+ *    `details.funds_moved === false` (refused before this request's claim and
+ *    before any pull).
+ * Served on every intent read, the history list, the stream frame of that
+ * transition, the execute 502 of writers 3-6, and echoed from the row by the
+ * execute's lost-race 502 and in-doubt 200. Any other solver-reported
+ * `failed` (which may follow an origin pull) never carries it, and neither
+ * does a `failed` nothing vouches for, such as a solver refusal without that
+ * body. A client that sent an execute may offer Retry on a `failed` with this
+ * marker; any other `failed` may follow moved funds (`@xochi/client` holds it
+ * as "may have moved"; the app and widget do not read the marker yet,
+ * xochi#691).
+ *
+ * Writers 1-4 and 6, and the sweep's deletion of an untouched `quoted` row
+ * (which a client holding the intent as not sent reads as nothing moved),
+ * rest on one premise: the worker is the only caller of the solver's execute
+ * for its quotes, which the solver enforces (its execute refuses a caller
+ * other than the one the quote was issued to, Riddler#1346).
+ *
+ * Mirrors `NOT_EXECUTED_SUBSTATUS` in xochi's `@xochi/shared` `intents.ts`
+ * verbatim (the doc path above is in xochi). In this package: README "Fund
+ * safety" (Retry only on this marker, or on a 404 while "not sent yet" past
+ * the Worker's finish).
+ */
+exports.NOT_EXECUTED_SUBSTATUS = "not_executed";
+/** Status transitions for the market order intent state machine */
+exports.INTENT_STATUS_TRANSITIONS = {
+    idle: ["quoting", "pending"],
+    pending: ["quoting", "failed"],
+    quoting: ["quoted", "failed", "idle", "quoting"],
+    quoted: [
+        "signing",
+        "awaiting_deposit",
+        "executing",
+        "completed",
+        "expired",
+        "quoting",
+        "failed",
+        "idle",
+    ],
+    signing: ["executing", "completed", "failed", "quoted"],
+    // Deposit route: from waiting-for-deposit the solver settles (in-flight ->
+    // terminal), or the user resets / it expires.
+    awaiting_deposit: [
+        "executing",
+        "bridging",
+        "settling",
+        "completed",
+        "refunded",
+        "failed",
+        "expired",
+        "quoting",
+        "idle",
+    ],
+    executing: ["bridging", "settling", "completed", "refunded", "failed"],
+    bridging: ["settling", "completed", "refunded", "failed"],
+    settling: ["completed", "refunded", "failed"],
+    completed: ["idle", "quoting"],
+    // A refund is terminal + fund-safe; reset or re-quote from it like completed.
+    refunded: ["idle", "quoting"],
+    failed: ["idle", "quoting"],
+    expired: ["quoting", "idle"],
+};
+/** Check if a status transition is valid */
+function canTransitionTo(from, to) {
+    return exports.INTENT_STATUS_TRANSITIONS[from]?.includes(to) ?? false;
+}
+/** Get human-readable status label */
+function getStatusLabel(status) {
+    const labels = {
+        idle: "Ready",
+        pending: "Pending",
+        quoting: "Getting quote...",
+        quoted: "Quote ready",
+        signing: "Awaiting signature...",
+        awaiting_deposit: "Waiting for your deposit...",
+        executing: "Submitting...",
+        bridging: "Bridging...",
+        settling: "Settling...",
+        completed: "Complete",
+        refunded: "Refunded",
+        failed: "Failed",
+        expired: "Quote expired",
+    };
+    return labels[status];
+}
+/**
+ * Plain-language copy for a deposit refund. Riddler returns a machine-readable
+ * `refundReason` code on a `refunded` status; map it to something a
+ * non-technical user understands. Every case reassures that funds are safe.
+ * Unknown codes fall back to the generic line rather than leaking the raw code.
+ */
+function getRefundReasonLabel(code) {
+    switch (code) {
+        case "quote_expired":
+            return "The quote expired before your deposit arrived, so it was sent back.";
+        case "wrong_token":
+            return "A different token arrived than the quote was for, so it was sent back.";
+        case "deposit_shortfall":
+            return "The deposit was smaller than the quote, so it was sent back.";
+        case "duplicate_deposit":
+            return "This looked like a repeat of a deposit already handled, so it was sent back.";
+        default:
+            return "Your deposit was sent back to you.";
+    }
+}
+/** All valid limit order statuses */
+exports.LIMIT_ORDER_STATUSES = [
+    "idle",
+    "limit_quoting",
+    "limit_quoted",
+    "signing",
+    "waiting",
+    "triggered",
+    "executing",
+    "completed",
+    "cancelled",
+    "expired",
+];
+function isLimitOrderStatus(value) {
+    return typeof value === "string" && exports.LIMIT_ORDER_STATUSES.includes(value);
+}
+/** Status transitions for limit order state machine */
+exports.LIMIT_ORDER_STATUS_TRANSITIONS = {
+    idle: ["limit_quoting"],
+    limit_quoting: ["limit_quoted", "expired"],
+    limit_quoted: ["signing", "expired", "limit_quoting"],
+    signing: ["waiting", "limit_quoted"],
+    waiting: ["triggered", "cancelled", "expired"],
+    triggered: ["executing", "cancelled"],
+    executing: ["completed", "cancelled"],
+    completed: ["idle"],
+    cancelled: ["idle"],
+    expired: ["idle", "limit_quoting"],
+};
+/** Check if a limit order status transition is valid */
+function canLimitOrderTransitionTo(from, to) {
+    return exports.LIMIT_ORDER_STATUS_TRANSITIONS[from]?.includes(to) ?? false;
+}
+/** Get human-readable status label for limit orders */
+function getLimitOrderStatusLabel(status) {
+    const labels = {
+        idle: "Ready",
+        limit_quoting: "Getting quote...",
+        limit_quoted: "Quote ready",
+        signing: "Awaiting signature...",
+        waiting: "Waiting for price...",
+        triggered: "Price reached",
+        executing: "Executing...",
+        completed: "Filled",
+        cancelled: "Cancelled",
+        expired: "Expired",
+    };
+    return labels[status];
+}
+/** Expiry presets for limit orders (in milliseconds) */
+exports.LIMIT_ORDER_EXPIRY_PRESETS = {
+    "1h": 60 * 60 * 1000,
+    "24h": 24 * 60 * 60 * 1000,
+    "7d": 7 * 24 * 60 * 60 * 1000,
+    "30d": 30 * 24 * 60 * 60 * 1000,
+};
+function isDestinationType(value) {
+    return value === "chain" || value === "aztec" || value === "stealth";
+}