@portal-hq/web 3.6.0-alpha → 3.6.0

package/src/mpc/index.test.ts

@@ -49,6 +49,13 @@ import {
   mockLifiGetStatusResponse,
   mockLifiGetRouteStepRequest,
   mockLifiGetRouteStepResponse,
+  mockZeroExQuoteV2Request,
+  mockZeroExQuoteV2Response,
+  mockZeroExSourcesV2Request,
+  mockZeroExSourcesV2Response,
+  mockZeroExPriceRequest,
+  mockZeroExPriceResponse,
+  mockZeroExOptions,
 } from '../__mocks/constants'
 import portalMock from '../__mocks/portal/portal'
 import { PortalMpcError } from './errors'
@@ -1496,7 +1503,7 @@ describe('Mpc', () => {
         })
 
       mpc
-        .getQuote(mockApikey, mockQuoteArgs, 'eip155:1')
+        .getQuote('eip155:1', mockQuoteArgs, mockApikey)
         .then((data) => {
           expect(data).toEqual(res)
           done()
@@ -1536,7 +1543,7 @@ describe('Mpc', () => {
         })
 
       mpc
-        .getQuote(mockApikey, mockQuoteArgs, 'eip155:1')
+        .getQuote('eip155:1', mockQuoteArgs, mockApikey)
         .then(() => {
           expect(0).toEqual(1)
           done()
@@ -1575,7 +1582,7 @@ describe('Mpc', () => {
         })
 
       mpc
-        .getSources(mockApikey, 'eip155:1')
+        .getSources('eip155:1', mockApikey)
         .then((data) => {
           expect(data).toEqual(res)
           done()
@@ -1611,7 +1618,7 @@ describe('Mpc', () => {
         })
 
       mpc
-        .getSources(mockApikey, 'eip155:1')
+        .getSources('eip155:1', mockApikey)
         .then(() => {
           expect(0).toEqual(1)
           done()
@@ -2945,4 +2952,334 @@ describe('Mpc', () => {
         })
     })
   })
+
+  describe('getSwapsQuoteV2', () => {
+    const args = mockZeroExQuoteV2Request
+    const options = mockZeroExOptions
+    const res = mockZeroExQuoteV2Response
+
+    it('should successfully return the quote', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getQuoteV2')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getQuoteV2Result',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsQuoteV2(args, options)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should successfully return the quote without options', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getQuoteV2')
+          expect(data).toEqual({ ...args, options: undefined })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getQuoteV2Result',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsQuoteV2(args)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should error out if the iframe sends an error message', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementationOnce((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getQuoteV2')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getQuoteV2Error',
+                data: {
+                  code: 1,
+                  message: 'test',
+                },
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsQuoteV2(args, options)
+        .then(() => {
+          expect(0).toEqual(1)
+          done()
+        })
+        .catch((e) => {
+          expect(e).toBeInstanceOf(PortalMpcError)
+          expect(e.message).toEqual('test')
+          expect(e.code).toEqual(1)
+          done()
+        })
+    })
+  })
+
+  describe('getSwapsSourcesV2', () => {
+    const args = mockZeroExSourcesV2Request
+    const options = mockZeroExOptions
+    const res = mockZeroExSourcesV2Response
+
+    it('should successfully return the sources', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getSourcesV2')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getSourcesV2Result',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsSourcesV2(args, options)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should successfully return the sources without options', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getSourcesV2')
+          expect(data).toEqual({ ...args, options: undefined })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getSourcesV2Result',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsSourcesV2(args)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should error out if the iframe sends an error message', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementationOnce((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getSourcesV2')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getSourcesV2Error',
+                data: {
+                  code: 1,
+                  message: 'test',
+                },
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsSourcesV2(args, options)
+        .then(() => {
+          expect(0).toEqual(1)
+          done()
+        })
+        .catch((e) => {
+          expect(e).toBeInstanceOf(PortalMpcError)
+          expect(e.message).toEqual('test')
+          expect(e.code).toEqual(1)
+          done()
+        })
+    })
+  })
+
+  describe('getSwapsPrice', () => {
+    const args = mockZeroExPriceRequest
+    const options = mockZeroExOptions
+    const res = mockZeroExPriceResponse
+
+    it('should successfully return the price', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getPrice')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getPriceResult',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsPrice(args, options)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should successfully return the price without options', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementation((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getPrice')
+          expect(data).toEqual({ ...args, options: undefined })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getPriceResult',
+                data: res,
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsPrice(args)
+        .then((data) => {
+          expect(data).toEqual(res)
+          done()
+        })
+        .catch((_) => {
+          expect(0).toEqual(1)
+          done()
+        })
+    })
+
+    it('should error out if the iframe sends an error message', (done) => {
+      jest
+        .spyOn(mpc.iframe?.contentWindow!, 'postMessage')
+        .mockImplementationOnce((message: any, origin?) => {
+          const { type, data } = message
+
+          expect(type).toEqual('portal:swaps:getPrice')
+          expect(data).toEqual({ ...args, options })
+          expect(origin).toEqual(mockHostOrigin)
+
+          window.dispatchEvent(
+            new MessageEvent('message', {
+              origin: mockHostOrigin,
+              data: {
+                type: 'portal:swaps:getPriceError',
+                data: {
+                  code: 1,
+                  message: 'test',
+                },
+              },
+            }),
+          )
+        })
+
+      mpc
+        .getSwapsPrice(args, options)
+        .then(() => {
+          expect(0).toEqual(1)
+          done()
+        })
+        .catch((e) => {
+          expect(e).toBeInstanceOf(PortalMpcError)
+          expect(e.message).toEqual('test')
+          expect(e.code).toEqual(1)
+          done()
+        })
+    })
+  })
 })

