@portal-hq/web 3.6.0-alpha → 3.6.0

package/src/__mocks/constants.ts

@@ -730,11 +730,17 @@ export const mockQuoteRes = {
 }
 
 export const mockSourcesRes = {
-  '0x': '0xE41d2489571d322189246DaFA5ebDe1F4699F498',
-  SushiSwap: '0x6B3595068778DD592e39A122f4f5a5cF09C90fE2',
-  Uniswap: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
-  Uniswap_V2: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
-  Uniswap_V3: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+  data: {
+    rawResponse: {
+      sources: ['0x', 'SushiSwap', 'Uniswap', 'Uniswap_V2', 'Uniswap_V3'],
+      zid: 'test-zid',
+    },
+  },
+  metadata: {
+    chainId: 'eip155:1',
+    clientId: 'test',
+    clientEip155Address: '0x1234567890123456789012345678901234567890',
+  },
 }
 
 export const mockZeroXQuoteResponse = {
@@ -1312,3 +1318,198 @@ export const mockLifiGetRouteStepResponse = {
     },
   },
 }
+
+// ZeroEx v2 mock data
+export const mockZeroExQuoteV2Request = {
+  chainId: 'eip155:1',
+  buyToken: 'UNI',
+  sellToken: 'WETH',
+  sellAmount: '1000000000000000000',
+}
+
+export const mockZeroExQuoteV2Response = {
+  data: {
+    rawResponse: {
+      blockNumber: '18500000',
+      buyAmount: '100000000000000000000',
+      buyToken: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+      fees: {
+        integratorFee: null,
+        zeroExFee: null,
+        gasFee: {
+          amount: '21000000000000',
+          token: '0x0000000000000000000000000000000000000000',
+          type: 'gas',
+        },
+      },
+      issues: {
+        allowance: {
+          actual: '0',
+          spender: '0x1234567890123456789012345678901234567890',
+        },
+        balance: {
+          token: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+          actual: '1000000000000000000',
+          expected: '1000000000000000000',
+        },
+        simulationIncomplete: false,
+        invalidSourcesPassed: [],
+      },
+      liquidityAvailable: true,
+      minBuyAmount: '99000000000000000000',
+      route: {
+        fills: [
+          {
+            from: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+            to: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+            source: 'Uniswap_V3',
+            proportionBps: '10000',
+          },
+        ],
+        tokens: [
+          {
+            address: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+            symbol: 'WETH',
+          },
+          {
+            address: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+            symbol: 'UNI',
+          },
+        ],
+      },
+      sellAmount: '1000000000000000000',
+      sellToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+      tokenMetadata: {
+        buyToken: {
+          buyTaxBps: '0',
+          sellTaxBps: '0',
+        },
+        sellToken: {
+          buyTaxBps: '0',
+          sellTaxBps: '0',
+        },
+      },
+      totalNetworkFee: '21000000000000',
+      transaction: {
+        to: '0x1234567890123456789012345678901234567890',
+        data: '0xabcdef',
+        gas: '200000',
+        gasPrice: '30000000000',
+        value: '0',
+      },
+    },
+  },
+  metadata: {
+    buyToken: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+    sellToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+    sellAmount: '1000000000000000000',
+    chainId: 'eip155:1',
+    clientId: 'test-client-id',
+    clientEip155Address: mockEip155Address,
+  },
+}
+
+export const mockZeroExSourcesV2Request = {
+  chainId: 'eip155:1',
+}
+
+export const mockZeroExSourcesV2Response = {
+  data: {
+    rawResponse: {
+      sources: ['Uniswap_V2', 'Uniswap_V3', 'SushiSwap', '0x'],
+      zid: 'test-zid',
+    },
+  },
+  metadata: {
+    chainId: 'eip155:1',
+    clientId: 'test-client-id',
+  },
+}
+
+export const mockZeroExPriceRequest = {
+  chainId: 'eip155:1',
+  buyToken: 'UNI',
+  sellToken: 'WETH',
+  sellAmount: '1000000000000000000',
+}
+
+export const mockZeroExPriceResponse = {
+  data: {
+    rawResponse: {
+      blockNumber: '18500000',
+      buyAmount: '100000000000000000000',
+      buyToken: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+      fees: {
+        integratorFee: null,
+        zeroExFee: null,
+        gasFee: {
+          amount: '21000000000000',
+          token: '0x0000000000000000000000000000000000000000',
+          type: 'gas',
+        },
+      },
+      gas: '200000',
+      gasPrice: '30000000000',
+      issues: {
+        allowance: {
+          actual: '0',
+          spender: '0x1234567890123456789012345678901234567890',
+        },
+        balance: {
+          token: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+          actual: '1000000000000000000',
+          expected: '1000000000000000000',
+        },
+        simulationIncomplete: false,
+        invalidSourcesPassed: [],
+      },
+      liquidityAvailable: true,
+      minBuyAmount: '99000000000000000000',
+      route: {
+        fills: [
+          {
+            from: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+            to: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+            source: 'Uniswap_V3',
+            proportionBps: '10000',
+          },
+        ],
+        tokens: [
+          {
+            address: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+            symbol: 'WETH',
+          },
+          {
+            address: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+            symbol: 'UNI',
+          },
+        ],
+      },
+      sellAmount: '1000000000000000000',
+      sellToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+      tokenMetadata: {
+        buyToken: {
+          buyTaxBps: '0',
+          sellTaxBps: '0',
+        },
+        sellToken: {
+          buyTaxBps: '0',
+          sellTaxBps: '0',
+        },
+      },
+      totalNetworkFee: '21000000000000',
+    },
+  },
+  metadata: {
+    buyToken: '0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984',
+    sellToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+    sellAmount: '1000000000000000000',
+    chainId: 'eip155:1',
+    clientId: 'test-client-id',
+    clientEip155Address: mockEip155Address,
+  },
+}
+
+export const mockZeroExOptions = {
+  zeroXApiKey: 'test-0x-api-key',
+}

