@portal-hq/web 1.0.3 → 2.0.0

package/lib/esm/mpc/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { PortalMpcError } from './errors';
 import { BackupMethods } from '../index';
-const WEB_SDK_VERSION = '1.0.3';
+const WEB_SDK_VERSION = '2.0.0';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -73,8 +73,14 @@ class Mpc {
                         // Remove the event listeners
                         window.removeEventListener('message', handleBackup);
                         window.removeEventListener('message', handleProgress);
+                        const storageCallback = () => __awaiter(this, void 0, void 0, function* () {
+                            yield this.setBackupStatus('STORED_CLIENT_BACKUP_SHARE', result.backupIds);
+                        });
                         // Resolve the promise with the result
-                        resolve(result);
+                        resolve({
+                            cipherText: result.cipherText,
+                            storageCallback,
+                        });
                     }
                 };
                 const handleProgress = (message) => {
@@ -331,7 +337,7 @@ class Mpc {
     /*******************************
      * API Methods
      *******************************/
-    getBalances() {
+    getBalances(chainId) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const handleGetBalances = (event) => {
@@ -359,7 +365,7 @@ class Mpc {
                 // Send the request to the iframe
                 this.postMessage({
                     type: 'portal:getBalances',
-                    data: {},
+                    data: { chainId },
                 });
             });
         });
@@ -397,7 +403,7 @@ class Mpc {
             });
         });
     }
-    getNFTs() {
+    getNFTs(chainId) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const handleGetNFTs = (event) => {
@@ -425,12 +431,12 @@ class Mpc {
                 // Send the request to the iframe
                 this.postMessage({
                     type: 'portal:getNFTs',
-                    data: {},
+                    data: { chainId },
                 });
             });
         });
     }
-    getQuote(apiKey, args) {
+    getQuote(apiKey, args, chainId) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const handleGetQuote = (event) => {
@@ -461,12 +467,13 @@ class Mpc {
                     data: {
                         apiKey,
                         args,
+                        chainId,
                     },
                 });
             });
         });
     }
-    getSources(apiKey) {
+    getSources(apiKey, chainId) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const handleGetSources = (event) => {
@@ -496,6 +503,7 @@ class Mpc {
                     type: 'portal:swaps:getSources',
                     data: {
                         apiKey,
+                        chainId,
                     },
                 });
             });
@@ -539,7 +547,42 @@ class Mpc {
             });
         });
     }
-    simulateTransaction(transaction) {
+    setBackupStatus(status, backupIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleSetBackupStatus = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:api:setBackupStatusError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleSetBackupStatus);
+                        // Reject the promise with the error
+                        return reject(new PortalMpcError(data));
+                    }
+                    else if (type === 'portal:api:setBackupStatusResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleSetBackupStatus);
+                        // Resolve the promise with the result
+                        return resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleSetBackupStatus);
+                this.postMessage({
+                    type: 'portal:api:setBackupStatus',
+                    data: {
+                        backupIds,
+                        status,
+                    },
+                });
+            });
+        });
+    }
+    simulateTransaction(transaction, chainId) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const handleSimulateTransaction = (event) => {
@@ -567,7 +610,10 @@ class Mpc {
                 // Send the request to the iframe
                 this.postMessage({
                     type: 'portal:simulateTransaction',
-                    data: transaction,
+                    data: {
+                        chainId,
+                        transaction,
+                    },
                 });
             });
         });

package/lib/esm/provider/index.js

