Merge pull request #169 from paraswap/feat/ignoreBadUsdPrice

Feat/RateOptions.ignoreBadUsdPrice param
paraswap · Oct 23, 2024 · b065ca0 · b065ca0
2 parents 84d9f66 + aebaff8
commit b065ca0
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ There are multiple ways to use ParaSwap SDK, ranging from a simple construct-and
 
 ### Simple SDK
 
-Can be created by providing `chainId` and either `axios` or `window.fetch` (or alternative `fetch` implementation), and an optional `version` (`'5'` or `'6.2'`) parameter that corresponds to the API version SDK will be making requests to. The resulting SDK will be able to use all methods that query the API.
+Can be created by providing `chainId` and either `axios` or `window.fetch` (or alternative `fetch` implementation), and an optional `version` (`'5'` or `'6.1'`) parameter that corresponds to the API version SDK will be making requests to. The resulting SDK will be able to use all methods that query the API.
 
 ```ts
   import { constructSimpleSDK } from '@paraswap/sdk';

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@paraswap/sdk",
-  "version": "6.10.0",
+  "version": "6.11.0",
   "main": "dist/index.js",
   "module": "dist/sdk.esm.js",
   "typings": "dist/index.d.ts",
@@ -81,7 +81,7 @@
     }
   },
   "dependencies": {
-    "@paraswap/core": "2.2.0",
+    "@paraswap/core": "2.4.0",
     "bignumber.js": "^9.0.2",
     "ts-essentials": "^9.1.2"
   },

diff --git a/src/methods/swap/rates.ts b/src/methods/swap/rates.ts
@@ -148,6 +148,7 @@ export type RateOptions = {
   excludeContractMethods?: ContractMethod[];
   includeContractMethods?: ContractMethod[];
   partner?: string;
+  /** @description In %. It's a way to bypass the API price impact check (default = 15%) */
   maxImpact?: number;
   maxUSDImpact?: number;
   otherExchangePrices?: boolean;

diff --git a/yarn.lock b/yarn.lock
@@ -1571,10 +1571,10 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
-"@paraswap/core@2.2.0":
-  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/@paraswap/core/-/core-2.2.0.tgz#848175c7729f1064e715019269b1c193a23a5be8"
-  integrity sha512-aENl5zjS0y4ag7PLEq/hHgaAH4XpN5M4Zc7Igt/03D+W6t6tgScG9on2gXKkEUErcgnZ79qnvzKhaU6QgzoBAQ==
+"@paraswap/core@2.4.0":
+  version "2.4.0"
+  resolved "https://registry.yarnpkg.com/@paraswap/core/-/core-2.4.0.tgz#82dac1f2eb5622b90eec352031f0711037bd8eff"
+  integrity sha512-msv0Etc5f7H2UDnDd23wKzNnx64fj1iwt8IlBORTFIpxJ1+fa+TqNO7lhtohfRiVmU3dnnAMcjEi4D+WHSWpvw==
 
 "@rollup/plugin-babel@^5.3.1":
   version "5.3.1"