package/src/index.test.ts

@@ -883,9 +883,9 @@ describe('Portal', () => {
 
       expect(portal.mpc.getQuote).toHaveBeenCalledTimes(1)
       expect(portal.mpc.getQuote).toHaveBeenCalledWith(
-        'test',
-        mockQuoteArgs,
         'eip155:1',
+        mockQuoteArgs,
+        'test',
       )
     })
   })
@@ -895,7 +895,7 @@ describe('Portal', () => {
       await portal.getSources('test', 'eip155:1')
 
       expect(portal.mpc.getSources).toHaveBeenCalledTimes(1)
-      expect(portal.mpc.getSources).toHaveBeenCalledWith('test', 'eip155:1')
+      expect(portal.mpc.getSources).toHaveBeenCalledWith('eip155:1', 'test')
     })
   })
 

package/src/index.ts

@@ -465,6 +465,7 @@ class Portal {
             chainId,
             method: 'eth_sendTransaction',
             params: [buildTxResponse.transaction],
+            sponsorGas: params.sponsorGas,
           })
           break
         }
@@ -473,6 +474,7 @@ class Portal {
             chainId,
             method: 'sol_signAndSendTransaction',
             params: [buildTxResponse.transaction],
+            sponsorGas: params.sponsorGas,
           })
           break
         }
