feat(checkout): Return price impact as part of the quote (#2646)

Author: keithbro-imx

packages/checkout/sdk/src/sdk.test.ts

@@ -1079,6 +1079,7 @@ describe('Connect', () => {
             },
             value: BigInt('1050000000000000000'), // Example value with 5% max slippage
           },
+          priceImpact: 0,
         },
         swapReceipt: {
           to: '0xRecipientAddress',

packages/checkout/sdk/src/smartCheckout/routing/bridgeAndSwap/constructBridgeRequirements.test.ts

@@ -47,6 +47,7 @@ describe('constructBridgeRequirements', () => {
             basisPoints: 0,
           },
         ],
+        priceImpact: 0,
       },
     };
 

packages/checkout/sdk/src/smartCheckout/routing/swap/quoteFetcher.test.ts

@@ -46,6 +46,7 @@ describe('quoteFetcher', () => {
             basisPoints: 0,
           },
         ],
+        priceImpact: 0,
       },
       approval: null,
     };
@@ -98,6 +99,7 @@ describe('quoteFetcher', () => {
             basisPoints: 0,
           },
         ],
+        priceImpact: 0,
       },
     };
 

packages/checkout/sdk/src/smartCheckout/routing/swap/swapRoute.test.ts

@@ -71,6 +71,7 @@ describe('swapRoute', () => {
                 basisPoints: 0,
               },
             ],
+            priceImpact: 0,
           },
           approval: {
             value: BigInt(1),
@@ -125,6 +126,7 @@ describe('swapRoute', () => {
                 basisPoints: 0,
               },
             ],
+            priceImpact: 0,
           },
           approval: {
             value: BigInt(1),

packages/checkout/widgets-lib/src/widgets/swap/functions/swapConversionRate.test.ts

@@ -224,6 +224,7 @@ describe('formatQuoteConversionRate', () => {
         amountWithMaxSlippage: {} as Amount,
         slippage: 0,
         fees: [],
+        priceImpact: 0,
       } as Quote,
       swap: {
         gasFeeEstimate: {

packages/checkout/widgets-lib/src/widgets/swap/functions/swapFees.test.ts

@@ -24,6 +24,7 @@ describe('formatSwapFees', () => {
         amountWithMaxSlippage: {} as Amount,
         slippage: 0,
         fees: [],
+        priceImpact: 0,
       } as Quote,
       swap: {
         gasFeeEstimate: {

packages/internal/dex/sdk/jest.config.ts

@@ -21,6 +21,7 @@ const config: Config = {
   },
   coveragePathIgnorePatterns:['node_modules', 'src/contracts/', 'src/test/'],
   transformIgnorePatterns: [],
+  setupFiles: ['<rootDir>/jest.setup.js'],
 };
 
 export default config;

packages/internal/dex/sdk/jest.setup.js

@@ -0,0 +1,16 @@
+import { TextEncoder } from 'util';
+
+global.TextEncoder = TextEncoder;
+
+/**
+ * Required for ethers v6
+ * @see https://github.com/ethers-io/ethers.js/issues/4365
+ */
+Object.defineProperty(Uint8Array, Symbol.hasInstance, {
+    value(potentialInstance) {
+      return this === Uint8Array
+        ? Object.prototype.toString.call(potentialInstance) ===
+            '[object Uint8Array]'
+        : Uint8Array[Symbol.hasInstance].call(this, potentialInstance);
+    },
+  });

packages/internal/dex/sdk/src/exchange.ts

@@ -36,11 +36,13 @@ const toPublicQuote = (
   amount: CoinAmount<Coin>,
   amountWithMaxSlippage: CoinAmount<Coin>,
   slippage: number,
+  priceImpact: number,
   fees: Fees,
 ): Quote => ({
   amount: toPublicAmount(amount),
   amountWithMaxSlippage: toPublicAmount(amountWithMaxSlippage),
   slippage,
+  priceImpact,
   fees: fees.withAmounts().map((fee) => ({
     ...fee,
     amount: toPublicAmount(fee.amount),
@@ -223,6 +225,7 @@ export class Exchange {
       amount: toPublicAmount(otherTokenCoinAmount),
       amountWithMaxSlippage: toPublicAmount(otherTokenCoinAmount),
       slippage: 0,
+      priceImpact: 0,
       fees: [],
     };
 
@@ -340,7 +343,13 @@ export class Exchange {
       ? await getApproval(this.provider, fromAddress, preparedApproval, gasPrice)
       : null;
 
-    const quote = toPublicQuote(quotedAmount, quotedAmountWithMaxSlippage, slippagePercent, fees);
+    const quote = toPublicQuote(
+      quotedAmount,
+      quotedAmountWithMaxSlippage,
+      slippagePercent,
+      Number(adjustedQuote.priceImpact.toSignificant(10)),
+      fees,
+    );
 
     return { quote, approval, swap };
   }