@portal-hq/web 0.1.3-rcd → 1.0.0

package/lib/commonjs/index.js

@@ -20,7 +20,7 @@ class Portal {
     // Required
     gatewayConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -38,7 +38,7 @@ class Portal {
         if (gdrive) {
             this.gDriveConfig = gdrive;
         }
-        else if (passkey) {
+        if (passkey) {
             this.passkeyConfig = passkey;
         }
         this.mpc = new mpc_1.default({
@@ -285,6 +285,18 @@ class Portal {
             return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getNFTs();
         });
     }
+    getBackupShareMetadata() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getBackupShareMetadata();
+        });
+    }
+    getSigningShareMetadata() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getSigningShareMetadata();
+        });
+    }
     getTransactions(limit, offset, order, chainId) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -315,10 +327,10 @@ class Portal {
     /*******************************
      * Wallet Safeguarding Methods
      *******************************/
-    storedClientBackupShare(status) {
+    storedClientBackupShare(success, backupMethod) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.storedClientBackupShare(status));
+            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.storedClientBackupShare(success, backupMethod));
         });
     }
     /****************************
@@ -379,6 +391,7 @@ var BackupMethods;
     BackupMethods["gdrive"] = "GDRIVE";
     BackupMethods["password"] = "PASSWORD";
     BackupMethods["passkey"] = "PASSKEY";
+    BackupMethods["unknown"] = "UNKNOWN";
 })(BackupMethods = exports.BackupMethods || (exports.BackupMethods = {}));
 var GetTransactionsOrder;
 (function (GetTransactionsOrder) {

package/lib/commonjs/mpc/index.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MpcErrorCodes = exports.MpcError = void 0;
 const errors_1 = require("./errors");
 const index_1 = require("../index");
-const WEB_SDK_VERSION = '0.1.3-rcd';
+const WEB_SDK_VERSION = '1.0.0';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -618,7 +618,7 @@ class Mpc {
             });
         });
     }
-    storedClientBackupShare(success) {
+    storedClientBackupShare(success, backupMethod) {
         return new Promise((resolve, reject) => {
             const handleStoredClientBackupShare = (event) => {
                 const { type, data } = event.data;
@@ -645,7 +645,76 @@ class Mpc {
             // Send the request to the iframe
             this.postMessage({
                 type: 'portal:storedClientBackupShare',
-                data: success,
+                data: {
+                    success,
+                    backupMethod,
+                },
+            });
+        });
+    }
+    getBackupShareMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleGetBackupShareMetadata = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:getBackupShareMetadataError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetBackupShareMetadata);
+                        // Reject the promise with the error
+                        return reject(new errors_1.PortalMpcError(data));
+                    }
+                    else if (type === 'portal:getBackupShareMetadataResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetBackupShareMetadata);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleGetBackupShareMetadata);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:getBackupShareMetadata',
+                    data: {},
+                });
+            });
+        });
+    }
+    getSigningShareMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleGetSigningShareMetadata = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:getSigningShareMetadataError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetSigningShareMetadata);
+                        // Reject the promise with the error
+                        return reject(new errors_1.PortalMpcError(data));
+                    }
+                    else if (type === 'portal:getSigningShareMetadataResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetSigningShareMetadata);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleGetSigningShareMetadata);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:getSigningShareMetadata',
+                    data: {},
+                });
             });
         });
     }
@@ -666,7 +735,6 @@ class Mpc {
         iframe.width = '0';
         iframe.src = source;
         iframe.addEventListener('load', this.configureIframe);
-        iframe.setAttribute('allow', 'publickey-credentials-get');
         document.body.appendChild(iframe);
         this.iframe = iframe;
     }

package/lib/esm/index.js

@@ -14,7 +14,7 @@ class Portal {
     // Required
     gatewayConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -32,7 +32,7 @@ class Portal {
         if (gdrive) {
             this.gDriveConfig = gdrive;
         }
-        else if (passkey) {
+        if (passkey) {
             this.passkeyConfig = passkey;
         }
         this.mpc = new Mpc({
@@ -279,6 +279,18 @@ class Portal {
             return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getNFTs();
         });
     }
+    getBackupShareMetadata() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getBackupShareMetadata();
+        });
+    }
+    getSigningShareMetadata() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getSigningShareMetadata();
+        });
+    }
     getTransactions(limit, offset, order, chainId) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -309,10 +321,10 @@ class Portal {
     /*******************************
      * Wallet Safeguarding Methods
      *******************************/
