@paraswap/dex-lib 2.15.5 → 2.15.7-friendly-local-deadline.0

package/src/dex/shell.ts

@@ -2,9 +2,11 @@ import { Interface, JsonFragment } from '@ethersproject/abi';
 import { SwapSide } from '../constants';
 import { AdapterExchangeParam, Address, SimpleExchangeParam } from '../types';
 import { IDexTxBuilder } from './idex';
-import { SimpleExchange } from './simple-exchange';
+import {
+  getLocalDeadlineAsFriendlyPlaceholder,
+  SimpleExchange,
+} from './simple-exchange';
 import ShellABI from '../abi/Shell.json';
-import Web3 from 'web3';
 import { IDexHelper } from '../dex-helper';
 
 export type ShellData = {
@@ -16,7 +18,7 @@ type ShellParam = [
   _target: string,
   _originAmount: string,
   _minTargetAmount: string,
-  _deadline?: number,
+  _deadline: string,
 ];
 enum ShellFunctions {
   originSwap = 'originSwap',
@@ -63,7 +65,7 @@ export class Shell
       destToken,
       srcAmount,
       destAmount,
-      data.deadline || this.getDeadline(),
+      getLocalDeadlineAsFriendlyPlaceholder(),
     ];
     const swapData = this.exchangeRouterInterface.encodeFunctionData(
       swapFunction,

package/src/dex/simple-exchange.ts

@@ -10,6 +10,18 @@ import { MAX_UINT } from '../constants';
 import Web3 from 'web3';
 import { IDexHelper } from '../dex-helper';
 
+/*
+ * Context: Augustus routers have all a deadline protection logic implemented globally.
+ * But some integrations (router, pools,...) require passing a deadline generally as uint256.
+ * While this problem can be solved in adapters easily by passing block.timestamp (or block.timestamp +1 for some marginal cases),
+ * In the context of direct calls like simpleSwap we have to generate this value offchain.
+ * One can naively pick type(uint).max but that would impose a higher gas cost on the calldata.
+ * Here we decide to go with a high enough default so that the local deadline rarely supersedes the global router deadline.
+ */
+export const FRIENDLY_LOCAL_DEADLINE = 7 * 24 * 60 * 60;
+export const getLocalDeadlineAsFriendlyPlaceholder = () =>
+  String(Math.floor(new Date().getTime() / 1000) + FRIENDLY_LOCAL_DEADLINE);
+
 export class SimpleExchange {
   simpleSwapHelper: Interface;
   protected abiCoder: AbiCoder;
@@ -122,8 +134,4 @@ export class SimpleExchange {
       networkFee,
     };
   }
-
-  getDeadline() {
-    return Math.floor(new Date().getTime() / 1000) + 60 * 60;
-  }
 }

package/src/dex/trader-joe-v2.ts

@@ -2,7 +2,10 @@ import { Network, SwapSide } from '../constants';
 import { AdapterExchangeParam, Address, SimpleExchangeParam } from '../types';
 import { IDexTxBuilder } from './idex';
 import { IDexHelper } from '../dex-helper';
-import { SimpleExchange } from './simple-exchange';
+import {
+  getLocalDeadlineAsFriendlyPlaceholder,
+  SimpleExchange,
+} from './simple-exchange';
 import { NumberAsString } from '@paraswap/core';
 import { AsyncOrSync } from 'ts-essentials';
 import { Interface, JsonFragment } from '@ethersproject/abi';
@@ -29,7 +32,7 @@ type TraderJoeV2RouterBuyParams = [
   _pairBinSteps: NumberAsString[],
   _tokenPath: Address[],
   to: Address,
-  _deadline: number,
+  _deadline: string,
 ];
 
 type TraderJoeV2RouterParam =
@@ -37,7 +40,6 @@ type TraderJoeV2RouterParam =
   | TraderJoeV2RouterBuyParams;
 
 export type TraderJoeV2Data = {
-  deadline?: number;
   tokenIn: string; // redundant
   tokenOut: string; // redundant
   binStep: string;
@@ -87,7 +89,7 @@ export class TraderJoeV2
       {
         _pairBinSteps: [data.binStep],
         _tokenPath: [data.tokenIn, data.tokenOut], // FIXME: redundant, shoot & read from contract
-        _deadline: data.deadline || this.getDeadline(),
+        _deadline: getLocalDeadlineAsFriendlyPlaceholder(), // FIXME: more gas efficient to pass block.timestamp in adapter
       },
     );
 
@@ -119,7 +121,7 @@ export class TraderJoeV2
             [data.binStep],
             [srcToken, destToken],
             this.augustusAddress,
-            data.deadline || this.getDeadline(),
+            getLocalDeadlineAsFriendlyPlaceholder(),
           ]
         : [
             destAmount,
@@ -127,7 +129,7 @@ export class TraderJoeV2
             [data.binStep],
             [srcToken, destToken],
             this.augustusAddress,
-            data.deadline || this.getDeadline(),
+            getLocalDeadlineAsFriendlyPlaceholder(),
           ];
     const swapData = this.exchangeRouterInterface.encodeFunctionData(
       swapFunction,

package/src/dex/uniswap-v3/types.ts

@@ -72,7 +72,7 @@ export type DexParams = {
 export type UniswapV3SellParam = {
   path: string;
   recipient: Address;
-  deadline: number;
+  deadline: string;
   amountIn: NumberAsString;
   amountOutMinimum: NumberAsString;
 };
@@ -80,7 +80,7 @@ export type UniswapV3SellParam = {
 export type UniswapV3BuyParam = {
   path: string;
   recipient: Address;
-  deadline: number;
+  deadline: string;
   amountOut: NumberAsString;
   amountInMaximum: NumberAsString;
 };

package/src/dex/uniswap-v3/uniswap-v3.ts

@@ -30,7 +30,10 @@ import {
   UniswapV3Functions,
   UniswapV3Param,
 } from './types';
-import { SimpleExchange } from '../simple-exchange';
+import {
+  getLocalDeadlineAsFriendlyPlaceholder,
+  SimpleExchange,
+} from '../simple-exchange';
 import { UniswapV3Config, Adapters, PoolsToPreload } from './config';
 import { UniswapV3EventPool } from './uniswap-v3-pool';
 import UniswapV3RouterABI from '../../abi/uniswap-v3/UniswapV3Router.abi.json';
@@ -686,7 +689,7 @@ export class UniswapV3
       },
       {
         path,
-        deadline: this.getDeadline(),
+        deadline: getLocalDeadlineAsFriendlyPlaceholder(), // FIXME: more gas efficient to pass block.timestamp in adapter
       },
     );
 
@@ -740,14 +743,14 @@ export class UniswapV3
       side === SwapSide.SELL
         ? {
             recipient: this.augustusAddress,
-            deadline: this.getDeadline(),
+            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
             amountIn: srcAmount,
             amountOutMinimum: destAmount,
             path,
           }
         : {
             recipient: this.augustusAddress,
-            deadline: this.getDeadline(),
+            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
             amountOut: destAmount,
             amountInMaximum: srcAmount,
             path,

package/src/dex/uniswap-v3.ts

@@ -3,7 +3,10 @@ import { pack } from '@ethersproject/solidity';
 import { Network, SwapSide } from '../constants';
 import { AdapterExchangeParam, Address, SimpleExchangeParam } from '../types';
 import { IDexTxBuilder } from './idex';
-import { SimpleExchange } from './simple-exchange';
+import {
+  getLocalDeadlineAsFriendlyPlaceholder,
+  SimpleExchange,
+} from './simple-exchange';
 import UniswapV3RouterABI from '../abi/UniswapV3Router.json';
 import { NumberAsString } from '@paraswap/core';
 import { IDexHelper } from '../dex-helper';
@@ -17,7 +20,6 @@ const UNISWAP_V3_ROUTER_ADDRESSES: { [network: number]: Address } = {
 
 export type UniswapV3Data = {
   // ExactInputSingleParams
-  deadline?: number;
   path: {
     tokenIn: Address;
     tokenOut: Address;
@@ -28,7 +30,7 @@ export type UniswapV3Data = {
 type UniswapV3SellParam = {
   path: string;
   recipient: Address;
-  deadline: number;
+  deadline: string;
   amountIn: NumberAsString;
   amountOutMinimum: NumberAsString;
 };
@@ -36,7 +38,7 @@ type UniswapV3SellParam = {
 type UniswapV3BuyParam = {
   path: string;
   recipient: Address;
-  deadline: number;
+  deadline: string;
   amountOut: NumberAsString;
   amountInMaximum: NumberAsString;
 };
@@ -112,7 +114,7 @@ export class UniswapV3
     data: UniswapV3Data,
     side: SwapSide,
   ): AdapterExchangeParam {
-    const { deadline, path: rawPath } = data;
+    const { path: rawPath } = data;
     const path = this.encodePath(rawPath, side);
     const payload = this.abiCoder.encodeParameter(
       {
@@ -123,14 +125,14 @@ export class UniswapV3
       },
       {
         path,
-        deadline: deadline || this.getDeadline(),
+        deadline: getLocalDeadlineAsFriendlyPlaceholder(), // FIXME: more gas efficient to pass block.timestamp in adapter
       },
     );
 
     return {
       targetExchange: this.routerAddress,
       payload,
-      networkFee: '0', // warning
+      networkFee: '0',
     };
   }
 
@@ -151,14 +153,14 @@ export class UniswapV3
       side === SwapSide.SELL
         ? {
             recipient: this.augustusAddress,
-            deadline: data.deadline || this.getDeadline(),
+            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
             amountIn: srcAmount,
             amountOutMinimum: destAmount,
             path,
           }
         : {
             recipient: this.augustusAddress,
-            deadline: data.deadline || this.getDeadline(),
+            deadline: getLocalDeadlineAsFriendlyPlaceholder(),
             amountOut: destAmount,
             amountInMaximum: srcAmount,
             path,

package/src/transaction-builder.ts

@@ -2,6 +2,10 @@ import { OptimalRate, Address, Adapters } from './types';
 import { ETHER_ADDRESS, SwapSide } from './constants';
 import { RouterService } from './router';
 import { DexAdapterService } from './dex';
+import {
+  FRIENDLY_LOCAL_DEADLINE,
+  getLocalDeadlineAsFriendlyPlaceholder,
+} from './dex/simple-exchange';
 
 export class TransactionBuilder {
   routerService: RouterService;
@@ -43,6 +47,14 @@ export class TransactionBuilder {
     beneficiary?: Address;
     onlyParams?: boolean;
   }) {
+    const globalDeadline = +deadline;
+    if (isNaN(globalDeadline)) throw new Error('deadline should be a number');
+    const localDeadline = +getLocalDeadlineAsFriendlyPlaceholder();
+    if (globalDeadline > localDeadline)
+      throw new Error(
+        `Deadline is too high. Maximum allowed is ${FRIENDLY_LOCAL_DEADLINE} seconds`,
+      );
+
     const _beneficiary = beneficiary || userAddress;
     const { encoder, params, networkFee } = await this.routerService
       .getRouterByContractMethod(priceRoute.contractMethod)