@lifi/perps-types 16.1.0 → 17.0.0

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