@@ -899,7 +901,7 @@ class Portal {
     args: QuoteArgs,
     chainId: string,
   ): Promise<QuoteResponse> {
-    return this.mpc?.getQuote(apiKey, args, chainId)
+    return this.mpc?.getQuote(chainId, args, apiKey)
   }
 
   /**
@@ -909,7 +911,7 @@ class Portal {
     apiKey: string,
     chainId: string,
   ): Promise<Record<string, string>> {
-    return this.mpc?.getSources(apiKey, chainId)
+    return this.mpc?.getSources(chainId, apiKey)
   }
 
   /*******************************

package/src/integrations/trading/zero-x/index.test.ts

@@ -7,10 +7,14 @@ import Mpc from '../../../mpc'
 import portalMock from '../../../__mocks/portal/portal'
 import {
   mockHost,
-  mockQuoteArgs,
   mockSourcesRes,
-  mockZeroXQuoteResponse,
+  mockZeroExQuoteV2Request,
+  mockZeroExQuoteV2Response,
+  mockZeroExOptions,
+  mockZeroExPriceRequest,
+  mockZeroExPriceResponse,
 } from '../../../__mocks/constants'
+import type { ZeroExPriceResponse } from '../../../../zero-x'
 
 describe('ZeroX', () => {
   let zeroX: ZeroX
@@ -28,46 +32,121 @@ describe('ZeroX', () => {
   })
 
   describe('getQuote', () => {
-    it('should correctly call mpc.getQuote', async () => {
+    it('should correctly call mpc.getSwapsQuoteV2 with args and options', async () => {
       const spy = jest
-        .spyOn(mpc, 'getQuote')
-        .mockResolvedValue(mockZeroXQuoteResponse)
+        .spyOn(mpc, 'getSwapsQuoteV2')
+        .mockResolvedValue(mockZeroExQuoteV2Response)
 
-      const result = await zeroX.getQuote('test', mockQuoteArgs, 'eip155:1')
+      const result = await zeroX.getQuote(
+        mockZeroExQuoteV2Request,
+        mockZeroExOptions,
+      )
+
+      expect(spy).toHaveBeenCalledTimes(1)
+      expect(spy).toHaveBeenCalledWith(
+        mockZeroExQuoteV2Request,
+        mockZeroExOptions,
+      )
+      expect(result).toEqual(mockZeroExQuoteV2Response)
+    })
+
+    it('should correctly call mpc.getSwapsQuoteV2 without options', async () => {
+      const spy = jest
+        .spyOn(mpc, 'getSwapsQuoteV2')
+        .mockResolvedValue(mockZeroExQuoteV2Response)
+
+      const result = await zeroX.getQuote(mockZeroExQuoteV2Request)
 
       expect(spy).toHaveBeenCalledTimes(1)
-      expect(spy).toHaveBeenCalledWith('test', mockQuoteArgs, 'eip155:1')
-      expect(result).toEqual(mockZeroXQuoteResponse)
+      expect(spy).toHaveBeenCalledWith(mockZeroExQuoteV2Request, undefined)
+      expect(result).toEqual(mockZeroExQuoteV2Response)
     })
 
-    it('should propagate errors from mpc.getQuote', async () => {
+    it('should propagate errors from mpc.getSwapsQuoteV2', async () => {
       const error = new Error('Test error')
-      jest.spyOn(mpc, 'getQuote').mockRejectedValue(error)
+      jest.spyOn(mpc, 'getSwapsQuoteV2').mockRejectedValue(error)
 
-      await expect(
-        zeroX.getQuote('test', mockQuoteArgs, 'eip155:1'),
-      ).rejects.toThrow('Test error')
+      await expect(zeroX.getQuote(mockZeroExQuoteV2Request)).rejects.toThrow(
+        'Test error',
+      )
     })
   })
 
   describe('getSources', () => {
-    it('should correctly call mpc.getSources', async () => {
+    it('should correctly call mpc.getSources with chainId and apiKey', async () => {
+      const spy = jest
+        .spyOn(mpc, 'getSwapsSourcesV2')
+        .mockResolvedValue(mockSourcesRes)
+
+      const result = await zeroX.getSources('eip155:1', {
+        zeroXApiKey: 'test-api-key',
+      })
+
+      console.log(`Result:`, result)
+      expect(spy).toHaveBeenCalledTimes(1)
+      expect(spy).toHaveBeenCalledWith(
+        { chainId: 'eip155:1' },
+        { zeroXApiKey: 'test-api-key' },
+      )
+      expect(result).toEqual(mockSourcesRes)
+    })
+
+    it('should correctly call mpc.getSources without apiKey', async () => {
       const spy = jest
-        .spyOn(mpc, 'getSources')
+        .spyOn(mpc, 'getSwapsSourcesV2')
         .mockResolvedValue(mockSourcesRes)
 
-      const result = await zeroX.getSources('test', 'eip155:1')
+      const result = await zeroX.getSources('eip155:1')
 
       expect(spy).toHaveBeenCalledTimes(1)
-      expect(spy).toHaveBeenCalledWith('test', 'eip155:1')
+      expect(spy).toHaveBeenCalledWith({ chainId: 'eip155:1' }, undefined)
       expect(result).toEqual(mockSourcesRes)
     })
 
     it('should propagate errors from mpc.getSources', async () => {
       const error = new Error('Test error')
-      jest.spyOn(mpc, 'getSources').mockRejectedValue(error)
+      jest.spyOn(mpc, 'getSwapsSourcesV2').mockRejectedValue(error)
+
+      await expect(zeroX.getSources('eip155:1')).rejects.toThrow('Test error')
+    })
+  })
+
+  describe('getPrice', () => {
+    it('should correctly call mpc.getSwapsPrice with args and options', async () => {
+      const spy = jest
+        .spyOn(mpc, 'getSwapsPrice')
+        .mockResolvedValue(mockZeroExPriceResponse as ZeroExPriceResponse)
+
+      const result = await zeroX.getPrice(
+        mockZeroExPriceRequest,
+        mockZeroExOptions,
+      )
+
+      expect(spy).toHaveBeenCalledTimes(1)
+      expect(spy).toHaveBeenCalledWith(
+        mockZeroExPriceRequest,
+        mockZeroExOptions,
+      )
+      expect(result).toEqual(mockZeroExPriceResponse)
+    })
+
+    it('should correctly call mpc.getSwapsPrice without options', async () => {
+      const spy = jest
+        .spyOn(mpc, 'getSwapsPrice')
+        .mockResolvedValue(mockZeroExPriceResponse as ZeroExPriceResponse)
+
+      const result = await zeroX.getPrice(mockZeroExPriceRequest)
+
+      expect(spy).toHaveBeenCalledTimes(1)
+      expect(spy).toHaveBeenCalledWith(mockZeroExPriceRequest, undefined)
+      expect(result).toEqual(mockZeroExPriceResponse)
+    })
+
+    it('should propagate errors from mpc.getSwapsPrice', async () => {
+      const error = new Error('Test error')
+      jest.spyOn(mpc, 'getSwapsPrice').mockRejectedValue(error)
 
-      await expect(zeroX.getSources('test', 'eip155:1')).rejects.toThrow(
+      await expect(zeroX.getPrice(mockZeroExPriceRequest)).rejects.toThrow(
         'Test error',
       )
     })

package/src/integrations/trading/zero-x/index.ts

@@ -1,5 +1,12 @@
 import Mpc from '../../../mpc'
-import { QuoteArgs, QuoteResponse } from '../../../../types'
+import {
+  ZeroExOptions,
+  ZeroExPriceRequest,
+  ZeroExPriceResponse,
+  ZeroExQuoteRequest,
+  ZeroExQuoteResponse,
+  ZeroExSourcesResponse,
+} from '../../../../zero-x'
 
 export default class ZeroX {
   private mpc: Mpc
@@ -17,11 +24,10 @@ export default class ZeroX {
    * @returns The quote response.
    */
   public async getQuote(
-    apiKey: string,
-    args: QuoteArgs,
-    chainId: string,
-  ): Promise<QuoteResponse> {
-    return this.mpc?.getQuote(apiKey, args, chainId)
+    args: ZeroExQuoteRequest,
+    options?: ZeroExOptions,
+  ): Promise<ZeroExQuoteResponse> {
+    return this.mpc?.getSwapsQuoteV2(args, options)
   }
 
   /**
@@ -32,9 +38,23 @@ export default class ZeroX {
    * @returns The sources response.
    */
   public async getSources(
-    apiKey: string,
     chainId: string,
-  ): Promise<Record<string, string>> {
-    return this.mpc?.getSources(apiKey, chainId)
+    options?: ZeroExOptions,
+  ): Promise<ZeroExSourcesResponse> {
+    return this.mpc?.getSwapsSourcesV2({ chainId }, options)
+  }
+
+  /**
+   * Get the price of a token from the Swaps API.
+   *
+   * @param args - The arguments for the price.
+   * @param options - The options for the price.
+   * @returns The price response.
+   */
+  public async getPrice(
+    args: ZeroExPriceRequest,
+    options?: ZeroExOptions,
+  ): Promise<ZeroExPriceResponse> {
+    return this.mpc?.getSwapsPrice(args, options)
   }
 }