@lifi/perps-types 0.0.0-preview-f574ca2 → 0.0.0-preview-2ac7198

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -33,9 +33,14 @@ export interface SetupOption<T extends ActionType = ActionType> {
33
33
  params: ActionParamsMap[T];
34
34
  default?: true;
35
35
  }
36
+ export interface SetupAgreement {
37
+ title: string;
38
+ url: string;
39
+ }
36
40
  export interface SetupAction extends ProviderAction {
37
41
  options: SetupOption[] | null;
38
42
  revoke: ActionType | null;
43
+ agreements?: SetupAgreement[];
39
44
  }
40
45
  export interface TradeNotice {
41
46
  level: 'info' | 'warn';
@@ -1 +1 @@
1
- {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,aAAa,EACd,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAOD,MAAM,WAAW,KAAK;IAEpB,IAAI,EAAE,MAAM,CAAA;IAOZ,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;IAErC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAUD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,WAAW,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,WAAW,CAAA;IAKlB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAOhB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAQjB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAK3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAQD,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAE5D,KAAK,EAAE,MAAM,CAAA;IAKb,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,IAAI,EAAE,CAAC,CAAA;IAEP,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IAK1B,OAAO,CAAC,EAAE,IAAI,CAAA;CACf;AAQD,MAAM,WAAW,WAAY,SAAQ,cAAc;IAEjD,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IAE7B,MAAM,EAAE,UAAU,GAAG,IAAI,CAAA;CAC1B;AAOD,MAAM,WAAW,WAAW;IAE1B,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IAEtB,OAAO,EAAE,MAAM,CAAA;CAChB;AAOD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAGD,MAAM,WAAW,eAAe;IAE9B,iBAAiB,EAAE,MAAM,CAAA;IAEzB,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAQD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IAMf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,aAAa,CAAA;IAE5B,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;IAEd,OAAO,CAAC,EAAE,eAAe,CAAA;IAKzB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAK1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAKhB,aAAa,CAAC,EAAE,aAAa,CAAA;IAK7B,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAOhC,sBAAsB,CAAC,EAAE,aAAa,CAAA;IAKtC,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAKhC,aAAa,CAAC,EAAE,aAAa,CAAA;IAK7B,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAMhC,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAGD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
1
+ {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,aAAa,EACd,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAOD,MAAM,WAAW,KAAK;IAEpB,IAAI,EAAE,MAAM,CAAA;IAOZ,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAA;IAErC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAUD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,WAAW,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,WAAW,CAAA;IAKlB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAOhB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAQjB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAK3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAQD,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAE5D,KAAK,EAAE,MAAM,CAAA;IAKb,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,IAAI,EAAE,CAAC,CAAA;IAEP,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IAK1B,OAAO,CAAC,EAAE,IAAI,CAAA;CACf;AAQD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ;AAQD,MAAM,WAAW,WAAY,SAAQ,cAAc;IAEjD,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IAE7B,MAAM,EAAE,UAAU,GAAG,IAAI,CAAA;IAMzB,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;CAC9B;AAOD,MAAM,WAAW,WAAW;IAE1B,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IAEtB,OAAO,EAAE,MAAM,CAAA;CAChB;AAOD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,UAAU,EAAE,KAAK,GAAG,IAAI,CAAA;IACxB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAGD,MAAM,WAAW,eAAe;IAE9B,iBAAiB,EAAE,MAAM,CAAA;IAEzB,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAQD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IAMf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,aAAa,CAAA;IAE5B,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;IAEd,OAAO,CAAC,EAAE,eAAe,CAAA;IAKzB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAK1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAKhB,aAAa,CAAC,EAAE,aAAa,CAAA;IAK7B,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAOhC,sBAAsB,CAAC,EAAE,aAAa,CAAA;IAKtC,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAKhC,aAAa,CAAC,EAAE,aAAa,CAAA;IAK7B,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAMhC,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAGD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
@@ -94,6 +94,16 @@ export interface SetupOption<T extends ActionType = ActionType> {
94
94
  */
95
95
  default?: true;
96
96
  }
97
+ /**
98
+ * A document, such as terms of use or a privacy policy, that the user must
99
+ * accept before a setup step executes.
100
+ *
101
+ * @public
102
+ */
103
+ export interface SetupAgreement {
104
+ title: string;
105
+ url: string;
106
+ }
97
107
  /**
98
108
  * One `Provider.setup` step. A choice step (`options !== null`) declares no
99
109
  * `params`: each option carries its own bound params.
@@ -105,6 +115,12 @@ export interface SetupAction extends ProviderAction {
105
115
  options: SetupOption[] | null;
106
116
  /** A `Provider.actions` entry that undoes the satisfied step, or `null`. */
107
117
  revoke: ActionType | null;
118
+ /**
119
+ * Documents the step asks the user to accept. A UI must show each entry as
120
+ * a link with its own checkbox, and must execute the step only after the
121
+ * user accepts all entries.
122
+ */
123
+ agreements?: SetupAgreement[];
108
124
  }
109
125
  /**
110
126
  * Provider-attached advisory shown against a market. Provider-agnostic: the
@@ -1 +1 @@
1
- {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,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,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,aAAa,CAAA;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
1
+ {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,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,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ;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;IACzB;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;CAC9B;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,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,aAAa,CAAA;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
@@ -94,6 +94,16 @@ export interface SetupOption<T extends ActionType = ActionType> {
94
94
  */
95
95
  default?: true;
96
96
  }
97
+ /**
98
+ * A document, such as terms of use or a privacy policy, that the user must
99
+ * accept before a setup step executes.
100
+ *
101
+ * @public
102
+ */
103
+ export interface SetupAgreement {
104
+ title: string;
105
+ url: string;
106
+ }
97
107
  /**
98
108
  * One `Provider.setup` step. A choice step (`options !== null`) declares no
99
109
  * `params`: each option carries its own bound params.
@@ -105,6 +115,12 @@ export interface SetupAction extends ProviderAction {
105
115
  options: SetupOption[] | null;
106
116
  /** A `Provider.actions` entry that undoes the satisfied step, or `null`. */
107
117
  revoke: ActionType | null;
118
+ /**
119
+ * Documents the step asks the user to accept. A UI must show each entry as
120
+ * a link with its own checkbox, and must execute the step only after the
121
+ * user accepts all entries.
122
+ */
123
+ agreements?: SetupAgreement[];
108
124
  }
