@lifi/types 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+## [1.2.0](https://github.com/lifinance/types/compare/v1.1.1...v1.2.0) (2022-07-21)
+
+
+### Features
+
+* add custom step and contract call endpoints ([#85](https://github.com/lifinance/types/issues/85)) ([bd49fae](https://github.com/lifinance/types/commit/bd49faefc924d7a06818ab6cb3589db633c58e9c))
+
 ### [1.1.1](https://github.com/lifinance/types/compare/v1.1.0...v1.1.1) (2022-07-21)
 
 

package/dist/api.d.ts

@@ -69,7 +69,7 @@ export interface GetTokenRequest {
     chain: number | string;
     token: string;
 }
-interface ToolConfiguration {
+export interface ToolConfiguration {
     allowBridges?: string[];
     denyBridges?: string[];
     preferBridges?: string[];
@@ -90,6 +90,43 @@ export interface QuoteRequest extends ToolConfiguration {
     integrator?: string;
     referrer?: string;
 }
+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;
+}
+export interface ContractCallQuotesRequest extends ToolConfiguration {
+    fromChain: number | string;
+    fromToken: string;
+    fromAddress: string;
+    toChain: number | string;
+    toFallbackAddress?: string;
+    toContractCalls: {
+        sendingAmount: string;
+        sendingToken: string;
+        receivingToken: string;
+        contractAddress: string;
+        approvalAddress?: string;
+        callData: string;
+        gasLimit: string;
+    }[];
+    order?: Order;
+    slippage?: number | string;
+    integrator?: string;
+    referrer?: string;
+}
 export interface ConnectionsRequest extends ToolConfiguration {
     fromChain?: number | string;
     fromToken?: string;
@@ -168,6 +205,8 @@ export declare class LifiAPI {
     getToken(request: GetTokenRequest): Promise<Token>;
     getTokens(request: TokensRequest): Promise<TokensResponse>;
     getQuote(request: QuoteRequest): Promise<Step>;
+    getContractCallQuote(request: ContractCallQuoteRequest): Promise<Step>;
+    getContractCallQuotes(request: ContractCallQuotesRequest): Promise<Step>;
     getStatus(request: GetStatusRequest): Promise<StatusResponse>;
     getTools(request: ToolsRequest): Promise<ToolsResponse>;
     getChains(): ChainsResponse;

package/dist/step.d.ts

@@ -67,7 +67,7 @@ export interface Execution {
     toToken?: Token;
 }
 export declare const emptyExecution: Execution;
-export declare type StepType = 'swap' | 'cross' | 'lifi';
+export declare type StepType = 'swap' | 'cross' | 'lifi' | 'custom';
 export declare type StepTool = string;
 export interface StepBase {
     id: string;
@@ -100,4 +100,16 @@ export interface LifiStep extends StepBase {
     includedSteps: Step[];
 }
 export declare function isLifiStep(step: Step): step is LifiStep;
-export declare type Step = SwapStep | CrossStep | LifiStep;
+export interface CustomStep extends StepBase {
+    type: 'custom';
+    action: Action;
+    estimate: Estimate;
+    destinationCallInfo: {
+        toContractAddress: string;
+        toContractCallData: string;
+        toFallbackAddress: string;
+        callDataGasLimit: string;
+    };
+}
+export declare function isCustomStep(step: Step): step is CustomStep;
+export declare type Step = SwapStep | CrossStep | LifiStep | CustomStep;

package/dist/step.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/types",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Types for the LI.FI stack",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",