feat: add requests cancellation (#67)

Author: chybisov

package.json

@@ -51,7 +51,7 @@
   "dependencies": {
     "@ethersproject/abi": "^5.6.1",
     "@ethersproject/contracts": "^5.4.0",
-    "@lifinance/types": "^0.13.1",
+    "@lifinance/types": "^0.14.0",
     "axios": "^0.27.2",
     "bignumber.js": "^9.0.1",
     "eth-rpc-errors": "^4.0.3",

src/services/ApiService.ts

@@ -1,5 +1,10 @@
-import { QuoteRequest, TokensRequest, TokensResponse } from '@lifinance/types'
-import { GetStatusRequest } from '@lifinance/types/dist/api'
+import {
+  GetStatusRequest,
+  QuoteRequest,
+  RequestOptions,
+  TokensRequest,
+  TokensResponse,
+} from '@lifinance/types'
 import axios from 'axios'
 import { isRoutesRequest, isStep } from '../typeguards'
 import {
@@ -22,7 +27,8 @@ import { parseBackendError } from '../utils/parseError'
 import ConfigService from './ConfigService'
 
 const getPossibilities = async (
-  request?: PossibilitiesRequest
+  request?: PossibilitiesRequest,
+  options?: RequestOptions
 ): Promise<PossibilitiesResponse> => {
   if (!request) {
     request = {}
@@ -39,7 +45,10 @@ const getPossibilities = async (
   try {
     const result = await axios.post<PossibilitiesResponse>(
       config.apiUrl + 'advanced/possibilities',
-      request
+      request,
+      {
+        signal: options?.signal,
+      }
     )
     return result.data
   } catch (e) {
@@ -49,7 +58,8 @@ const getPossibilities = async (
 
 const getToken = async (
   chain: ChainKey | ChainId,
-  token: string
+  token: string,
+  options?: RequestOptions
 ): Promise<Token> => {
   if (!chain) {
     throw new ValidationError('Required parameter "chain" is missing.')
@@ -67,31 +77,35 @@ const getToken = async (
         chain,
         token,
       },
+      signal: options?.signal,
     })
     return result.data
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
-const getQuote = async ({
-  fromChain,
-  fromToken,
-  fromAddress,
-  fromAmount,
-  toChain,
-  toToken,
-  order,
-  slippage,
-  integrator,
-  referrer,
-  allowBridges,
-  denyBridges,
-  preferBridges,
-  allowExchanges,
-  denyExchanges,
-  preferExchanges,
-}: QuoteRequest): Promise<Step> => {
+const getQuote = async (
+  {
+    fromChain,
+    fromToken,
+    fromAddress,
+    fromAmount,
+    toChain,
+    toToken,
+    order,
+    slippage,
+    integrator,
+    referrer,
+    allowBridges,
+    denyBridges,
+    preferBridges,
+    allowExchanges,
+    denyExchanges,
+    preferExchanges,
+  }: QuoteRequest,
+  options?: RequestOptions
+): Promise<Step> => {
   if (!fromChain) {
     throw new ValidationError('Required parameter "fromChain" is missing.')
   }
@@ -133,19 +147,18 @@ const getQuote = async ({
         denyExchanges,
         preferExchanges,
       },
+      signal: options?.signal,
     })
     return result.data
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
-const getStatus = async ({
-  bridge,
-  fromChain,
-  toChain,
-  txHash,
-}: GetStatusRequest): Promise<StatusResponse> => {
+const getStatus = async (
+  { bridge, fromChain, toChain, txHash }: GetStatusRequest,
+  options?: RequestOptions
+): Promise<StatusResponse> => {
   if (fromChain !== toChain && !bridge) {
     throw new ValidationError(
       'Parameter "bridge" is required for cross chain transfers.'
@@ -174,54 +187,64 @@ const getStatus = async ({
         toChain,
         txHash,
       },
+      signal: options?.signal,
     })
     return result.data
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
-const getChains = async (): Promise<Chain[]> => {
+const getChains = async (options?: RequestOptions): Promise<Chain[]> => {
   const configService = ConfigService.getInstance()
   const config = configService.getConfig()
 
   try {
-    const result = await axios.get<ChainsResponse>(config.apiUrl + 'chains')
+    const result = await axios.get<ChainsResponse>(config.apiUrl + 'chains', {
+      signal: options?.signal,
+    })
     return result.data.chains
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
 const getRoutes = async (
-  routesRequest: RoutesRequest
+  request: RoutesRequest,
+  options?: RequestOptions
 ): Promise<RoutesResponse> => {
-  if (!isRoutesRequest(routesRequest)) {
+  if (!isRoutesRequest(request)) {
     throw new ValidationError('Invalid routes request.')
   }
 
   const configService = ConfigService.getInstance()
   const config = configService.getConfig()
 
   // apply defaults
-  routesRequest.options = {
+  request.options = {
     ...config.defaultRouteOptions,
-    ...routesRequest.options,
+    ...request.options,
   }
 
   // send request
   try {
     const result = await axios.post<RoutesResponse>(
       config.apiUrl + 'advanced/routes',
-      routesRequest
+      request,
+      {
+        signal: options?.signal,
+      }
     )
     return result.data
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
-const getStepTransaction = async (step: Step): Promise<Step> => {
+const getStepTransaction = async (
+  step: Step,
+  options?: RequestOptions
+): Promise<Step> => {
   if (!isStep(step)) {
     // While the validation fails for some users we should not enforce it
     // eslint-disable-next-line no-console
@@ -233,28 +256,39 @@ const getStepTransaction = async (step: Step): Promise<Step> => {
   try {
     const result = await axios.post<Step>(
       config.apiUrl + 'advanced/stepTransaction',
-      step
+      step,
+      {
+        signal: options?.signal,
+      }
     )
     return result.data
   } catch (e) {
     throw parseBackendError(e)
   }
 }
 
-const getTools = async (request?: ToolsRequest): Promise<ToolsResponse> => {
+const getTools = async (
+  request?: ToolsRequest,
+  options?: RequestOptions
+): Promise<ToolsResponse> => {
   const configService = ConfigService.getInstance()
   const config = configService.getConfig()
   const r = await axios.get<ToolsResponse>(config.apiUrl + 'tools', {
     params: request,
+    signal: options?.signal,
   })
   return r.data
 }
 
-const getTokens = async (request?: TokensRequest): Promise<TokensResponse> => {
+const getTokens = async (
+  request?: TokensRequest,
+  options?: RequestOptions
+): Promise<TokensResponse> => {
   const configService = ConfigService.getInstance()
   const config = configService.getConfig()
   const r = await axios.get<TokensResponse>(config.apiUrl + 'tokens', {
     params: request,
+    signal: options?.signal,
   })
   return r.data
 }

yarn.lock

@@ -1068,12 +1068,12 @@
     "@jridgewell/resolve-uri" "^3.0.3"
     "@jridgewell/sourcemap-codec" "^1.4.10"
 
-"@lifinance/types@^0.13.1":
-  version "0.13.1"
-  resolved "https://registry.yarnpkg.com/@lifinance/types/-/types-0.13.1.tgz#31aede31c4fad530c42a7891e33dc4357319ab19"
-  integrity sha512-cC8GzTHPnQwjAuv5wHPESRz+F8qt67HKifSSNACfemPbCEezErlYhEkyArKYTtZzr3zgsOWx7crGCis/h/w1bQ==
+"@lifinance/types@^0.14.0":
+  version "0.14.0"
+  resolved "https://registry.yarnpkg.com/@lifinance/types/-/types-0.14.0.tgz#0f900712574ea5218218a1948893010009636428"
+  integrity sha512-bsd/V/O+is0wHVw8N0dTlnJawXPRU5nUOpJQXQnQvuoYzOl1sXTL++HZZvP69TjeM6D+AelXbYBJ84aJclPyCw==
   dependencies:
-    ethers "^5.4.7"
+    ethers "^5.6.5"
 
 "@nodelib/[email protected]":
   version "2.1.5"
@@ -2690,7 +2690,7 @@ eth-rpc-errors@^4.0.3:
   dependencies:
     fast-safe-stringify "^2.0.6"
 
-ethers@^5.4.7, ethers@^5.6.5:
+ethers@^5.6.5:
   version "5.6.5"
   resolved "https://registry.yarnpkg.com/ethers/-/ethers-5.6.5.tgz#3185ac7815dc640993408adf6f133ffabfbcbb63"
   integrity sha512-9CTmplO9bv0s/aPw3HB3txGzKz3tUSI2EfO4dJo0W2WvaEq1ArgsEX6obV+bj5X3yY+Zgb1kAux8TDtJKe1FaA==