@@ -108,17 +108,21 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    request({ method, params }) {
+    request({ chainId, method, params, }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (method === 'eth_chainId') {
-                return this.portal.chainId;
+                return chainId ? parseInt(chainId.split(':')[1]) : this.portal.chainId;
             }
             const isSignerMethod = signerMethods.includes(method);
-            let result;
             if (!isSignerMethod && !method.startsWith('wallet_')) {
                 // Send to Gateway for RPC calls
-                const response = yield this.handleGatewayRequest({ method, params });
+                const response = yield this.handleGatewayRequest({
+                    chainId,
+                    method,
+                    params,
+                });
                 this.emit('portal_signatureReceived', {
+                    chainId,
                     method,
                     params,
                     signature: response,
@@ -126,21 +130,23 @@ class Provider {
                 if (response.error) {
                     throw new ProviderRpcError(response.error);
                 }
-                result = response.result;
+                return response.result;
             }
             else if (isSignerMethod) {
                 // Handle signing
                 const transactionHash = yield this.handleSigningRequest({
+                    chainId,
                     method,
                     params,
                 });
                 if (transactionHash) {
                     this.emit('portal_signatureReceived', {
+                        chainId,
                         method,
                         params,
                         signature: transactionHash,
                     });
-                    result = transactionHash;
+                    return transactionHash;
                 }
             }
             else {
@@ -153,7 +159,6 @@ class Provider {
                     },
                 });
             }
-            return result;
         });
     }
     /************************
@@ -216,13 +221,13 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    handleGatewayRequest({ method, params, }) {
+    handleGatewayRequest({ chainId, method, params, }) {
         return __awaiter(this, void 0, void 0, function* () {
             // Pass request off to the gateway
             const result = yield fetch(this.portal.getRpcUrl(), {
                 body: JSON.stringify({
                     jsonrpc: '2.0',
-                    id: this.portal.chainId,
+                    id: chainId ? parseInt(chainId.split(':')[1]) : this.portal.chainId,
                     method,
                     params,
                 }),
@@ -237,7 +242,7 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    handleSigningRequest({ method, params, }) {
+    handleSigningRequest({ chainId, method, params, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const isApproved = passiveSignerMethods.includes(method)
                 ? true
@@ -259,7 +264,9 @@ class Provider {
                 case 'eth_signTypedData_v4':
                 case 'personal_sign': {
                     const result = yield this.portal.mpc.sign({
-                        chainId: this.portal.chainId.toString(),
+                        chainId: chainId
+                            ? chainId.split(':')[1]
+                            : this.portal.chainId.toString(),
                         method,
                         params: this.buildParams(method, params),
                         rpcUrl: this.portal.getRpcUrl(),

package/package.json

@@ -3,7 +3,7 @@
   "description": "Portal MPC Support for Web",
   "author": "Portal Labs, Inc.",
   "homepage": "https://portalhq.io/",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "license": "MIT",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",

package/src/index.ts

@@ -1,8 +1,9 @@
 import type {
   BackupConfigs,
+  BackupResponse,
   BackupSharePairMetadata,
   Balance,
-  ClientWithCustodianData,
+  ClientResponse,
   EthereumTransaction,
   FeatureFlags,
   GDriveConfig,
@@ -168,8 +169,8 @@ class Portal {
       // Noop
     },
     backupConfigs: BackupConfigs = {},
-  ): Promise<string> {
-    const cipherText = await this.mpc.backup(
+  ): Promise<BackupResponse> {
+    const response = await this.mpc.backup(
       {
         backupMethod,
         backupConfigs,
@@ -180,7 +181,7 @@ class Portal {
       progress,
     )
 
-    return cipherText
+    return response
   }
 
   public async recoverWallet(
@@ -250,22 +251,28 @@ class Portal {
    * Provider Methods
    ****************************/
 
-  public async ethEstimateGas(transaction: EthereumTransaction): Promise<any> {
+  public async ethEstimateGas(
+    transaction: EthereumTransaction,
+    chainId?: string,
+  ): Promise<any> {
     return this.provider.request({
+      chainId,
       method: 'eth_estimateGas',
       params: transaction,
     })
   }
 
-  public async ethGasPrice(): Promise<string> {
+  public async ethGasPrice(chainId?: string): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_gasPrice',
       params: [],
     }) as Promise<string>
   }
 
-  public async ethGetBalance(): Promise<string> {
+  public async ethGetBalance(chainId?: string): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_getBalance',
       params: [this.address, 'latest'],
     }) as Promise<string>
@@ -273,15 +280,18 @@ class Portal {
 
   public async ethSendTransaction(
     transaction: EthereumTransaction,
+    chainId?: string,
   ): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_sendTransaction',
       params: transaction,
     }) as Promise<string>
   }
 
-  public async ethSign(message: string): Promise<string> {
+  public async ethSign(message: string, chainId?: string): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_sign',
       params: [this.address, this.stringToHex(message)],
     }) as Promise<string>
@@ -289,39 +299,57 @@ class Portal {
 
   public async ethSignTransaction(
     transaction: EthereumTransaction,
+    chainId?: string,
   ): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_signTransaction',
       params: transaction,
     }) as Promise<string>
   }
 
