Feat/689 analyze route (#102)

* add new action type and LP provider details * add/fix encoding types (#101) * feat: improve path finder request type (#99) * added chainflip types (#100) * added chainflip types * bump version * bump version * add/fix encoding types * increase version number --------- Co-authored-by: J <[email protected]> Co-authored-by: nnoln <[email protected]> Co-authored-by: Anthony Lau <[email protected]> --------- Co-authored-by: corysquid <[email protected]> Co-authored-by: J <[email protected]> Co-authored-by: nnoln <[email protected]>
0xsquid · Aug 7, 2024 · 1ce967e · 1ce967e
1 parent 7204644
commit 1ce967e
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@0xsquid/squid-types",
-  "version": "0.1.95",
+  "version": "0.1.96",
   "description": "JS and TS types relating to 0xsquid related projects.",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",

diff --git a/src/bridges/index.ts b/src/bridges/index.ts
@@ -5,6 +5,7 @@ export enum BridgeType {
   NOBLE_CCTP = "noble-cctp",
   IBC = "ibc",
   CHAINFLIP = "chainflip",
+  RFQ = "rfq",
 }
 
 export enum BridgeProvider {
@@ -14,6 +15,7 @@ export enum BridgeProvider {
   IBC = "IBC",
   PFM = "IBC Packet forward middleware",
   CHAINFLIP = "Chainflip",
+  RFQ = "RFQ",
 }
 
 export type BridgeConfig = Record<string, string>;
diff --git a/src/path/index.ts b/src/path/index.ts
@@ -65,6 +65,7 @@ export interface ActionBaseData {
   // bridges
   name: string;
   provider: string;
+  liquidityProvider: string;
 }
 
 export interface PathAction {

diff --git a/src/quote/index.ts b/src/quote/index.ts
@@ -6,6 +6,7 @@ import {
   PathAction,
   WrapDetails,
   FeeDetails,
+  LiquidityProviderDetails,
 } from "../index";
 
 export interface Quote {
@@ -29,5 +30,5 @@ export interface QuoteAction extends Omit<PathAction, "data"> {
   exchangeRate: string;
   priceImpact: string;
   stage?: ActionStage;
-  data: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails | FeeDetails;
+  data: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails | FeeDetails | LiquidityProviderDetails;
 }
diff --git a/src/routes/index.ts b/src/routes/index.ts
@@ -80,15 +80,27 @@ export interface Route {
 export interface RouteActionResponse extends Omit<RouteAction, "fromChain" | "toChain" | "data"> {
   fromChain: string;
   toChain: string;
-  data: _SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails;
+  data:
+    | _SwapDetails
+    | WrapDetails
+    | BridgeDetails
+    | CustomCallDetails
+    | FeeDetails
+    | LiquidityProviderDetails;
 }
 
 export interface RouteAction extends QuoteAction {
   provider?: string;
   description?: string;
   logoURI?: string;
   estimatedDuration?: number;
-  data: SwapDetails | WrapDetails | BridgeDetails | CustomCallDetails | FeeDetails;
+  data:
+    | SwapDetails
+    | WrapDetails
+    | BridgeDetails
+    | CustomCallDetails
+    | FeeDetails
+    | LiquidityProviderDetails;
 }
 
 export enum ActionType {
@@ -98,6 +110,7 @@ export enum ActionType {
   IBC_TRANSFER = "ibc-transfer",
   CUSTOM = "custom",
   FEE = "fee",
+  RFQ = "rfq",
 }
 
 export interface WrapDetails {
@@ -158,6 +171,16 @@ export interface CustomCallDetails {
   calls: ChainCall[];
 }
 
+export interface LiquidityProviderDetails {
+  liquidityProvider: string;
+  target: string;
+  provider: string;
+  type: BridgeType;
+  name: string;
+  logoURI?: string;
+  calls?: ChainCall[];
+}
+
 export interface Integrator {
   id: string;
   enabled: boolean;

diff --git a/src/squid/index.ts b/src/squid/index.ts
@@ -8,6 +8,8 @@ export enum SquidRouteType {
   BRIDGE = "BRIDGE",
   EVM_ONLY = "EVM_ONLY",
   COSMOS_ONLY = "COSMOS_ONLY",
+  RFQ = "RFQ",
+  FUND_AND_RUN_MULTICALL = "FUND_AND_RUN_MULTICALL",
 }
 
 export interface SquidData {