-    storedClientBackupShare(status) {
+    storedClientBackupShare(success, backupMethod) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.storedClientBackupShare(status));
+            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.storedClientBackupShare(success, backupMethod));
         });
     }
     /****************************
@@ -371,6 +383,7 @@ export var BackupMethods;
     BackupMethods["gdrive"] = "GDRIVE";
     BackupMethods["password"] = "PASSWORD";
     BackupMethods["passkey"] = "PASSKEY";
+    BackupMethods["unknown"] = "UNKNOWN";
 })(BackupMethods || (BackupMethods = {}));
 export var GetTransactionsOrder;
 (function (GetTransactionsOrder) {

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 = '0.1.3-rcd';
+const WEB_SDK_VERSION = '1.0.0';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -615,7 +615,7 @@ class Mpc {
             });
         });
     }
-    storedClientBackupShare(success) {
+    storedClientBackupShare(success, backupMethod) {
         return new Promise((resolve, reject) => {
             const handleStoredClientBackupShare = (event) => {
                 const { type, data } = event.data;
@@ -642,7 +642,76 @@ class Mpc {
             // Send the request to the iframe
             this.postMessage({
                 type: 'portal:storedClientBackupShare',
-                data: success,
+                data: {
+                    success,
+                    backupMethod,
+                },
+            });
+        });
+    }
+    getBackupShareMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleGetBackupShareMetadata = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:getBackupShareMetadataError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetBackupShareMetadata);
+                        // Reject the promise with the error
+                        return reject(new PortalMpcError(data));
+                    }
+                    else if (type === 'portal:getBackupShareMetadataResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetBackupShareMetadata);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleGetBackupShareMetadata);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:getBackupShareMetadata',
+                    data: {},
+                });
+            });
+        });
+    }
+    getSigningShareMetadata() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleGetSigningShareMetadata = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:getSigningShareMetadataError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetSigningShareMetadata);
+                        // Reject the promise with the error
+                        return reject(new PortalMpcError(data));
+                    }
+                    else if (type === 'portal:getSigningShareMetadataResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleGetSigningShareMetadata);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleGetSigningShareMetadata);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:getSigningShareMetadata',
+                    data: {},
+                });
             });
         });
     }
@@ -663,7 +732,6 @@ class Mpc {
         iframe.width = '0';
         iframe.src = source;
         iframe.addEventListener('load', this.configureIframe);
-        iframe.setAttribute('allow', 'publickey-credentials-get');
         document.body.appendChild(iframe);
         this.iframe = iframe;
     }

package/package.json

@@ -3,7 +3,7 @@
   "description": "Portal MPC Support for Web",
   "author": "Portal Labs, Inc.",
   "homepage": "https://portalhq.io/",
-  "version": "0.1.3-rcd",
+  "version": "1.0.0",
   "license": "MIT",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
@@ -46,4 +46,4 @@
     "webpack": "^5.87.0",
     "webpack-cli": "^5.1.4"
   }
-}
+}

package/src/index.ts

@@ -1,5 +1,6 @@
 import type {
   BackupConfigs,
+  BackupSharePairMetadata,
   Balance,
   ClientWithCustodianData,
   EthereumTransaction,
@@ -7,11 +8,12 @@ import type {
   GDriveConfig,
   GatewayLike,
   NFT,
-  PortalOptions,
   PasskeyConfig,
+  PortalOptions,
   ProgressCallback,
   QuoteArgs,
   QuoteResponse,
+  SigningSharePairMetadata,
   SimulateTransactionParam,
   SimulatedTransaction,
   Transaction,
@@ -53,7 +55,7 @@ class Portal {
     gdrive,
     passkey,
     host = 'web.portalhq.io',
-    mpcVersion = 'v5',
+    mpcVersion = 'v6',
     featureFlags = {
       optimized: false,
     },
@@ -70,7 +72,8 @@ class Portal {
 
     if (gdrive) {
       this.gDriveConfig = gdrive
-    } else if (passkey) {
+    }
+    if (passkey) {
       this.passkeyConfig = passkey
     }
 
@@ -359,6 +362,14 @@ class Portal {
     return this.mpc?.getNFTs()
   }
 
+  public async getBackupShareMetadata(): Promise<BackupSharePairMetadata[]> {
+    return this.mpc?.getBackupShareMetadata()
+  }
+
+  public async getSigningShareMetadata(): Promise<SigningSharePairMetadata[]> {
+    return this.mpc?.getSigningShareMetadata()
+  }
+
   public async getTransactions(
     limit?: number,
     offset?: number,
@@ -393,8 +404,11 @@ class Portal {
    * Wallet Safeguarding Methods
    *******************************/
 
