@lifi/types 1.24.0 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.
 
+## [2.0.0](https://github.com/lifinance/types/compare/v1.19.0...v2.0.0) (2023-02-13)
+
+
+### Features
+
+* add lif3swap dex on POL and BSC ([#120](https://github.com/lifinance/types/issues/120)) ([b213e28](https://github.com/lifinance/types/commit/b213e281ce777465180b11a0585ad71f98404df7))
+* add opt allowDestCall flag to /routes,/quote ([#122](https://github.com/lifinance/types/issues/122)) ([a899bf2](https://github.com/lifinance/types/commit/a899bf2fee112de6fff002ee0c737f3325f71efa))
+* add types for quests ([#116](https://github.com/lifinance/types/issues/116)) ([ce923d3](https://github.com/lifinance/types/commit/ce923d311ce3921c736ae75e3316fb66415b98b4))
+* add wantInsurance flag to RoutesContext ([#126](https://github.com/lifinance/types/issues/126)) ([cfa6f76](https://github.com/lifinance/types/commit/cfa6f769756be18a821af1e4577c6f28c83db2d3))
+* added flag for variable price impact ([#127](https://github.com/lifinance/types/issues/127)) ([7adf21b](https://github.com/lifinance/types/commit/7adf21baa809c388421b10dad51d18731829372e))
+* added protocol step type + routes can only contain lifi steps ([#130](https://github.com/lifinance/types/issues/130)) ([cedfeec](https://github.com/lifinance/types/commit/cedfeec618b243700bc44e305e29057dceaefc38))
+* insurance option in quoteRequest ([#128](https://github.com/lifinance/types/issues/128)) ([4a9a064](https://github.com/lifinance/types/commit/4a9a064c2c3d92f55d97b700669e2be491e7ab41))
+* make properties of Interface GetStatusRequest optional ([f2be836](https://github.com/lifinance/types/commit/f2be8362c4cad7227dba9ff4d4d9d885b9de4bc5))
+* trusted gas parameter for routes and quote request ([#129](https://github.com/lifinance/types/issues/129)) ([927adaa](https://github.com/lifinance/types/commit/927adaa83129a6422718d65a26f39ae0d4d90dfc))
+
+
+### Bug Fixes
+
+* rename XDAI token to DAI on most chains ([#125](https://github.com/lifinance/types/issues/125)) ([32a17b9](https://github.com/lifinance/types/commit/32a17b93cc9abd2b764bb03e9c7c1a06522bbf36))
+
 ## [1.24.0](https://github.com/lifinance/types/compare/v1.23.0...v1.24.0) (2023-02-09)
 
 

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { TransactionRequest } from '@ethersproject/providers';
-import { BridgeDefinition, Chain, ChainId, ExchangeDefinition, Step, Token } from '.';
+import { BridgeDefinition, Chain, ChainId, ExchangeDefinition, LifiStep, Token } from '.';
 import { ToolError } from './apiErrors';
 export declare const Orders: readonly ["RECOMMENDED", "FASTEST", "CHEAPEST", "SAFEST"];
 export type Order = typeof Orders[number];
@@ -12,6 +12,7 @@ export interface RoutesRequest {
     toTokenAddress: string;
     toAddress?: string;
     options?: RouteOptions;
+    convertAmountToGas?: string;
 }
 export interface RouteOptions {
     order?: Order;
@@ -25,6 +26,7 @@ export interface RouteOptions {
     exchanges?: AllowDenyPrefer;
     fee?: number;
     insurance?: boolean;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export type ToolsResponse = {
     exchanges: {
@@ -64,7 +66,7 @@ export interface Route {
     gasCostUSD?: string;
     containsSwitchChain?: boolean;
     infiniteApproval?: boolean;
-    steps: Step[];
+    steps: LifiStep[];
     tags?: Order[];
 }
 export interface RoutesResponse {
@@ -111,6 +113,8 @@ export interface QuoteRequest extends ToolConfiguration {
     fee?: number | string;
     insurance?: boolean;
     allowDestinationCall?: boolean;
+    convertAmountToGas?: string;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export interface ContractCallQuoteRequest extends ToolConfiguration {
     fromChain: number | string;
@@ -130,6 +134,7 @@ export interface ContractCallQuoteRequest extends ToolConfiguration {
     referrer?: string;
     fee?: number | string;
     allowDestinationCall?: boolean;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export interface ContractCallQuotesRequest extends ToolConfiguration {
     fromChain: number | string;

package/dist/cjs/api.d.ts

@@ -1,5 +1,5 @@
 import { TransactionRequest } from '@ethersproject/providers';
-import { BridgeDefinition, Chain, ChainId, ExchangeDefinition, Step, Token } from '.';
+import { BridgeDefinition, Chain, ChainId, ExchangeDefinition, LifiStep, Token } from '.';
 import { ToolError } from './apiErrors';
 export declare const Orders: readonly ["RECOMMENDED", "FASTEST", "CHEAPEST", "SAFEST"];
 export type Order = typeof Orders[number];
@@ -12,6 +12,7 @@ export interface RoutesRequest {
     toTokenAddress: string;
     toAddress?: string;
     options?: RouteOptions;
+    convertAmountToGas?: string;
 }
 export interface RouteOptions {
     order?: Order;
@@ -25,6 +26,7 @@ export interface RouteOptions {
     exchanges?: AllowDenyPrefer;
     fee?: number;
     insurance?: boolean;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export type ToolsResponse = {
     exchanges: {
@@ -64,7 +66,7 @@ export interface Route {
     gasCostUSD?: string;
     containsSwitchChain?: boolean;
     infiniteApproval?: boolean;
-    steps: Step[];
+    steps: LifiStep[];
     tags?: Order[];
 }
 export interface RoutesResponse {
@@ -111,6 +113,8 @@ export interface QuoteRequest extends ToolConfiguration {
     fee?: number | string;
     insurance?: boolean;
     allowDestinationCall?: boolean;
+    convertAmountToGas?: string;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export interface ContractCallQuoteRequest extends ToolConfiguration {
     fromChain: number | string;
@@ -130,6 +134,7 @@ export interface ContractCallQuoteRequest extends ToolConfiguration {
     referrer?: string;
     fee?: number | string;
     allowDestinationCall?: boolean;
+    hideRoutesWithGTEPriceImpact?: number;
 }
 export interface ContractCallQuotesRequest extends ToolConfiguration {
     fromChain: number | string;

package/dist/cjs/step.d.ts

@@ -74,7 +74,7 @@ export interface Execution {
     gasAmountUSD?: string;
 }
 export declare const emptyExecution: Execution;
-export type StepType = 'swap' | 'cross' | 'lifi' | 'custom';
+export type StepType = 'swap' | 'cross' | 'lifi' | 'custom' | 'protocol';
 export type StepTool = string;
 export interface StepBase {
     id: string;
@@ -99,6 +99,11 @@ export interface CrossStep extends StepBase {
     action: Action;
     estimate: Estimate;
 }
+export interface ProtocolStep extends StepBase {
+    type: 'protocol';
+    action: Action;
+    estimate: Estimate;
+}
 export declare function isCrossStep(step: Step): step is CrossStep;
 export interface LifiStep extends StepBase {
     type: 'lifi';
@@ -119,4 +124,5 @@ export interface CustomStep extends StepBase {
     };
 }
 export declare function isCustomStep(step: Step): step is CustomStep;
-export type Step = SwapStep | CrossStep | LifiStep | CustomStep;
+export declare function isProtocolStep(step: Step): step is ProtocolStep;
+export type Step = SwapStep | CrossStep | LifiStep | CustomStep | ProtocolStep;

package/dist/cjs/step.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCustomStep = exports.isLifiStep = exports.isCrossStep = exports.isSwapStep = exports.emptyExecution = void 0;
+exports.isProtocolStep = exports.isCustomStep = exports.isLifiStep = exports.isCrossStep = exports.isSwapStep = exports.emptyExecution = void 0;
 exports.emptyExecution = {
     status: 'NOT_STARTED',
     process: [],
@@ -21,3 +21,7 @@ function isCustomStep(step) {
     return step.type === 'custom';
 }
 exports.isCustomStep = isCustomStep;
+function isProtocolStep(step) {
+    return step.type === 'protocol';
+}
+exports.isProtocolStep = isProtocolStep;

package/dist/step.d.ts

@@ -74,7 +74,7 @@ export interface Execution {
     gasAmountUSD?: string;
 }
 export declare const emptyExecution: Execution;
-export type StepType = 'swap' | 'cross' | 'lifi' | 'custom';
+export type StepType = 'swap' | 'cross' | 'lifi' | 'custom' | 'protocol';
 export type StepTool = string;
 export interface StepBase {
     id: string;
@@ -99,6 +99,11 @@ export interface CrossStep extends StepBase {
     action: Action;
     estimate: Estimate;
 }
+export interface ProtocolStep extends StepBase {
+    type: 'protocol';
+    action: Action;
+    estimate: Estimate;
+}
 export declare function isCrossStep(step: Step): step is CrossStep;
 export interface LifiStep extends StepBase {
     type: 'lifi';
@@ -119,4 +124,5 @@ export interface CustomStep extends StepBase {
     };
 }
 export declare function isCustomStep(step: Step): step is CustomStep;
-export type Step = SwapStep | CrossStep | LifiStep | CustomStep;
+export declare function isProtocolStep(step: Step): step is ProtocolStep;
+export type Step = SwapStep | CrossStep | LifiStep | CustomStep | ProtocolStep;

package/dist/step.js

@@ -14,3 +14,6 @@ export function isLifiStep(step) {
 export function isCustomStep(step) {
     return step.type === 'custom';
 }
+export function isProtocolStep(step) {
+    return step.type === 'protocol';
+}

package/package.json

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