package/src/mpc/index.ts

@@ -67,8 +67,17 @@ import {
   LifiStepTransactionRequest,
   LifiStepTransactionResponse,
 } from '../../lifi-types'
+import {
+  ZeroExOptions,
+  ZeroExPriceRequest,
+  ZeroExPriceResponse,
+  ZeroExQuoteRequest,
+  ZeroExQuoteResponse,
+  ZeroExSourcesRequest,
+  ZeroExSourcesResponse,
+} from '../../zero-x'
 
-const WEB_SDK_VERSION = '3.6.0-alpha'
+const WEB_SDK_VERSION = '3.6.0'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -837,9 +846,9 @@ class Mpc {
   }
 
   public async getQuote(
-    apiKey: string,
-    args: QuoteArgs,
     chainId: string,
+    args: QuoteArgs,
+    apiKey?: string,
   ): Promise<QuoteResponse> {
     return new Promise((resolve, reject) => {
       const handleGetQuote = (event: MessageEvent<WorkerResult>) => {
@@ -881,8 +890,8 @@ class Mpc {
   }
 
   public async getSources(
-    apiKey: string,
     chainId: string,
+    apiKey?: string,
   ): Promise<Record<string, string>> {
     return new Promise((resolve, reject) => {
       const handleGetSources = (event: MessageEvent<WorkerResult>) => {
@@ -1350,6 +1359,42 @@ class Mpc {
     })
   }
 
+  public async getSwapsQuoteV2(
+    data: ZeroExQuoteRequest,
+    options?: ZeroExOptions,
+  ): Promise<ZeroExQuoteResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:swaps:getQuoteV2',
+      errorMessage: 'portal:swaps:getQuoteV2Error',
+      resultMessage: 'portal:swaps:getQuoteV2Result',
+      data: { ...data, options },
+    })
+  }
+
+  public async getSwapsSourcesV2(
+    data: ZeroExSourcesRequest,
+    options?: ZeroExOptions,
+  ): Promise<ZeroExSourcesResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:swaps:getSourcesV2',
+      errorMessage: 'portal:swaps:getSourcesV2Error',
+      resultMessage: 'portal:swaps:getSourcesV2Result',
+      data: { ...data, options },
+    })
+  }
+
+  public async getSwapsPrice(
+    data: ZeroExPriceRequest,
+    options?: ZeroExOptions,
+  ): Promise<ZeroExPriceResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:swaps:getPrice',
+      errorMessage: 'portal:swaps:getPriceError',
+      resultMessage: 'portal:swaps:getPriceResult',
+      data: { ...data, options },
+    })
+  }
+
   /***************************
    * Private Methods
    ***************************/

package/src/provider/index.ts

@@ -248,6 +248,7 @@ class Provider {
     chainId: requestChainId,
     method,
     params,
+    sponsorGas,
   }: RequestArguments): Promise<any> {
     const isSignerMethod = signerMethods.includes(method)
     const chainId = this.getCAIP2ChainId(requestChainId)
@@ -278,6 +279,7 @@ class Provider {
         chainId,
         method,
         params,
+        sponsorGas,
       })
 
       if (transactionHash) {
@@ -432,6 +434,7 @@ class Provider {
     chainId,
     method,
     params,
+    sponsorGas,
   }: RequestArguments): Promise<any> {
     const isApproved = passiveSignerMethods.includes(method)
       ? true
@@ -467,6 +470,7 @@ class Provider {
           method,
           params: this.buildParams(method, params),
           rpcUrl: this.portal.getRpcUrl(chainId),
+          sponsorGas,
         })
         return result
       }
@@ -480,6 +484,7 @@ class Provider {
           method,
           params: this.buildParams(method, params),
           rpcUrl: this.portal.getRpcUrl(chainId),
+          sponsorGas,
         })
         return result
       }

package/types.d.ts

@@ -73,6 +73,7 @@ export interface SendAssetParams {
   amount: string
   to: string
   token: string
+  sponsorGas?: boolean
 }
 
 export interface SendAssetResponse {
@@ -468,6 +469,7 @@ export interface RequestArguments {
   chainId?: string
   method: RequestMethod
   params?: unknown[] | SigningRequestParams
+  sponsorGas?: boolean
 }
 
 export interface RecoverArgs extends MpcOperationArgs {
@@ -502,6 +504,7 @@ export interface SignArgs {
   method: string
   params: string
   rpcUrl: string
+  sponsorGas?: boolean
 }
 
 export interface SignData {