@lifi/perps-types 16.2.0 → 18.0.0

package/dist/types/market.d.ts

@@ -57,6 +57,11 @@ export interface BaseMarket {
  */
 export interface PerpsMarket extends BaseMarket {
     maxLeverage: number;
+    /**
+     * The display leverage the venue applies to a market with no stored user
+     * setting. Absent when the venue publishes no default.
+     */
+    defaultLeverage?: number;
     /**
      * Minimum order notional in USD for this market, as a plain decimal string.
      * Lighter applies it to resting (post-only) orders only. Separate from the

package/dist/types/market.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,kEAAkE;AAClE,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,sFAAsF;AACtF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
+{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../src/market.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,mDAAmD;IACnD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,YAAY,EAAE,OAAO,CAAA;IACrB,sEAAsE;IACtE,wBAAwB,EAAE,wBAAwB,CAAA;IAClD;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,wBAAwB,CAAC,EAAE,KAAK,CAAA;CACjC;AAED,kEAAkE;AAClE,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,UAAU,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,UAAU,EACV,YAAY,GAAG,IAAI,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAC/E,CAAA;AAED,8EAA8E;AAC9E,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,WAAW,EACT,YAAY,GACZ,IAAI,GACJ,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,0BAA0B,CAC7B,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAA;AAER,sFAAsF;AACtF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,0FAA0F;AAC1F,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,IAAI,EAAE,cAAc,EAAE,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,GAAG,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}

package/dist/types/providers.d.ts

@@ -1,5 +1,6 @@
+import type { ActionParamsMap } from './action.js';
 import type { Asset } from './asset.js';
-import type { ActionType, PerpsSigner, SigningMethod } from './enums.js';
+import type { ActionRelay, ActionType, PerpsSigner, SigningMethod } from './enums.js';
 import type { OhlcvInterval } from './market.js';
 /** A fixed option value presented for a provider action parameter. @public */
 export interface ParamOption {
@@ -27,19 +28,20 @@ export interface Param {
     readOnly?: boolean;
 }
 /**
- * A single provider action. The same shape backs `Provider.setup`,
- * `Provider.options`, and `Provider.actions` — categorisation lives in which
- * array it sits in, not in the type. The core three fields are always present;
+ * A single provider action. The same shape backs `Provider.setup` and
+ * `Provider.actions` — categorisation lives in which array it sits in, not in
+ * the type. `type`, `signer`, `signingMethod` and `relay` are always present;
  * the rest are presentation/ordering hints provided per-action in the
  * provider's hardcoded metadata.
  * @public
  */
 export interface ProviderAction {
     type: ActionType;
-    signers: PerpsSigner[];
+    signer: PerpsSigner;
     signingMethod: SigningMethod;
+    relay: ActionRelay;
     /**
-     * Human label. Drives the card heading in the setup/options modals, and may
+     * Human label. Drives the card heading in the setup modal, and may
      * also front an in-flight trading action ("{title} is working…").
      */
     title?: string;
@@ -61,6 +63,47 @@ export interface ProviderAction {
      * nothing, so a consumer tests `=== true` rather than truthiness.
      */
     gatesAccountReads?: boolean;
+    /**
+     * A link to the venue's own documentation for this action, which a UI can
+     * show as a "Documentation" link.
+     */
+    docsUrl?: string;
+}
+/**
+ * One selectable value of a choice setup step, bound to the action that
+ * applies it.
+ *
+ * @public
+ */
+export interface SetupOption<T extends ActionType = ActionType> {
+    /** Display title, e.g. `'Plus'`. */
+    title: string;
+    /**
+     * Option-specific prose a UI shows beside the option in its selector.
+     * `SetupAction.description` stays the general prose for the whole choice.
+     */
+    description?: string;
+    /** The action executed when the option is chosen. */
+    type: T;
+    /** The action's sole param, bound, e.g. `{ tier: 'plus' }`. */
+    params: ActionParamsMap[T];
+    /**
+     * The recommended option a UI pre-selects. The SDK never executes it on its
+     * own; at most one option per step marks it.
+     */
+    default?: true;
+}
+/**
+ * One `Provider.setup` step. A choice step (`options !== null`) declares no
+ * `params`: each option carries its own bound params.
+ *
+ * @public
+ */
+export interface SetupAction extends ProviderAction {
+    /** `null` when the step is not a choice. */
+    options: SetupOption[] | null;
+    /** A `Provider.actions` entry that undoes the satisfied step, or `null`. */
+    revoke: ActionType | null;
 }
 /**
  * Provider-attached advisory shown against a market. Provider-agnostic: the
@@ -111,8 +154,7 @@ export interface Provider {
     signingMethod: SigningMethod;
     /** When false, the provider is announced but not yet selectable in clients. */
     active: boolean;
-    setup: ProviderAction[];
-    options: ProviderAction[];
+    setup: SetupAction[];
     actions: ProviderAction[];
     categories: ProviderCategory[];
     wsUrl?: string;

package/dist/types/providers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;IACrC,yFAAyF;IACzF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,aAAa,CAAA;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,EAAE,gBAAgB,EAAE,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,aAAa,EACd,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;IACrC,yFAAyF;IACzF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,WAAW,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,WAAW,CAAA;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC5D,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,IAAI,EAAE,CAAC,CAAA;IACP,+DAA+D;IAC/D,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,IAAI,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,4CAA4C;IAC5C,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IAC7B,4EAA4E;IAC5E,MAAM,EAAE,UAAU,GAAG,IAAI,CAAA;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,8DAA8D;IAC9D,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,iBAAiB,EAAE,MAAM,CAAA;IACzB,iDAAiD;IACjD,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,aAAa,CAAA;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,WAAW,EAAE,CAAA;IACpB,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,UAAU,EAAE,gBAAgB,EAAE,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oFAAoF;IACpF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}

package/dist/types/referral.d.ts

@@ -196,8 +196,7 @@ export interface OnboardTypedData extends PerpsTypedData {
  * @public
  */
 export interface CreateReferralCodeParams {
-    /** Desired code; omit to let the backend generate one. */
-    code?: string;
+    code: string;
 }
 /**
  * EIP-712 message body for a `CreateReferralCode`. Field order matches

package/dist/types/referral.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../src/referral.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,6DAA6D;IAC7D,SAAS,cAAc;IACvB,uDAAuD;IACvD,SAAS,cAAc;IACvB,uDAAuD;IACvD,QAAQ,aAAa;IACrB,uDAAuD;IACvD,aAAa,kBAAkB;IAC/B,2EAA2E;IAC3E,gBAAgB,qBAAqB;IACrC,2EAA2E;IAC3E,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;IACd,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,qBAAqB,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAA;IACZ,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAA;IACjB,iDAAiD;IACjD,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,oGAAoG;IACpG,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,oBAAoB,CAAA;IACnC,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,oBAAoB,EAAE,4BAA4B,CAAA;IAClD,qFAAqF;IACrF,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,oBAAoB,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAC5B,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,YAAY,EAAE,MAAM,CAAA;IACpB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,kBAAkB,EAO1D,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,WAAW,EAAE,SAAS,CAAA;IACtB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS,kBAAkB,EAAE,CAAA;KACvC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,SAAS,kBAAkB,EAMrE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE,WAAW,EAAE,oBAAoB,CAAA;IACjC,KAAK,EAAE;QACL,kBAAkB,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAClD,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,EAAE,yBAAyB,CAAA;CACnC"}
+{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../src/referral.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExE;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,6DAA6D;IAC7D,SAAS,cAAc;IACvB,uDAAuD;IACvD,SAAS,cAAc;IACvB,uDAAuD;IACvD,QAAQ,aAAa;IACrB,uDAAuD;IACvD,aAAa,kBAAkB;IAC/B,2EAA2E;IAC3E,gBAAgB,qBAAqB;IACrC,2EAA2E;IAC3E,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;IACd,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,qBAAqB,CAAA;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAA;IACZ,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAA;IACjB,iDAAiD;IACjD,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,uFAAuF;IACvF,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,oGAAoG;IACpG,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,oBAAoB,CAAA;IACnC,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,oBAAoB,EAAE,4BAA4B,CAAA;IAClD,qFAAqF;IACrF,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,oBAAoB,EAAE,CAAA;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa;IAC5B,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,YAAY,EAAE,MAAM,CAAA;IACpB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,kBAAkB,EAO1D,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,WAAW,EAAE,SAAS,CAAA;IACtB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS,kBAAkB,EAAE,CAAA;KACvC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,SAAS,kBAAkB,EAMrE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE,WAAW,EAAE,oBAAoB,CAAA;IACjC,KAAK,EAAE;QACL,kBAAkB,EAAE,SAAS,kBAAkB,EAAE,CAAA;KAClD,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;IAC3B,OAAO,EAAE,yBAAyB,CAAA;CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-types",
-  "version": "16.2.0",
+  "version": "18.0.0",
   "description": "Shared types for the LI.FI perps stack",
   "keywords": [
     "lifi",

package/src/account.ts

@@ -141,9 +141,10 @@ export interface Balance {
   /** USD price of one unit. Absent when the provider holds no price for the asset. */
   price?: string
   /**
-   * Part of `units` the venue releases from this category in a category
-   * transfer, as a decimal string from `0` to `units`. Set on each
-   * perps-category collateral row; absent on every other row.
+   * Part of `units` the venue releases from this category, as a decimal
+   * string clamped to `[0, units]`. Every collateral row and every spot row
+   * carries it. It is not the withdrawal ceiling: read
+   * `PerpsClient.getWithdrawableBalances` for that.
    */
   transferable?: string
 }
@@ -213,9 +214,8 @@ export interface AvailableToTrade {
 }
 
 /**
- * The user's complete venue-side settings for one market: the margin mode
- * and display leverage the next order on it will use. A provider returns
- * `undefined` when it cannot read both values.
+ * The user's complete venue-side settings for one perps market: the margin
+ * mode and display leverage the next order on it will use.
  * @public
  */
 export interface MarketSettings {
@@ -609,10 +609,22 @@ export interface LighterAccountConfig {
    */
   accountType: number
   /**
-   * Lighter `available_balance`: venue buying power for the whole account,
-   * already marked to market. A decimal string in quote-asset units.
+   * Lighter `available_balance`: the withdrawable total, already marked to
+   * market. It is not the buying power: it adds each isolated position's
+   * equity above its initial margin requirement and subtracts the shortfall
+   * below it. A decimal string in quote-asset units.
    */
   availableBalance: string
+  /**
+   * Lighter `cross_asset_value`: cross-margin collateral plus the unrealized
+   * PnL of the cross positions. A decimal string in quote-asset units.
+   */
+  crossAssetValue: string
+  /**
+   * Lighter `cross_initial_margin_requirement`: the initial margin the cross
+   * positions lock. A decimal string in quote-asset units.
+   */
+  crossInitialMarginRequirement: string
   /**
    * Lighter `total_asset_value`: perps-route equity, isolated allocations and
    * unrealized PnL included. It excludes the spot-route balances. A decimal
@@ -721,6 +733,9 @@ export interface AccountConfigValue {
 export interface AccountConfigSetting {
   type: ActionType
   values: AccountConfigValue[]
-  /** `undefined` means satisfaction is tracked outside `AccountConfig` (e.g. backend `checkSetup`). */
+  /**
+   * `undefined` means the account state carries no answer, so satisfaction is
+   * decided from staging instead. Every choice setup step carries a boolean.
+   */
   satisfied?: boolean
 }

package/src/action.ts

@@ -305,7 +305,10 @@ export interface PlaceOrderParams {
   size: string
   price?: string
   leverage?: number
-  /** Omitted falls back to the provider's default (currently CROSS). */
+  /**
+   * Hyperliquid: requires `leverage`. Omitted leaves the market's current
+   * margin mode unchanged.
+   */
   marginMode?: MarginMode
   reduceOnly?: boolean
   timeInForce?: TimeInForce
@@ -345,7 +348,7 @@ export interface PlaceTwapOrderParams {
   /** Total execution window in seconds. */
   durationSeconds: number
   reduceOnly?: boolean
-  /** Hyperliquid: randomize sub-order timing within the execution window. */
+  /** Hyperliquid: randomize each sub-order size by up to 20 percent. */
   randomize?: boolean
   /** Ondo: interval between child orders in seconds. */
   frequencySeconds?: number
@@ -401,7 +404,7 @@ export interface ModifyOrderParams {
 export interface UpdateLeverageParams {
   market: MarketRef
   leverage: number
-  /** Omitted falls back to the provider's default (currently CROSS). */
+  /** Hyperliquid: omitted is sent as isolated. */
   marginMode?: MarginMode
 }
 
@@ -429,6 +432,16 @@ export interface UpdateAssetCollateralParams {
   enabled: boolean
 }
 
+/**
+ * Which of a venue's two balance routes a withdrawal is drawn from. Lighter's
+ * own vocabulary, carried in the signed tx as `AssetRouteType` (`perps` = 0,
+ * `spot` = 1); an account's mode changes what the two balances mean, never
+ * which route the tx names.
+ *
+ * @public
+ */
+export type WithdrawalRoute = 'perps' | 'spot'
+
 /**
  * Parameters for withdrawing a decimal-string amount to an EVM address.
  *
@@ -437,6 +450,10 @@ export interface UpdateAssetCollateralParams {
 export interface WithdrawalParams {
   destination: Address
   amount: string
+  /** Lighter: provider-native `Asset.id` to withdraw. Omitted withdraws the quote asset. */
+  assetId?: string
+  /** Lighter: balance route to draw from. Omitted is `perps`. */
+  route?: WithdrawalRoute
   /**
    * The venue-native account identifier, as a string. The provider plugin
    * supplies it; callers omit it. A string because Ondo's 20-digit accountID
@@ -451,7 +468,7 @@ export interface WithdrawalParams {
  * @public
  */
 export interface DepositParams {
-  /** Amount of the token to deposit (human-readable, e.g. "100.5"). */
+  /** Amount of the token to deposit, as an integer string in the token's base units (e.g. "100500000" for 100.5 USDC). */
   amount: string
   /** ERC-20 token address on the source chain. */
   tokenAddress: Address
@@ -471,16 +488,21 @@ export interface ApproveAgentParams {
 }
 
 /**
- * Parameters for deregistering an account agent.
+ * Parameters for deregistering an account agent. The action takes no
+ * parameters: the backend picks the agent to revoke and the user confirms it.
+ *
+ * @public
+ */
+export type RevokeAgentParams = Record<string, never>
+
+/**
+ * Parameters for removing the session agent the SDK signs with, targeted by
+ * address.
  *
  * @public
  */
-export interface RevokeAgentParams {
-  address: Address
-  /** The name the venue holds for the agent. HyperCore identifies a named API
-   * wallet by name, not by address, so a revoke that omits the exact stored
-   * name leaves the slot occupied. */
-  name: string
+export interface RevokeSessionAgentParams {
+  agentAddress: Address
 }
 
 /**
@@ -565,8 +587,11 @@ export interface ApproveReadOnlyTokenParams {
 export interface ActionParamsMap {
   [ActionType.APPROVE_AGENT]: ApproveAgentParams
   [ActionType.REVOKE_AGENT]: RevokeAgentParams
+  [ActionType.REVOKE_SESSION_AGENT]: RevokeSessionAgentParams
   [ActionType.APPROVE_BUILDER_FEE]: Record<string, never>
+  [ActionType.REVOKE_BUILDER_FEE]: Record<string, never>
   [ActionType.APPROVE_INTEGRATOR]: Record<string, never>
+  [ActionType.REVOKE_INTEGRATOR]: Record<string, never>
   [ActionType.SET_REFERRAL]: Record<string, never>
   [ActionType.ACCOUNT_MODE]: AccountModeParams
   [ActionType.ACCOUNT_TYPE]: AccountTypeParams

package/src/enums.ts

@@ -156,8 +156,13 @@ export enum ActionType {
   APPROVE_AGENT = 'approveAgent',
   /** Deregisters an agent (API wallet) to free one of the account's agent slots. HyperCore performs it through the approve-agent typed data with a matching name, so it carries no distinct primary type. */
   REVOKE_AGENT = 'revokeAgent',
+  /** Removes the session agent the SDK signs with, targeted by its `agentAddress`. Signed by the user wallet. */
+  REVOKE_SESSION_AGENT = 'revokeSessionAgent',
   APPROVE_BUILDER_FEE = 'approveBuilderFee',
+  REVOKE_BUILDER_FEE = 'revokeBuilderFee',
   APPROVE_INTEGRATOR = 'approveIntegrator',
+  /** Revokes an integrator fee approval: the approve-integrator transaction with every max fee and the approval expiry set to 0. */
+  REVOKE_INTEGRATOR = 'revokeIntegrator',
   SET_REFERRAL = 'setReferrer',
   ACCOUNT_MODE = 'accountMode',
   ACCOUNT_TYPE = 'accountType',
@@ -189,7 +194,7 @@ export enum ActionType {
   META_ONBOARD = 'metaOnboard',
   /** Provider-independent: reserves the shareable internal referral code an address owns. */
   META_CREATE_REFERRAL_CODE = 'metaCreateReferralCode',
-  /** Never projected on `Provider.setup` or `Provider.options`, and never offered as a user-facing trading action. */
+  /** Never projected on `Provider.setup`, and never offered as a user-facing trading action. */
   SYNC_FEE_ATTRIBUTION = 'syncFeeAttribution',
 }
 
@@ -262,6 +267,20 @@ export enum PerpsSigner {
   SDK = 'SDK',
 }
 
+/**
+ * Where a signed step is submitted. For `EVM_TX`, signing broadcasts each leg
+ * from the user's wallet and the signed step carries `txHash`, which `API`
+ * then acknowledges to `/executeAction`.
+ *
+ * @public
+ */
+export enum ActionRelay {
+  /** Submit the signed step to `POST /executeAction`. */
+  API = 'API',
+  /** The client submits to the venue itself; nothing reaches LI.FI. */
+  CLIENT = 'CLIENT',
+}
+
 /**
  * Signing mechanisms supported by action steps. Values are serialized in
  * provider metadata and action responses.

package/src/market.ts

@@ -60,6 +60,11 @@ export interface BaseMarket {
  */
 export interface PerpsMarket extends BaseMarket {
   maxLeverage: number
+  /**
+   * The display leverage the venue applies to a market with no stored user
+   * setting. Absent when the venue publishes no default.
+   */
+  defaultLeverage?: number
   /**
    * Minimum order notional in USD for this market, as a plain decimal string.
    * Lighter applies it to resting (post-only) orders only. Separate from the

package/src/providers.ts

@@ -1,5 +1,11 @@
+import type { ActionParamsMap } from './action.js'
 import type { Asset } from './asset.js'
-import type { ActionType, PerpsSigner, SigningMethod } from './enums.js'
+import type {
+  ActionRelay,
+  ActionType,
+  PerpsSigner,
+  SigningMethod,
+} from './enums.js'
 import type { OhlcvInterval } from './market.js'
 
 /** A fixed option value presented for a provider action parameter. @public */
@@ -30,19 +36,20 @@ export interface Param {
 }
 
 /**
- * A single provider action. The same shape backs `Provider.setup`,
- * `Provider.options`, and `Provider.actions` — categorisation lives in which
- * array it sits in, not in the type. The core three fields are always present;
+ * A single provider action. The same shape backs `Provider.setup` and
+ * `Provider.actions` — categorisation lives in which array it sits in, not in
+ * the type. `type`, `signer`, `signingMethod` and `relay` are always present;
  * the rest are presentation/ordering hints provided per-action in the
  * provider's hardcoded metadata.
  * @public
  */
 export interface ProviderAction {
   type: ActionType
-  signers: PerpsSigner[]
+  signer: PerpsSigner
   signingMethod: SigningMethod
+  relay: ActionRelay
   /**
-   * Human label. Drives the card heading in the setup/options modals, and may
+   * Human label. Drives the card heading in the setup modal, and may
    * also front an in-flight trading action ("{title} is working…").
    */
   title?: string
@@ -64,6 +71,49 @@ export interface ProviderAction {
    * nothing, so a consumer tests `=== true` rather than truthiness.
    */
   gatesAccountReads?: boolean
+  /**
+   * A link to the venue's own documentation for this action, which a UI can
+   * show as a "Documentation" link.
+   */
+  docsUrl?: string
+}
+
+/**
+ * One selectable value of a choice setup step, bound to the action that
+ * applies it.
+ *
+ * @public
+ */
+export interface SetupOption<T extends ActionType = ActionType> {
+  /** Display title, e.g. `'Plus'`. */
+  title: string
+  /**
+   * Option-specific prose a UI shows beside the option in its selector.
+   * `SetupAction.description` stays the general prose for the whole choice.
+   */
+  description?: string
+  /** The action executed when the option is chosen. */
+  type: T
+  /** The action's sole param, bound, e.g. `{ tier: 'plus' }`. */
+  params: ActionParamsMap[T]
+  /**
+   * The recommended option a UI pre-selects. The SDK never executes it on its
+   * own; at most one option per step marks it.
+   */
+  default?: true
+}
+
+/**
+ * One `Provider.setup` step. A choice step (`options !== null`) declares no
+ * `params`: each option carries its own bound params.
+ *
+ * @public
+ */
+export interface SetupAction extends ProviderAction {
+  /** `null` when the step is not a choice. */
+  options: SetupOption[] | null
+  /** A `Provider.actions` entry that undoes the satisfied step, or `null`. */
+  revoke: ActionType | null
 }
 
 /**
@@ -118,8 +168,7 @@ export interface Provider {
   signingMethod: SigningMethod
   /** When false, the provider is announced but not yet selectable in clients. */
   active: boolean
-  setup: ProviderAction[]
-  options: ProviderAction[]
+  setup: SetupAction[]
   actions: ProviderAction[]
   categories: ProviderCategory[]
   wsUrl?: string

package/src/referral.ts

@@ -217,8 +217,7 @@ export interface OnboardTypedData extends PerpsTypedData {
  * @public
  */
 export interface CreateReferralCodeParams {
-  /** Desired code; omit to let the backend generate one. */
-  code?: string
+  code: string
 }
 
 /**