@lifi/perps-sdk 2.3.2 → 3.0.0

package/src/types/provider.ts

@@ -19,7 +19,6 @@ import type {
   ProviderAction,
   Quote,
   QuoteSide,
-  RestCallSignedActionStep,
   SignedActionStep,
   SigningMethod,
   TradeType,
@@ -56,6 +55,27 @@ export interface PerpsSDKClient {
  *
  * @public
  */
+/**
+ * Progress for one on-chain leg of an `EVM_TX` batch (e.g. a native deposit's
+ * `approve` then `deposit`). Emitted twice per leg: `submitted` once the wallet
+ * broadcasts and the hash is known, then `confirmed` once the receipt mines. A
+ * consumer can render a live per-transaction stepper from these.
+ *
+ * @public
+ */
+export interface SignActionProgress {
+  /** 0-based index of this leg within the batch. */
+  index: number
+  /** Total legs in the batch. */
+  total: number
+  action: ActionType
+  /** Contract function the leg invokes, e.g. `"approve"` or the deposit method. */
+  functionName: string
+  chainId: number
+  status: 'submitted' | 'confirmed'
+  txHash: string
+}
+
 export interface SignActionsContext {
   userWallet?: PerpsClientSigner
   /**
@@ -76,6 +96,13 @@ export interface SignActionsContext {
    * absent (local/private-key signer, or no hook).
    */
   switchToChain?: (chainId: number) => Promise<PerpsClientSigner>
+  /**
+   * Optional progress sink for on-chain legs. A plugin whose legs broadcast
+   * transactions (Lighter's `EVM_TX`) calls it as each leg is submitted and
+   * confirmed, so a consumer can show a live per-transaction stepper. Bound by
+   * core from the `onProgress` passed to {@link PerpsClient.execute}.
+   */
+  onProgress?: (progress: SignActionProgress) => void
 }
 
 /**
@@ -450,20 +477,11 @@ export interface PerpsProviderPlugin {
   ): Promise<SignedActionStep[]>
 
   /**
-   * Execute credential-bearing rest-call steps directly against the venue.
-   * Required for providers whose descriptors declare
-   * `SigningMethod.AUTH_TOKEN`: the client-held credential (attached by
-   * `signActions` as `headers`) must never transit the LI.FI backend, so the
-   * venue call happens SDK-side. The provider owns base-URL resolution and
-   * mapping the venue response onto {@link ActionResult}s — these results are
-   * authoritative for the caller; `PerpsClient.execute` submits the steps to
-   * the backend afterwards for bookkeeping only, with `headers` stripped.
+   * Observe the per-step results of an `/executeAction` round trip before the
+   * core surfaces failures. Lets a provider react to structured failure codes
+   * — e.g. evicting a locally stored credential the venue no longer accepts.
    */
-  executeRestCallActions?(
-    steps: RestCallSignedActionStep[],
-    address: Address,
-    options?: SDKRequestOptions
-  ): Promise<ActionResult[]>
+  onExecuteResults?(address: Address, results: ActionResult[]): Promise<void>
 }
 
 /**

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@lifi/perps-sdk'
-export const version = '2.3.2'
+export const version = '3.0.0'

package/dist/cjs/client/clientLog.d.ts

@@ -1,4 +0,0 @@
-export declare const clientLog: {
-    readonly bookkeepingFailure: (provider: string, error: unknown) => void;
-};
-//# sourceMappingURL=clientLog.d.ts.map

package/dist/cjs/client/clientLog.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientLog.d.ts","sourceRoot":"","sources":["../../../src/client/clientLog.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,SAAS;4CAMS,MAAM,SAAS,OAAO,KAAG,IAAI;CAMlD,CAAA"}

package/dist/cjs/client/clientLog.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.clientLog = void 0;
-exports.clientLog = {
-    bookkeepingFailure(provider, error) {
-        console.error(`[${provider}] backend bookkeeping submission failed after venue execution`, error);
-    },
-};
-//# sourceMappingURL=clientLog.js.map

package/dist/cjs/client/clientLog.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientLog.js","sourceRoot":"","sources":["../../../src/client/clientLog.ts"],"names":[],"mappings":";;;AAOa,QAAA,SAAS,GAAG;IAMvB,kBAAkB,CAAC,QAAgB,EAAE,KAAc;QACjD,OAAO,CAAC,KAAK,CACX,IAAI,QAAQ,+DAA+D,EAC3E,KAAK,CACN,CAAA;IACH,CAAC;CACO,CAAA"}

package/dist/esm/client/clientLog.d.ts

@@ -1,16 +0,0 @@
-/**
- * Structured logger for client-layer (non-WebSocket) diagnostics, the REST-side
- * counterpart to {@link wsLog}, so failures surface through a single named
- * channel rather than scattered `console` calls.
- *
- * @internal
- */
-export declare const clientLog: {
-    /**
-     * The backend bookkeeping submission rejected after the venue call already
-     * landed. Surfaced at `error` and swallowed by the caller — a failed
-     * mirror-write must never mask an order that already executed on the venue.
-     */
-    readonly bookkeepingFailure: (provider: string, error: unknown) => void;
-};
-//# sourceMappingURL=clientLog.d.ts.map

package/dist/esm/client/clientLog.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientLog.d.ts","sourceRoot":"","sources":["../../../src/client/clientLog.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;IACpB;;;;OAIG;4CAC0B,MAAM,SAAS,OAAO,KAAG,IAAI;CAMlD,CAAA"}

package/dist/esm/client/clientLog.js

@@ -1,18 +0,0 @@
-/**
- * Structured logger for client-layer (non-WebSocket) diagnostics, the REST-side
- * counterpart to {@link wsLog}, so failures surface through a single named
- * channel rather than scattered `console` calls.
- *
- * @internal
- */
-export const clientLog = {
-    /**
-     * The backend bookkeeping submission rejected after the venue call already
-     * landed. Surfaced at `error` and swallowed by the caller — a failed
-     * mirror-write must never mask an order that already executed on the venue.
-     */
-    bookkeepingFailure(provider, error) {
-        console.error(`[${provider}] backend bookkeeping submission failed after venue execution`, error);
-    },
-};
-//# sourceMappingURL=clientLog.js.map

package/dist/esm/client/clientLog.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientLog.js","sourceRoot":"","sources":["../../../src/client/clientLog.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB;;;;OAIG;IACH,kBAAkB,CAAC,QAAgB,EAAE,KAAc;QACjD,OAAO,CAAC,KAAK,CACX,IAAI,QAAQ,+DAA+D,EAC3E,KAAK,CACN,CAAA;IACH,CAAC;CACO,CAAA"}

package/dist/types/client/clientLog.d.ts

@@ -1,16 +0,0 @@
-/**
- * Structured logger for client-layer (non-WebSocket) diagnostics, the REST-side
- * counterpart to {@link wsLog}, so failures surface through a single named
- * channel rather than scattered `console` calls.
- *
- * @internal
- */
-export declare const clientLog: {
-    /**
-     * The backend bookkeeping submission rejected after the venue call already
-     * landed. Surfaced at `error` and swallowed by the caller — a failed
-     * mirror-write must never mask an order that already executed on the venue.
-     */
-    readonly bookkeepingFailure: (provider: string, error: unknown) => void;
-};
-//# sourceMappingURL=clientLog.d.ts.map

package/dist/types/client/clientLog.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientLog.d.ts","sourceRoot":"","sources":["../../../src/client/clientLog.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;IACpB;;;;OAIG;4CAC0B,MAAM,SAAS,OAAO,KAAG,IAAI;CAMlD,CAAA"}

package/src/client/clientLog.ts

@@ -1,20 +0,0 @@
-/**
- * Structured logger for client-layer (non-WebSocket) diagnostics, the REST-side
- * counterpart to {@link wsLog}, so failures surface through a single named
- * channel rather than scattered `console` calls.
- *
- * @internal
- */
-export const clientLog = {
-  /**
-   * The backend bookkeeping submission rejected after the venue call already
-   * landed. Surfaced at `error` and swallowed by the caller — a failed
-   * mirror-write must never mask an order that already executed on the venue.
-   */
-  bookkeepingFailure(provider: string, error: unknown): void {
-    console.error(
-      `[${provider}] backend bookkeeping submission failed after venue execution`,
-      error
-    )
-  },
-} as const