@lifi/types 11.0.0-beta.1 → 11.0.0-beta.2

package/{dist/cjs → src/_types}/quests.d.ts

@@ -22,3 +22,4 @@ export type GetQuestsStatusResponse = {
 export type GetAllQuestsResponse = {
     quests: BaseQuest[];
 };
+//# sourceMappingURL=quests.d.ts.map

package/src/_types/quests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"quests.d.ts","sourceRoot":"","sources":["../quests.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,SAAS,EAAE,CAAA;CACpB,CAAA"}

package/{dist → src/_types}/step.d.ts

@@ -1,7 +1,5 @@
-import { Substatus, TransactionRequest } from '.';
-import { Token } from './base';
-import { Bridge } from './bridges';
-import { Exchange, ExchangeAggregator } from './exchanges';
+import type { Substatus, TransactionRequest } from './api.js';
+import type { Token } from './tokens/index.js';
 export interface FeeCost {
     name: string;
     description: string;
@@ -68,26 +66,27 @@ export interface Execution {
     fromAmount?: string;
     toAmount?: string;
     toToken?: Token;
-    gasPrice?: string;
-    gasUsed?: string;
-    gasToken?: Token;
-    gasAmount?: string;
-    gasAmountUSD?: string;
+    feeCosts?: FeeCost[];
+    gasCosts?: GasCost[];
 }
 export declare const emptyExecution: Execution;
 export declare const _StepType: readonly ["lifi", "swap", "cross", "protocol", "custom"];
 export type StepType = (typeof _StepType)[number];
 export type StepTool = string;
+export type StepToolDetails = {
+    key: string;
+    name: string;
+    logoURI: string;
+};
 export interface StepBase {
     id: string;
     type: StepType;
     tool: StepTool;
-    toolDetails: Pick<ExchangeAggregator | Exchange | Bridge, 'key' | 'name' | 'logoURI'>;
+    toolDetails: StepToolDetails;
     integrator?: string;
     referrer?: string;
     action: Action;
     estimate?: Estimate;
-    execution?: Execution;
     transactionRequest?: TransactionRequest;
 }
 export interface DestinationCallInfo {
@@ -118,7 +117,7 @@ export interface CustomStep extends StepBase {
     estimate: Estimate;
 }
 export type Step = SwapStep | CrossStep | CustomStep | ProtocolStep;
-export interface LifiStep extends Omit<Step, 'type'> {
+export interface LiFiStep extends Omit<Step, 'type'> {
     type: 'lifi';
     includedSteps: Step[];
 }
@@ -126,3 +125,4 @@ export declare function isSwapStep(step: Step): step is SwapStep;
 export declare function isCrossStep(step: Step): step is CrossStep;
 export declare function isProtocolStep(step: Step): step is ProtocolStep;
 export declare function isCustomStep(step: Step): step is CustomStep;
+//# sourceMappingURL=step.d.ts.map

package/src/_types/step.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step.d.ts","sourceRoot":"","sources":["../step.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE9C,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,CAAA;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,KAAK,CAAA;CACb;AAGD,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,KAAK,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,KAAK,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IAEpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IAEpB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAGD,MAAM,MAAM,MAAM,GACd,aAAa,GACb,SAAS,GACT,iBAAiB,GACjB,uBAAuB,GACvB,SAAS,GACT,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,WAAW,CAAA;AAEf,MAAM,MAAM,WAAW,GACnB,iBAAiB,GACjB,cAAc,GACd,MAAM,GACN,aAAa,GACb,iBAAiB,GACjB,aAAa,CAAA;AAEjB,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;QACrB,OAAO,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IAGD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CACrB;AAED,eAAO,MAAM,cAAc,EAAE,SAG5B,CAAA;AAGD,eAAO,MAAM,SAAS,0DAMZ,CAAA;AACV,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;AACjD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,EAAE,eAAe,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC;AAED,MAAM,WAAW,mBAAmB;IAClC,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,mBAAmB,CAAA;AAErD,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,UAAW,SAAQ,QAAQ;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE,UAAU,CAAA;IAClB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,CAAA;AAEnE,MAAM,WAAW,QAAS,SAAQ,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,IAAI,EAAE,CAAA;CACtB;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,QAAQ,CAEvD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,SAAS,CAEzD;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,YAAY,CAE/D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,UAAU,CAE3D"}

package/src/_types/tokens/base.d.ts

@@ -0,0 +1,59 @@
+export declare enum CoinKey {
+    ETH = "ETH",
+    MATIC = "MATIC",
+    BNB = "BNB",
+    DAI = "DAI",
+    FTM = "FTM",
+    OKT = "OKT",
+    AVAX = "AVAX",
+    HT = "HT",
+    ONE = "ONE",
+    FSN = "FSN",
+    MOVR = "MOVR",
+    EXP = "EXP",
+    TCH = "TCH",
+    UBQ = "UBQ",
+    META = "META",
+    DIODE = "DIODE",
+    CELO = "CELO",
+    FUSE = "FUSE",
+    TLOS = "TLOS",
+    CRO = "CRO",
+    SHIB = "SHIB",
+    L1 = "L1",
+    RBTC = "RBTC",
+    TBG = "TBG",
+    VLX = "VLX",
+    GLMR = "GLMR",
+    METIS = "METIS",
+    SOL = "SOL",
+    EVM = "EVM",
+    USDT = "USDT",
+    USDC = "USDC",
+    cbtUSDC = "cbtUSDC",// cBridge testnet USDC
+    cbtUSDT = "cbtUSDT",// cBridge testnet USDT
+    cbtWUSDT = "cbtWUSDT",// cBridge testnet wrapped USDT
+    cbtWUSDC = "cbtWUSDC",// cBridge testnet wrapped USDC
+    cbtCELR = "cbtCELR",// cBridge testnet CELR
+    BUSD = "BUSD",
+    USDCe = "USDCe",
+    TEST = "TEST",
+    KAL = "KAL",
+    SDIODE = "SDIODE",
+    SPARK = "SPARK",
+    TRBTC = "TRBTC",
+    CXTT = "CXTT",// Connext Test token
+    sgMETIS = "sgMETIS",// sgMETIS test token
+    sgWOO = "sgWOO",// sgWOO test token
+    sgUSDT = "sgUSDT",// sgUSDT test token
+    sgBUSD = "sgBUSD",// sgBUSD test token
+    sgUSDC = "sgUSDC",// sgUSDC test token
+    WBTC = "WBTC",
+    WETH = "WETH",
+    SUSHI = "SUSHI",
+    DODO = "DODO",
+    MCB = "MCB",
+    CELR = "CELR",
+    IF = "IF"
+}
+//# sourceMappingURL=base.d.ts.map

package/src/_types/tokens/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../tokens/base.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,EAAE,OAAO;IACT,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,EAAE,OAAO;IACT,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,GAAG,QAAQ;IAGX,IAAI,SAAS;IACb,IAAI,SAAS;IACb,OAAO,YAAY,CAAE,uBAAuB;IAC5C,OAAO,YAAY,CAAE,uBAAuB;IAC5C,QAAQ,aAAa,CAAE,+BAA+B;IACtD,QAAQ,aAAa,CAAE,+BAA+B;IACtD,OAAO,YAAY,CAAE,uBAAuB;IAC5C,IAAI,SAAS;IACb,KAAK,UAAU;IAGf,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,IAAI,SAAS,CAAE,qBAAqB;IAGpC,OAAO,YAAY,CAAE,qBAAqB;IAC1C,KAAK,UAAU,CAAE,mBAAmB;IACpC,MAAM,WAAW,CAAE,oBAAoB;IACvC,MAAM,WAAW,CAAE,oBAAoB;IACvC,MAAM,WAAW,CAAE,oBAAoB;IAGvC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,EAAE,OAAO;CACV"}

package/src/_types/tokens/index.d.ts

@@ -0,0 +1,3 @@
+export * from './base.js';
+export * from './token.js';
+//# sourceMappingURL=index.d.ts.map

package/src/_types/tokens/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../tokens/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}

package/src/_types/tokens/token.d.ts

@@ -0,0 +1,30 @@
+import { ChainId } from '../chains/base.js';
+import { CoinKey } from './base.js';
+export interface BaseToken {
+    chainId: ChainId;
+    address: string;
+}
+export interface StaticToken extends BaseToken {
+    symbol: string;
+    decimals: number;
+    name: string;
+    coinKey?: CoinKey;
+    logoURI?: string;
+}
+export interface Token extends StaticToken {
+    priceUSD: string;
+}
+export interface TokenAmount extends Token {
+    amount?: bigint;
+    blockNumber?: bigint;
+}
+export interface Coin {
+    key: CoinKey;
+    name: string;
+    logoURI: string;
+    verified: boolean;
+    chains: {
+        [ChainId: string]: StaticToken;
+    };
+}
+//# sourceMappingURL=token.d.ts.map

package/src/_types/tokens/token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../tokens/token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,KAAM,SAAQ,WAAW;IACxC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,WAAY,SAAQ,KAAK;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,IAAI;IACnB,GAAG,EAAE,OAAO,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE;QACN,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAAA;KAC/B,CAAA;CACF"}

package/src/api.ts

@@ -0,0 +1,515 @@
+import type { BridgeDefinition } from './bridges.js'
+import type { Chain, ChainId, ChainKey, ChainType } from './chains/index.js'
+import type { ExchangeDefinition } from './exchanges.js'
+import type { Action, LiFiStep } from './step.js'
+import type { Token } from './tokens/index.js'
+
+/**
+ * Used as a bigint replacement for TransactionRequest because bigint is not serializable
+ */
+export type BigIntish = string
+
+export type TransactionRequest = {
+  to?: string
+  from?: string
+  nonce?: number
+
+  gasLimit?: BigIntish
+  gasPrice?: BigIntish
+
+  data?: string
+  value?: BigIntish
+  chainId?: number
+
+  type?: number
+  accessList?: { address: string; storageKeys: string[] }[]
+
+  maxPriorityFeePerGas?: BigIntish
+  maxFeePerGas?: BigIntish
+
+  customData?: Record<string, any>
+  ccipReadEnabled?: boolean
+}
+
+export const Orders = ['RECOMMENDED', 'FASTEST', 'CHEAPEST', 'SAFEST'] as const
+export type Order = (typeof Orders)[number]
+
+export interface RoutesRequest {
+  fromChainId: number
+  fromAmount: string
+
+  fromTokenAddress: string
+  fromAddress?: string
+
+  toChainId: number
+  toTokenAddress: string
+  toAddress?: string
+
+  options?: RouteOptions
+  fromAmountForGas?: string
+}
+
+export interface RouteOptions {
+  integrator?: string // Should contain the identifier of the integrator. Usually, it's dApp/company name.
+  fee?: number // 0.03 = take 3% integrator fee (requires verified integrator to be set)
+  insurance?: boolean // Whether the user wants to insure their tx
+  maxPriceImpact?: number // Hide routes with price impact greater than or equal to this value
+  order?: Order // (default: RECOMMENDED) 'RECOMMENDED' | 'FASTEST' | 'CHEAPEST' | 'SAFEST'
+  slippage?: number // (default: 0.03) Expressed as decimal proportion, 0.03 represents 3%
+  referrer?: string // Integrators can set a wallet address as a referrer to track them
+  allowSwitchChain?: boolean // (default: false) Whether chain switches should be allowed in the routes
+  allowDestinationCall?: boolean // (default: true) destination calls are enabled by default
+  bridges?: AllowDenyPrefer
+  exchanges?: AllowDenyPrefer
+}
+
+export type ToolsResponse = {
+  exchanges: {
+    key: string
+    name: string
+    logoURI: string
+    supportedChains: ChainId[]
+  }[]
+  bridges: {
+    key: string
+    name: string
+    logoURI: string
+    supportedChains: {
+      fromChainId: ChainId
+      toChainId: ChainId
+    }[]
+  }[]
+}
+
+export interface AllowDenyPrefer {
+  allow?: string[] // (default: [all])
+  deny?: string[] // (default: [])
+  prefer?: string[] // (default: []) // eg. ['1inch'] to use 1inch if available and fall back to others if not
+}
+
+export const _InsuranceState = [
+  'INSURED',
+  'INSURABLE',
+  'NOT_INSURABLE',
+] as const
+export type InsuranceState = (typeof _InsuranceState)[number]
+
+export interface Insurance {
+  state: InsuranceState
+  feeAmountUsd: string
+}
+export interface Route {
+  id: string
+  insurance: Insurance
+  fromChainId: number
+  fromAmountUSD: string
+  fromAmount: string
+  fromToken: Token
+  fromAddress?: string
+
+  toChainId: number
+  toAmountUSD: string
+  toAmount: string
+  toAmountMin: string
+  toToken: Token
+  toAddress?: string
+
+  gasCostUSD?: string // Aggregation of underlying gas costs in usd
+
+  containsSwitchChain?: boolean // Features required for route execution
+
+  steps: LiFiStep[]
+
+  tags?: Order[]
+}
+
+export type ToolErrorType = 'NO_QUOTE'
+
+export interface ToolError {
+  errorType: ToolErrorType
+  code: string
+  action: Action
+  tool: string
+  message: string
+}
+
+export type ErroredPaths = { [subpath: string]: ToolError[] }
+
+export type ErroredRoute = {
+  overallPath: string
+  subpaths: ErroredPaths
+}
+
+export type FilteredResult = {
+  overallPath: string
+  reason: string
+}
+
+export type UnavailableRoutes = {
+  filteredOut: FilteredResult[]
+  failed: ErroredRoute[]
+}
+
+export interface RoutesResponse {
+  routes: Route[]
+  unavailableRoutes: UnavailableRoutes
+}
+
+export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges'
+
+/**
+ * We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
+ * @deprecated
+ */
+export interface PossibilitiesRequest {
+  chains?: number[] // (default: [all]) // eg. [1, 56, 100]
+  bridges?: AllowDenyPrefer
+  exchanges?: AllowDenyPrefer
+  include?: PossibilityTopic[]
+}
+
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
+export interface PossibilitiesResponse {
+  chains?: Chain[]
+  tokens?: Token[]
+  bridges?: BridgeDefinition[]
+  exchanges?: ExchangeDefinition[]
+}
+
+export interface GetTokenRequest {
+  chain: number | string
+  token: string
+}
+
+export interface ToolConfiguration {
+  allowBridges?: string[]
+  denyBridges?: string[]
+  preferBridges?: string[]
+  allowExchanges?: string[]
+  denyExchanges?: string[]
+  preferExchanges?: string[]
+}
+
+export interface QuoteRequest extends ToolConfiguration {
+  fromChain: number | string
+  fromToken: string
+  fromAddress: string
+  fromAmount: string
+
+  toChain: number | string
+  toToken: string
+  toAddress?: string
+
+  order?: Order
+  slippage?: number | string
+  integrator?: string
+  referrer?: string
+  fee?: number | string
+  insurance?: boolean // indicates whether the user wants a quote with bridge insurance
+  allowDestinationCall?: boolean // (default : true) // destination calls are enabled by default
+  fromAmountForGas?: string // the amount of token to convert to gas
+  maxPriceImpact?: number // hide routes with price impact greater than or equal to this value
+}
+
+export interface ContractCall {
+  fromAmount: string
+  fromTokenAddress: string
+  toContractAddress: string
+  toContractCallData: string
+  toContractGasLimit: string
+  toApprovalAddress?: string
+  toTokenAddress?: string
+}
+
+export interface ContractCallsQuoteRequest extends ToolConfiguration {
+  fromChain: number | string
+  fromToken: string
+  fromAddress: string
+
+  toChain: number | string
+  toToken: string
+  toAmount: string
+
+  toFallbackAddress?: string
+  contractOutputsToken?: string
+  contractCalls: ContractCall[]
+
+  slippage?: number | string
+  integrator?: string
+  referrer?: string
+  fee?: number | string
+  allowDestinationCall?: boolean // (default : true) // destination calls are enabled by default
+}
+
+/* @deprecated */
+export interface ContractCallQuoteRequest extends ToolConfiguration {
+  fromChain: number | string
+  fromToken: string
+  fromAddress: string
+  toChain: number | string
+  toToken: string
+  toAmount: string
+  toContractAddress: string
+  toContractCallData: string
+  toContractGasLimit: string
+  toApprovalAddress?: string
+  toFallbackAddress?: string
+  contractOutputsToken?: string
+  slippage?: number | string
+  integrator?: string
+  referrer?: string
+  fee?: number | string
+  allowDestinationCall?: boolean
+}
+
+export interface ConnectionsRequest extends ToolConfiguration {
+  fromChain?: number | string
+  fromToken?: string
+  toChain?: number | string
+  toToken?: string
+  chainTypes?: ChainType[]
+}
+
+export interface Connection {
+  fromChainId: number
+  toChainId: number
+  fromTokens: Token[]
+  toTokens: Token[]
+}
+
+export interface ConnectionsResponse {
+  connections: Connection[]
+}
+
+export interface GetStatusRequest {
+  txHash: string
+  bridge?: string
+  fromChain?: number | string
+  toChain?: number | string
+}
+
+export interface BaseTransactionInfo {
+  txHash: string
+  chainId: ChainId
+  txLink: string
+}
+
+export interface ExtendedTransactionInfo extends BaseTransactionInfo {
+  amount?: string
+  amountUSD?: string
+  token?: Token
+  gasPrice: string
+  gasUsed: string
+  gasToken: Token
+  gasAmount: string
+  gasAmountUSD: string
+  timestamp?: number
+  value?: string
+}
+
+export interface PendingReceivingInfo {
+  chainId: ChainId
+}
+
+const _StatusMessage = [
+  // The transaction was not found -- likely not mined yet
+  'NOT_FOUND',
+  // A third party service is not available
+  'INVALID',
+  // The transfer is pending
+  'PENDING',
+  // The transfer is done
+  'DONE',
+  // The transfer failed
+  'FAILED',
+] as const
+export type StatusMessage = (typeof _StatusMessage)[number]
+
+const _SubstatusPending = [
+  // The bridge is waiting for additional confirmations
+  'WAIT_SOURCE_CONFIRMATIONS',
+  // The off-chain logic is in progress, waiting for the destination tx to be mined
+  'WAIT_DESTINATION_TRANSACTION',
+  // The bridge API / subgraph is temporarily unavailable
+  'BRIDGE_NOT_AVAILABLE',
+  // The RPC for source/destination chain is temporarily unavailable
+  'CHAIN_NOT_AVAILABLE',
+  // The transfer cannot be completed, a refund is required
+  'NOT_PROCESSABLE_REFUND_NEEDED',
+  // A refund has been requested and is in progress
+  'REFUND_IN_PROGRESS',
+  // We cannot determine the status of the transfer
+  'UNKNOWN_ERROR',
+] as const
+export type SubstatusPending = (typeof _SubstatusPending)[number]
+
+const _SubstatusDone = [
+  // The transfer was successful
+  'COMPLETED',
+  // The transfer was partially successful
+  // This can happen for specific bridges like Across
+  // which may provide alternative tokens in case of low liquidity
+  'PARTIAL',
+  // The transfer was not successful but it has been refunded
+  'REFUNDED',
+] as const
+export type SubstatusDone = (typeof _SubstatusDone)[number]
+
+export type Substatus = SubstatusPending | SubstatusDone
+
+export const isSubstatusPending = (
+  substatus: Substatus
+): substatus is SubstatusPending =>
+  _SubstatusPending.includes(substatus as SubstatusPending)
+export const isSubstatusDone = (
+  substatus: Substatus
+): substatus is SubstatusDone =>
+  _SubstatusDone.includes(substatus as SubstatusDone)
+
+export interface BaseStatusData {
+  status: StatusMessage
+  substatus?: Substatus
+  substatusMessage?: string
+}
+
+export interface StatusData extends BaseStatusData {
+  tool: string
+  sending: BaseTransactionInfo
+  receiving: PendingReceivingInfo
+}
+
+export type StatusResponse = FullStatusData | StatusData
+interface TransferMetadata {
+  integrator: string
+}
+
+export interface FullStatusData extends StatusData {
+  transactionId: string
+  sending: ExtendedTransactionInfo
+  receiving: PendingReceivingInfo | ExtendedTransactionInfo
+  lifiExplorerLink: string
+  fromAddress: string
+  toAddress: string
+  metadata: TransferMetadata
+  bridgeExplorerLink?: string
+}
+
+export interface ExtendedChain extends Chain {
+  nativeToken: Token
+}
+
+export interface ChainsResponse {
+  chains: ExtendedChain[]
+}
+
+export interface ChainsRequest {
+  chainTypes?: ChainType[]
+}
+
+export interface ToolsRequest {
+  chains?: (ChainKey | ChainId)[]
+}
+
+export type TokensRequest = {
+  chains?: (ChainId | ChainKey)[]
+  chainTypes?: ChainType[]
+}
+
+export type TokensResponse = {
+  tokens: { [chainId: number]: Token[] }
+}
+
+export type RequestOptions = {
+  signal?: AbortSignal
+}
+
+export interface Integrator {
+  integratorId: string
+  feeBalances: FeeBalance[]
+}
+
+export type FeeBalance = {
+  chainId: ChainId
+  tokenBalances: TokenBalance[]
+}
+
+export type TokenBalance = {
+  token: Token
+  amount: string
+  amountUsd: string
+}
+
+export interface IntegratorWithdrawalRequest {
+  integratorId: string
+  chainId: ChainId
+  tokens?: string[]
+}
+
+export interface IntegratorWithdrawalTransactionResponse {
+  transactionRequest: TransactionRequest
+}
+
+const _LIFuelState = ['PENDING', 'DONE', 'NOT_FOUND'] as const
+type LIFuelState = (typeof _LIFuelState)[number]
+// Response to the status API for trusted gas
+export type LIFuelStatusResponse = {
+  status: LIFuelState
+  sending?: ExtendedTransactionInfo
+  receiving?: PendingReceivingInfo | ExtendedTransactionInfo
+}
+
+export type GasRecommendationRequest = {
+  chainId: ChainId
+  fromChain?: ChainId
+  fromToken?: string
+}
+
+export type RefetchSourceLIFuelRequest = {
+  txHash: string
+  chainId: ChainId
+}
+
+export type LIFuelStatusRequest = {
+  txHash: string
+}
+
+export type RefetchLIFuelRequest = {
+  txHash: string
+  chainId: ChainId
+}
+
+export type GasRecommendationResponse =
+  | {
+      // whether we can support that
+      available: false
+      // reason why the gas feature is not available (e.g. missing liquidity)
+      message: string
+    }
+  | {
+      available: true
+      recommended: TokenBalance
+      limit: TokenBalance // Maximum of gas the user can transfer
+      serviceFee: TokenBalance // LI.FI fee for providing the service
+
+      // information about what the user has to pay to get the recommended gas amount
+      fromToken?: Token
+      fromAmount?: string
+    }
+
+export interface TransactionAnalyticsResponse {
+  transfers: StatusResponse[]
+}
+
+export type TransactionAnalyticsStatus =
+  | Exclude<StatusMessage, 'NOT_FOUND' | 'INVALID'>
+  | 'ALL'
+
+export interface TransactionAnalyticsRequest {
+  wallet: string
+  fromTimestamp?: number
+  toTimestamp?: number
+  status?: TransactionAnalyticsStatus
+}