109
125
  /**
110
126
  * Provider-attached advisory shown against a market. Provider-agnostic: the
@@ -1 +1 @@
1
- {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,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,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,aAAa,CAAA;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
1
+ {"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,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,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,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;CACZ;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;IACzB;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;CAC9B;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,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,aAAa,CAAA;IACtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;IAChC;;;;OAIG;IACH,kBAAkB,EAAE,aAAa,EAAE,CAAA;CACpC;AAED,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lifi/perps-types",
3
- "version": "0.0.0-preview-f574ca2",
3
+ "version": "0.0.0-preview-2ac7198",
4
4
  "description": "Shared types for the LI.FI perps stack",
5
5
  "keywords": [
6
6
  "lifi",
package/src/providers.ts CHANGED
@@ -104,6 +104,17 @@ export interface SetupOption<T extends ActionType = ActionType> {
104
104
  default?: true
105
105
  }
106
106
 
107
+ /**
108
+ * A document, such as terms of use or a privacy policy, that the user must
109
+ * accept before a setup step executes.
110
+ *
111
+ * @public
112
+ */
113
+ export interface SetupAgreement {
114
+ title: string
115
+ url: string
116
+ }
117
+
107
118
  /**
108
119
  * One `Provider.setup` step. A choice step (`options !== null`) declares no
109
120
  * `params`: each option carries its own bound params.
@@ -115,6 +126,12 @@ export interface SetupAction extends ProviderAction {
115
126
  options: SetupOption[] | null
116
127
  /** A `Provider.actions` entry that undoes the satisfied step, or `null`. */
117
128
  revoke: ActionType | null
129
+ /**
130
+ * Documents the step asks the user to accept. A UI must show each entry as
131
+ * a link with its own checkbox, and must execute the step only after the
132
+ * user accepts all entries.
133
+ */
134
+ agreements?: SetupAgreement[]
118
135
  }
119
136
 
120
137
  /**