-  public async ethSignTypedData(data: TypedData): Promise<string> {
+  public async ethSignTypedData(
+    data: TypedData,
+    chainId?: string,
+  ): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_signTypedData',
       params: [this.address, data],
     }) as Promise<string>
   }
 
-  public async ethSignTypedDataV3(data: TypedData): Promise<string> {
+  public async ethSignTypedDataV3(
+    data: TypedData,
+    chainId?: string,
+  ): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_signTypedData_v3',
       params: [this.address, data],
     }) as Promise<string>
   }
 
-  public async ethSignTypedDataV4(data: TypedData): Promise<string> {
+  public async ethSignTypedDataV4(
+    data: TypedData,
+    chainId?: string,
+  ): Promise<string> {
     return this.provider.request({
+      chainId,
       method: 'eth_signTypedData_v4',
       params: [this.address, data],
     }) as Promise<string>
   }
 
-  public async personalSign(message: string): Promise<string> {
-    return this.provider.request({
+  public async personalSign(
+    message: string,
+    chainId?: string,
+  ): Promise<string> {
+    return (await this.provider.request({
+      chainId,
       method: 'personal_sign',
       params: [this.stringToHex(message), this.address],
-    }) as Promise<string>
+    })) as Promise<string>
   }
 
   /*******************************
@@ -332,7 +360,7 @@ class Portal {
     return await this.mpc?.getBalances()
   }
 
-  public async getClient(): Promise<ClientWithCustodianData> {
+  public async getClient(): Promise<ClientResponse> {
     return this.mpc?.getClient()
   }
 
@@ -352,7 +380,7 @@ class Portal {
     limit?: number,
     offset?: number,
     order?: GetTransactionsOrder,
-    chainId?: number,
+    chainId?: string,
   ): Promise<Transaction[]> {
     return this.mpc?.getTransactions(limit, offset, order, chainId)
   }
@@ -370,12 +398,16 @@ class Portal {
   public async getQuote(
     apiKey: string,
     args: QuoteArgs,
+    chainId?: string,
   ): Promise<QuoteResponse> {
-    return this.mpc?.getQuote(apiKey, args)
+    return this.mpc?.getQuote(apiKey, args, chainId)
   }
 
-  public async getSources(apiKey: string): Promise<Record<string, string>> {
-    return this.mpc?.getSources(apiKey)
+  public async getSources(
+    apiKey: string,
+    chainId?: string,
+  ): Promise<Record<string, string>> {
+    return this.mpc?.getSources(apiKey, chainId)
   }
 
   /*******************************

package/src/mpc/index.ts

@@ -3,9 +3,10 @@ import { PortalMpcError } from './errors'
 import Portal, { BackupMethods, GetTransactionsOrder } from '../index'
 import type {
   BackupArgs,
+  BackupResponse,
   BackupSharePairMetadata,
   Balance,
-  ClientWithCustodianData,
+  ClientResponse,
   EjectArgs,
   GenerateArgs,
   IframeConfigurationOptions,
@@ -25,7 +26,7 @@ import type {
   WorkerResult,
 } from '../../types'
 
-const WEB_SDK_VERSION = '1.0.3'
+const WEB_SDK_VERSION = '2.0.0'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -51,7 +52,7 @@ class Mpc {
     progress: ProgressCallback = () => {
       // Noop
     },
-  ): Promise<string> {
+  ): Promise<BackupResponse> {
     const message = {
       type: 'portal:wasm:backup',
       data,
@@ -83,8 +84,18 @@ class Mpc {
           window.removeEventListener('message', handleBackup)
           window.removeEventListener('message', handleProgress)
 
+          const storageCallback = async () => {
+            await this.setBackupStatus(
+              'STORED_CLIENT_BACKUP_SHARE',
+              result.backupIds,
+            )
+          }
+
           // Resolve the promise with the result
-          resolve(result as string)
+          resolve({
+            cipherText: result.cipherText,
+            storageCallback,
+          })
         }
       }
 
@@ -394,7 +405,7 @@ class Mpc {
    * API Methods
    *******************************/
 
-  public async getBalances(): Promise<Balance[]> {
+  public async getBalances(chainId?: string): Promise<Balance[]> {
     return new Promise((resolve, reject) => {
       const handleGetBalances = (event: MessageEvent<WorkerResult>) => {
         const { type, data } = event.data
@@ -426,12 +437,12 @@ class Mpc {
       // Send the request to the iframe
       this.postMessage({
         type: 'portal:getBalances',
-        data: {},
+        data: { chainId },
       })
     })
   }
 
-  public async getClient(): Promise<ClientWithCustodianData> {
+  public async getClient(): Promise<ClientResponse> {
     return new Promise((resolve, reject) => {
       const handleGetClient = (event: MessageEvent<WorkerResult>) => {
         const { type, data } = event.data
@@ -453,7 +464,7 @@ class Mpc {
           window.removeEventListener('message', handleGetClient)
 
           // Resolve the promise with the result
-          resolve(data as ClientWithCustodianData)
+          resolve(data as ClientResponse)
         }
       }
 
@@ -468,7 +479,7 @@ class Mpc {
     })
   }
 
-  public async getNFTs(): Promise<NFT[]> {
+  public async getNFTs(chainId?: string): Promise<NFT[]> {
     return new Promise((resolve, reject) => {
       const handleGetNFTs = (event: MessageEvent<WorkerResult>) => {
         const { type, data } = event.data
@@ -500,7 +511,7 @@ class Mpc {
       // Send the request to the iframe
       this.postMessage({
         type: 'portal:getNFTs',
-        data: {},
+        data: { chainId },
       })
     })
   }
@@ -508,6 +519,7 @@ class Mpc {
   public async getQuote(
     apiKey: string,
     args: QuoteArgs,
+    chainId?: string,
   ): Promise<QuoteResponse> {
     return new Promise((resolve, reject) => {
       const handleGetQuote = (event: MessageEvent<WorkerResult>) => {
@@ -542,12 +554,16 @@ class Mpc {
         data: {
           apiKey,
           args,
+          chainId,
         },
       })
     })
   }
 
-  public async getSources(apiKey: string): Promise<Record<string, string>> {
+  public async getSources(
+    apiKey: string,
+    chainId?: string,
+  ): Promise<Record<string, string>> {
     return new Promise((resolve, reject) => {
       const handleGetSources = (event: MessageEvent<WorkerResult>) => {
         const { type, data: result } = event.data
@@ -580,6 +596,7 @@ class Mpc {
         type: 'portal:swaps:getSources',
         data: {
           apiKey,
+          chainId,
         },
       })
     })
@@ -589,7 +606,7 @@ class Mpc {
     limit?: number,
     offset?: number,
     order?: GetTransactionsOrder,
-    chainId?: number,
+    chainId?: string,
   ): Promise<Transaction[]> {
     return new Promise((resolve, reject) => {
       const handleGetTransactions = (event: MessageEvent<WorkerResult>) => {
@@ -632,8 +649,51 @@ class Mpc {
     })
   }
 
+  public async setBackupStatus(
+    status: string,
+    backupIds: string[],
+  ): Promise<boolean> {
+    return new Promise((resolve, reject) => {
+      const handleSetBackupStatus = (event: MessageEvent<WorkerResult>) => {
+        const { type, data } = event.data
+        const { origin } = event
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:api:setBackupStatusError') {
+          // Remove the event listener
+          window.removeEventListener('message', handleSetBackupStatus)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:api:setBackupStatusResult') {
+          // Remove the event listener
+          window.removeEventListener('message', handleSetBackupStatus)
+
+          // Resolve the promise with the result
+          return resolve(data)
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleSetBackupStatus)
+
+      this.postMessage({
+        type: 'portal:api:setBackupStatus',
+        data: {
+          backupIds,
+          status,
+        },
+      })
+    })
+  }
+
   public async simulateTransaction(
     transaction: SimulateTransactionParam,
+    chainId?: string,
   ): Promise<SimulatedTransaction> {
     return new Promise((resolve, reject) => {
       const handleSimulateTransaction = (event: MessageEvent<WorkerResult>) => {
@@ -666,7 +726,10 @@ class Mpc {
       // Send the request to the iframe
       this.postMessage({
         type: 'portal:simulateTransaction',
-        data: transaction,
+        data: {
+          chainId,
+          transaction,
+        },
       })
     })
   }