-  public async storedClientBackupShare(status: boolean): Promise<void> {
-    return await this.mpc?.storedClientBackupShare(status)
+  public async storedClientBackupShare(
+    success: boolean,
+    backupMethod: BackupMethods,
+  ): Promise<void> {
+    return await this.mpc?.storedClientBackupShare(success, backupMethod)
   }
 
   /****************************
@@ -474,6 +488,7 @@ export enum BackupMethods {
   gdrive = 'GDRIVE',
   password = 'PASSWORD',
   passkey = 'PASSKEY',
+  unknown = 'UNKNOWN',
 }
 
 export enum GetTransactionsOrder {

package/src/mpc/index.ts

@@ -3,6 +3,7 @@ import { PortalMpcError } from './errors'
 import Portal, { BackupMethods, GetTransactionsOrder } from '../index'
 import type {
   BackupArgs,
+  BackupSharePairMetadata,
   Balance,
   ClientWithCustodianData,
   EjectArgs,
@@ -18,13 +19,14 @@ import type {
   QuoteResponse,
   RecoverArgs,
   SignArgs,
+  SigningSharePairMetadata,
   SimulateTransactionParam,
   SimulatedTransaction,
   Transaction,
   WorkerResult,
 } from '../../types'
 
-const WEB_SDK_VERSION = '0.1.3-rcd'
+const WEB_SDK_VERSION = '1.0.0'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -725,7 +727,10 @@ class Mpc {
     })
   }
 
-  public storedClientBackupShare(success: boolean): Promise<void> {
+  public storedClientBackupShare(
+    success: boolean,
+    backupMethod: BackupMethods,
+  ): Promise<void> {
     return new Promise((resolve, reject) => {
       const handleStoredClientBackupShare = (
         event: MessageEvent<WorkerResult>,
@@ -759,7 +764,88 @@ class Mpc {
       // Send the request to the iframe
       this.postMessage({
         type: 'portal:storedClientBackupShare',
-        data: success,
+        data: {
+          success,
+          backupMethod,
+        },
+      })
+    })
+  }
+
+  public async getBackupShareMetadata(): Promise<BackupSharePairMetadata[]> {
+    return new Promise((resolve, reject) => {
+      const handleGetBackupShareMetadata = (
+        event: MessageEvent<WorkerResult>,
+      ) => {
+        const { type, data } = event.data
+        const { origin } = event
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:getBackupShareMetadataError') {
+          // Remove the event listener
+          window.removeEventListener('message', handleGetBackupShareMetadata)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:getBackupShareMetadataResult') {
+          // Remove the event listener
+          window.removeEventListener('message', handleGetBackupShareMetadata)
+
+          // Resolve the promise with the result
+          resolve(data as BackupSharePairMetadata[])
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleGetBackupShareMetadata)
+
+      // Send the request to the iframe
+      this.postMessage({
+        type: 'portal:getBackupShareMetadata',
+        data: {},
+      })
+    })
+  }
+
+  public async getSigningShareMetadata(): Promise<SigningSharePairMetadata[]> {
+    return new Promise((resolve, reject) => {
+      const handleGetSigningShareMetadata = (
+        event: MessageEvent<WorkerResult>,
+      ) => {
+        const { type, data } = event.data
+        const { origin } = event
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:getSigningShareMetadataError') {
+          // Remove the event listener
+          window.removeEventListener('message', handleGetSigningShareMetadata)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:getSigningShareMetadataResult') {
+          // Remove the event listener
+          window.removeEventListener('message', handleGetSigningShareMetadata)
+
+          // Resolve the promise with the result
+          resolve(data as SigningSharePairMetadata[])
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleGetSigningShareMetadata)
+
+      // Send the request to the iframe
+      this.postMessage({
+        type: 'portal:getSigningShareMetadata',
+        data: {},
       })
     })
   }
@@ -783,7 +869,6 @@ class Mpc {
     iframe.width = '0'
     iframe.src = source
     iframe.addEventListener('load', this.configureIframe)
-    iframe.setAttribute('allow', 'publickey-credentials-get')
     document.body.appendChild(iframe)
 
     this.iframe = iframe

package/types.d.ts

@@ -39,6 +39,19 @@ export interface BackupConfigs {
   passwordStorage?: PasswordConfig
 }
 
+export interface BackupSharePairMetadata {
+  backupMethod: BackupMethods
+  createdAt: string
+  id: string
+  status: 'completed' | 'incomplete'
+}
+
+export interface SigningSharePairMetadata {
+  createdAt: string
+  id: string
+  status: 'completed' | 'incomplete'
+}
+
 export interface PasswordConfig {
   password: string
 }