@portal-hq/web 3.4.1 → 3.5.0-alpha

package/src/mpc/index.ts

@@ -33,15 +33,32 @@ import type {
   EvaluateTransactionOperationType,
   EvaluatedTransaction,
   NFTAsset,
-  Asset,
+  GetAssetsResponse,
   BuiltTransaction,
   EjectPrivateKeysArgs,
   EjectPrivateKeysResult,
   FundParams,
   FundResponse,
 } from '../../types'
-
-const WEB_SDK_VERSION = '3.4.1'
+import {
+  YieldXyzEnterRequest,
+  YieldXyzEnterYieldResponse,
+  YieldXyzExitRequest,
+  YieldXyzExitResponse,
+  YieldXyzGetBalancesRequest,
+  YieldXyzGetBalancesResponse,
+  YieldXyzGetHistoricalActionsRequest,
+  YieldXyzGetHistoricalActionsResponse,
+  YieldXyzGetTransactionResponse,
+  YieldXyzGetYieldsRequest,
+  YieldXyzGetYieldsResponse,
+  YieldXyzManageYieldRequest,
+  YieldXyzManageYieldResponse,
+  YieldXyzTrackTransactionRequest,
+  YieldXyzTrackTransactionResponse,
+} from '../../yieldxyz-types'
+
+const WEB_SDK_VERSION = '3.5.0-alpha'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -730,7 +747,7 @@ class Mpc {
   public async getAssets(
     chainId: string,
     includeNfts = false,
-  ): Promise<Asset[]> {
+  ): Promise<GetAssetsResponse> {
     return new Promise((resolve, reject) => {
       const handleGetAssets = (event: MessageEvent<WorkerResult>) => {
         const { type, data } = event.data
@@ -752,7 +769,7 @@ class Mpc {
           window.removeEventListener('message', handleGetAssets)
 
           // Resolve the promise with the result
-          resolve(data as Asset[])
+          resolve(data as GetAssetsResponse)
         }
       }
 
@@ -1191,10 +1208,148 @@ class Mpc {
     })
   }
 
+  public async getYieldXyzYields(
+    data: YieldXyzGetYieldsRequest,
+  ): Promise<YieldXyzGetYieldsResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:discover',
+      errorMessage: 'portal:yieldxyz:discoverError',
+      resultMessage: 'portal:yieldxyz:discoverResult',
+      data,
+    })
+  }
+
+  public async enterYieldXyzYield(
+    data: YieldXyzEnterRequest,
+  ): Promise<YieldXyzEnterYieldResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:enter',
+      errorMessage: 'portal:yieldxyz:enterError',
+      resultMessage: 'portal:yieldxyz:enterResult',
+      data,
+    })
+  }
+
+  public async exitYieldXyzYield(
+    data: YieldXyzExitRequest,
+  ): Promise<YieldXyzExitResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:exit',
+      errorMessage: 'portal:yieldxyz:exitError',
+      resultMessage: 'portal:yieldxyz:exitResult',
+      data,
+    })
+  }
+
+  public async getYieldXyzBalances(
+    data: YieldXyzGetBalancesRequest,
+  ): Promise<YieldXyzGetBalancesResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:getBalances',
+      errorMessage: 'portal:yieldxyz:getBalancesError',
+      resultMessage: 'portal:yieldxyz:getBalancesResult',
+      data,
+    })
+  }
+
+  public async getYieldXyzHistoricalActions(
+    data: YieldXyzGetHistoricalActionsRequest,
+  ): Promise<YieldXyzGetHistoricalActionsResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:getHistoricalActions',
+      errorMessage: 'portal:yieldxyz:getHistoricalActionsError',
+      resultMessage: 'portal:yieldxyz:getHistoricalActionsResult',
+      data,
+    })
+  }
+
+  public async manageYieldXyzYield(
+    data: YieldXyzManageYieldRequest,
+  ): Promise<YieldXyzManageYieldResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:manage',
+      errorMessage: 'portal:yieldxyz:manageYieldError',
+      resultMessage: 'portal:yieldxyz:manageYieldResult',
+      data,
+    })
+  }
+
+  public async trackYieldXyzTransaction(
+    data: YieldXyzTrackTransactionRequest,
+  ): Promise<YieldXyzTrackTransactionResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:track',
+      errorMessage: 'portal:yieldxyz:trackError',
+      resultMessage: 'portal:yieldxyz:trackResult',
+      data,
+    })
+  }
+
+  public async getYieldXyzTransaction(
+    data: string,
+  ): Promise<YieldXyzGetTransactionResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:yieldxyz:getTransaction',
+      errorMessage: 'portal:yieldxyz:getTransactionError',
+      resultMessage: 'portal:yieldxyz:getTransactionResult',
+      data,
+    })
+  }
+
   /***************************
    * Private Methods
    ***************************/
 
+  /**
+   * Util to handle requests to the iframe and post the result to the parent
+   */
+  private async handleRequestToIframeAndPost<T>({
+    methodMessage,
+    errorMessage,
+    resultMessage,
+    data,
+  }: {
+    methodMessage: string
+    errorMessage: string
+    resultMessage: string
+    data: any
+  }): Promise<T> {
+    return new Promise((resolve, reject) => {
+      const handleRequest = (event: MessageEvent<WorkerResult>) => {
+        const { type, data: result } = event.data
+        const { origin } = event
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === errorMessage) {
+          // Remove the event listener
+          window.removeEventListener('message', handleRequest)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(result as PortalError))
+        } else if (type === resultMessage) {
+          // Remove the event listener
+          window.removeEventListener('message', handleRequest)
+
+          // Resolve the promise with the result
+          resolve(result as T)
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleRequest)
+
+      // Send the request to the iframe
+      this.postMessage({
+        type: methodMessage,
+        data,
+      })
+    })
+  }
+
   /**
    * Appends the iframe to the document body
    */
@@ -1303,6 +1458,16 @@ class Mpc {
   }
 
   private validateBackupConfig(data: BackupArgs) {
+    // Validate that backupMethod is one of the valid BackupMethods
+    const validBackupMethods = Object.values(BackupMethods)
+    if (!validBackupMethods.includes(data.backupMethod)) {
+      throw new Error(
+        `Invalid backup method: ${
+          data.backupMethod
+        }. Valid methods are: ${validBackupMethods.join(', ')}`,
+      )
+    }
+
     if (data.backupMethod === BackupMethods.password) {
       if (!data.backupConfigs.passwordStorage) {
         throw new Error('Password storage config is required')

package/tsconfig.json

@@ -19,6 +19,6 @@
     "types": ["jest"]
   },
   "exclude": ["lib", "**/node_modules", "**/jest.config.ts"],
-  "files": ["types.d.ts"],
+  "files": ["types.d.ts", "yieldxyz-types.d.ts"],
   "include": ["**/*.ts", "**/*.tsx"]
 }

package/types.d.ts

@@ -679,7 +679,7 @@ export interface Transaction {
   value: number
 }
 
-export interface Asset {
+export interface GetAssetsResponse {
   nativeBalance: {
     balance: string
     decimals: number