@lifi/types 5.3.0 → 7.0.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.0.0](https://github.com/lifinance/types/compare/v5.3.0...v7.0.0) (2023-06-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* new types for status endpoint (#166)
+
+### Features
+
+* add vvs finance logo png ([8dd8990](https://github.com/lifinance/types/commit/8dd89901f905768aa12f8bca75ffa4a7e43169c2))
+* error reporting ([#171](https://github.com/lifinance/types/issues/171)) ([97eae77](https://github.com/lifinance/types/commit/97eae7777f0efd0fdbb442f47e0ba6d43d19be4a))
+* new types for status endpoint ([#166](https://github.com/lifinance/types/issues/166)) ([b7262e2](https://github.com/lifinance/types/commit/b7262e2bd531bcfb84fcc756e1cd96ad79a261b9))
+
+## [6.0.0](https://github.com/lifinance/types/compare/v5.3.0...v6.0.0) (2023-05-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* **explainableFailures:** added supporting types
+
+### Features
+
+* error reporting ([8120a4e](https://github.com/lifinance/types/commit/8120a4efe26c19d7fdc95ac9d72b91d1dc988fbc))
+* **explainableFailures:** added supporting types ([50310b9](https://github.com/lifinance/types/commit/50310b93e3f55e3185b7234821fbf19efb5dd8d4))
+
 ## [5.3.0](https://github.com/lifinance/types/compare/v5.2.2...v5.3.0) (2023-05-05)
 
 

package/dist/api.d.ts

@@ -76,9 +76,24 @@ export interface Route {
     steps: LifiStep[];
     tags?: Order[];
 }
+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[];
-    errors: ToolError[];
+    unavailableRoutes: UnavailableRoutes;
 }
 export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges';
 /**
@@ -191,17 +206,24 @@ export interface GetStatusRequest {
     fromChain?: number | string;
     toChain?: number | string;
 }
-export interface TransactionInfo {
+export interface BaseTransactionInfo {
     txHash: string;
-    txLink?: string;
+    chainId: ChainId;
+    txLink: string;
+}
+export interface ExtendedTransactionInfo extends BaseTransactionInfo {
     amount?: string;
+    amountUSD?: string;
     token?: Token;
-    chainId?: ChainId;
-    gasPrice?: string;
-    gasUsed?: string;
-    gasToken?: Token;
-    gasAmount?: string;
-    gasAmountUSD?: string;
+    gasPrice: string;
+    gasUsed: string;
+    gasToken: Token;
+    gasAmount: string;
+    gasAmountUSD: string;
+    timestamp?: number;
+}
+export interface PendingReceivingInfo {
+    chainId: ChainId;
 }
 declare const _StatusMessage: readonly ["NOT_FOUND", "INVALID", "PENDING", "DONE", "FAILED"];
 export type StatusMessage = (typeof _StatusMessage)[number];
@@ -215,15 +237,24 @@ export type Substatus = SubstatusPending | SubstatusDone | SubstatusFailed;
 export declare const isSubstatusPending: (substatus: Substatus) => substatus is "UNKNOWN_ERROR" | "WAIT_SOURCE_CONFIRMATIONS" | "WAIT_DESTINATION_TRANSACTION" | "BRIDGE_NOT_AVAILABLE" | "CHAIN_NOT_AVAILABLE" | "REFUND_IN_PROGRESS";
 export declare const isSubstatusDone: (substatus: Substatus) => substatus is "COMPLETED" | "PARTIAL" | "REFUNDED";
 export declare const isSubstatusFailed: (substatus: Substatus) => substatus is "NOT_PROCESSABLE_REFUND_NEEDED";
-export interface StatusInformation {
+export interface BaseStatusData {
     status: StatusMessage;
     substatus?: Substatus;
     substatusMessage?: string;
 }
-export interface StatusResponse extends StatusInformation {
-    sending: TransactionInfo;
-    receiving?: TransactionInfo;
-    tool?: string;
+export interface StatusData extends BaseStatusData {
+    tool: string;
+    sending: BaseTransactionInfo;
+    receiving: PendingReceivingInfo;
+}
+export type StatusResponse = FullStatusData | StatusData;
+export interface FullStatusData extends StatusData {
+    transactionId: string;
+    sending: ExtendedTransactionInfo;
+    receiving: PendingReceivingInfo | ExtendedTransactionInfo;
+    lifiExplorerLink: string;
+    fromAddress: string;
+    toAddress: string;
     bridgeExplorerLink?: string;
 }
 export interface ExtendedChain extends Chain {
@@ -271,8 +302,8 @@ declare const _LIFuelState: readonly ["PENDING", "DONE", "NOT_FOUND"];
 type LIFuelState = (typeof _LIFuelState)[number];
 export type LIFuelStatusResponse = {
     status: LIFuelState;
-    sending?: TransactionInfo;
-    receiving?: TransactionInfo;
+    sending?: ExtendedTransactionInfo;
+    receiving?: PendingReceivingInfo | ExtendedTransactionInfo;
 };
 export type GasRecommendationRequest = {
     chainId: ChainId;

package/dist/cjs/api.d.ts

@@ -76,9 +76,24 @@ export interface Route {
     steps: LifiStep[];
     tags?: Order[];
 }
+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[];
-    errors: ToolError[];
+    unavailableRoutes: UnavailableRoutes;
 }
 export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges';
 /**
@@ -191,17 +206,24 @@ export interface GetStatusRequest {
     fromChain?: number | string;
     toChain?: number | string;
 }
-export interface TransactionInfo {
+export interface BaseTransactionInfo {
     txHash: string;
-    txLink?: string;
+    chainId: ChainId;
+    txLink: string;
+}
+export interface ExtendedTransactionInfo extends BaseTransactionInfo {
     amount?: string;
+    amountUSD?: string;
     token?: Token;
-    chainId?: ChainId;
-    gasPrice?: string;
-    gasUsed?: string;
-    gasToken?: Token;
-    gasAmount?: string;
-    gasAmountUSD?: string;
+    gasPrice: string;
+    gasUsed: string;
+    gasToken: Token;
+    gasAmount: string;
+    gasAmountUSD: string;
+    timestamp?: number;
+}
+export interface PendingReceivingInfo {
+    chainId: ChainId;
 }
 declare const _StatusMessage: readonly ["NOT_FOUND", "INVALID", "PENDING", "DONE", "FAILED"];
 export type StatusMessage = (typeof _StatusMessage)[number];
@@ -215,15 +237,24 @@ export type Substatus = SubstatusPending | SubstatusDone | SubstatusFailed;
 export declare const isSubstatusPending: (substatus: Substatus) => substatus is "UNKNOWN_ERROR" | "WAIT_SOURCE_CONFIRMATIONS" | "WAIT_DESTINATION_TRANSACTION" | "BRIDGE_NOT_AVAILABLE" | "CHAIN_NOT_AVAILABLE" | "REFUND_IN_PROGRESS";
 export declare const isSubstatusDone: (substatus: Substatus) => substatus is "COMPLETED" | "PARTIAL" | "REFUNDED";
 export declare const isSubstatusFailed: (substatus: Substatus) => substatus is "NOT_PROCESSABLE_REFUND_NEEDED";
-export interface StatusInformation {
+export interface BaseStatusData {
     status: StatusMessage;
     substatus?: Substatus;
     substatusMessage?: string;
 }
-export interface StatusResponse extends StatusInformation {
-    sending: TransactionInfo;
-    receiving?: TransactionInfo;
-    tool?: string;
+export interface StatusData extends BaseStatusData {
+    tool: string;
+    sending: BaseTransactionInfo;
+    receiving: PendingReceivingInfo;
+}
+export type StatusResponse = FullStatusData | StatusData;
+export interface FullStatusData extends StatusData {
+    transactionId: string;
+    sending: ExtendedTransactionInfo;
+    receiving: PendingReceivingInfo | ExtendedTransactionInfo;
+    lifiExplorerLink: string;
+    fromAddress: string;
+    toAddress: string;
     bridgeExplorerLink?: string;
 }
 export interface ExtendedChain extends Chain {
@@ -271,8 +302,8 @@ declare const _LIFuelState: readonly ["PENDING", "DONE", "NOT_FOUND"];
 type LIFuelState = (typeof _LIFuelState)[number];
 export type LIFuelStatusResponse = {
     status: LIFuelState;
-    sending?: TransactionInfo;
-    receiving?: TransactionInfo;
+    sending?: ExtendedTransactionInfo;
+    receiving?: PendingReceivingInfo | ExtendedTransactionInfo;
 };
 export type GasRecommendationRequest = {
     chainId: ChainId;

package/dist/cjs/base.js

@@ -62,7 +62,7 @@ var CoinKey;
     CoinKey["MCB"] = "MCB";
     CoinKey["CELR"] = "CELR";
     CoinKey["IF"] = "IF";
-})(CoinKey = exports.CoinKey || (exports.CoinKey = {}));
+})(CoinKey || (exports.CoinKey = CoinKey = {}));
 var ChainKey;
 (function (ChainKey) {
     ChainKey["ETH"] = "eth";
@@ -124,7 +124,7 @@ var ChainKey;
     ChainKey["MORT"] = "mort";
     ChainKey["FTMT"] = "ftmt";
     ChainKey["LNAT"] = "lnat";
-})(ChainKey = exports.ChainKey || (exports.ChainKey = {}));
+})(ChainKey || (exports.ChainKey = ChainKey = {}));
 var ChainId;
 (function (ChainId) {
     ChainId[ChainId["ETH"] = 1] = "ETH";
@@ -186,4 +186,4 @@ var ChainId;
     ChainId[ChainId["MORT"] = 1287] = "MORT";
     ChainId[ChainId["FTMT"] = 4002] = "FTMT";
     ChainId[ChainId["LNAT"] = 59140] = "LNAT";
-})(ChainId = exports.ChainId || (exports.ChainId = {}));
+})(ChainId || (exports.ChainId = ChainId = {}));

package/dist/cjs/bridges.js

@@ -19,7 +19,7 @@ var BridgeTool;
     BridgeTool["across"] = "across";
     BridgeTool["portal"] = "portal";
     BridgeTool["stargate"] = "stargate";
-})(BridgeTool = exports.BridgeTool || (exports.BridgeTool = {}));
+})(BridgeTool || (exports.BridgeTool = BridgeTool = {}));
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API

package/dist/cjs/chains/Chain.js

@@ -5,4 +5,4 @@ var ChainType;
 (function (ChainType) {
     ChainType["EVM"] = "EVM";
     ChainType["Solana"] = "SOLANA";
-})(ChainType = exports.ChainType || (exports.ChainType = {}));
+})(ChainType || (exports.ChainType = ChainType = {}));

package/dist/cjs/exchanges.js

@@ -13,7 +13,7 @@ var ExchangeTool;
     ExchangeTool["openocean"] = "openocean";
     ExchangeTool["zerox"] = "0x";
     ExchangeTool["dodo"] = "dodo";
-})(ExchangeTool = exports.ExchangeTool || (exports.ExchangeTool = {}));
+})(ExchangeTool || (exports.ExchangeTool = ExchangeTool = {}));
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API

package/dist/cjs/index.d.ts

@@ -5,5 +5,6 @@ export * from './coins';
 export * from './exchanges';
 export * from './step';
 export * from './api';
+export * from './apiErrors';
 export * from './multicall';
 export * from './quests';

package/dist/cjs/index.js

@@ -21,5 +21,6 @@ __exportStar(require("./coins"), exports);
 __exportStar(require("./exchanges"), exports);
 __exportStar(require("./step"), exports);
 __exportStar(require("./api"), exports);
+__exportStar(require("./apiErrors"), exports);
 __exportStar(require("./multicall"), exports);
 __exportStar(require("./quests"), exports);

package/dist/index.d.ts

@@ -5,5 +5,6 @@ export * from './coins';
 export * from './exchanges';
 export * from './step';
 export * from './api';
+export * from './apiErrors';
 export * from './multicall';
 export * from './quests';

package/dist/index.js

@@ -5,5 +5,6 @@ export * from './coins';
 export * from './exchanges';
 export * from './step';
 export * from './api';
+export * from './apiErrors';
 export * from './multicall';
 export * from './quests';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/types",
-  "version": "5.3.0",
+  "version": "7.0.0",
   "description": "Types for the LI.FI stack",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",