@portal-hq/web 1.0.0 → 1.0.2

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 = 'v6', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -33,6 +33,7 @@ class Portal {
         this.chainId = chainId;
         this.gatewayConfig = gatewayConfig;
         this.host = host;
+        this.mpcHost = mpcHost;
         this.mpcVersion = mpcVersion;
         this.featureFlags = featureFlags;
         if (gdrive) {
@@ -136,24 +137,6 @@ class Portal {
             return address;
         });
     }
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Use the `recoverWallet` method instead.
-     */
-    legacyRecoverWallet(cipherText, progress = () => {
-        // Noop
-    }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const recoveredCipherText = yield this.mpc.legacyRecover({
-                cipherText,
-                host: this.host,
-                mpcVersion: this.mpcVersion,
-                featureFlags: this.featureFlags,
-            }, progress);
-            this.address = yield this.mpc.getAddress();
-            return recoveredCipherText;
-        });
-    }
     provisionWallet(cipherText, backupMethod, backupConfigs, progress = () => {
         // Noop
     }) {
@@ -161,16 +144,16 @@ class Portal {
             return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress);
         });
     }
-    ejectPrivateKey(clientBackupCiphertext, backupMethod, backupConfigs, orgBackupShare) {
+    ejectPrivateKey(clientBackupCipherText, backupMethod, backupConfigs, orgBackupShare) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (clientBackupCiphertext === '') {
-                throw new Error('clientBackupCiphertext cannot be empty string.');
+            if (clientBackupCipherText === '') {
+                throw new Error('clientBackupCipherText cannot be empty string.');
             }
             if (orgBackupShare === '') {
                 throw new Error('orgBackupShare cannot be empty string.');
             }
             const privateKey = yield this.mpc.eject({
-                cipherText: clientBackupCiphertext,
+                cipherText: clientBackupCipherText,
                 backupMethod,
                 backupConfigs,
                 organizationBackupShare: orgBackupShare,

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 = '1.0.0';
+const WEB_SDK_VERSION = '1.0.2';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -26,6 +26,8 @@ class Mpc {
                 passkey: this.portal.passkeyConfig,
                 host: this.portal.host,
                 rpcUrl: this.portal.getRpcUrl(),
+                mpcHost: this.portal.mpcHost,
+                mpcVersion: this.portal.mpcVersion,
                 featureFlags: this.portal.featureFlags,
             };
             const message = {
@@ -278,51 +280,6 @@ class Mpc {
             });
         });
     }
-    legacyRecover(data, progress = () => {
-        // Noop
-    }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                const handleRecover = (message) => {
-                    const { type, data } = message.data;
-                    const { origin } = message;
-                    // ignore any broadcast postMessages
-                    if (origin !== this.getOrigin()) {
-                        return;
-                    }
-                    if (type === 'portal:wasm:legacyRecoverError') {
-                        // Remove the event listeners
-                        window.removeEventListener('message', handleRecover);
-                        window.removeEventListener('message', handleProgress);
-                        reject(new errors_1.PortalMpcError(data));
-                    }
-                    else if (type === 'portal:wasm:legacyRecoverResult') {
-                        // Remove the event listeners
-                        window.removeEventListener('message', handleRecover);
-                        window.removeEventListener('message', handleProgress);
-                        resolve(data);
-                    }
-                };
-                const handleProgress = (message) => {
-                    const { type, data: status } = message.data;
-                    const { origin } = message;
-                    // ignore any broadcast postMessages
-                    if (origin !== this.getOrigin()) {
-                        return;
-                    }
-                    if (type === 'portal:wasm:legacyRecoverProgress') {
-                        void progress(status);
-                    }
-                };
-                window.addEventListener('message', handleRecover);
-                window.addEventListener('message', handleProgress);
-                this.postMessage({
-                    type: 'portal:wasm:legacyRecover',
-                    data,
-                });
-            });
-        });
-    }
     sign(data, progress = () => {
         // Noop
     }) {

package/lib/commonjs/provider/index.js

@@ -261,11 +261,10 @@ class Provider {
                 case 'eth_signTypedData_v4':
                 case 'personal_sign': {
                     const result = yield this.portal.mpc.sign({
-                        host: this.portal.host,
+                        chainId: this.portal.chainId.toString(),
                         method,
-                        mpcVersion: this.portal.mpcVersion,
                         params: this.buildParams(method, params),
-                        featureFlags: this.portal.featureFlags,
+                        rpcUrl: this.portal.getRpcUrl(),
                     });
                     return result;
                 }

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 = 'v6', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -27,6 +27,7 @@ class Portal {
         this.chainId = chainId;
         this.gatewayConfig = gatewayConfig;
         this.host = host;
+        this.mpcHost = mpcHost;
         this.mpcVersion = mpcVersion;
         this.featureFlags = featureFlags;
         if (gdrive) {
@@ -130,24 +131,6 @@ class Portal {
             return address;
         });
     }
-    /**
-     * @deprecated This method is deprecated and will be removed in a future version.
-     * Use the `recoverWallet` method instead.
-     */
-    legacyRecoverWallet(cipherText, progress = () => {
-        // Noop
-    }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const recoveredCipherText = yield this.mpc.legacyRecover({
-                cipherText,
-                host: this.host,
-                mpcVersion: this.mpcVersion,
-                featureFlags: this.featureFlags,
-            }, progress);
-            this.address = yield this.mpc.getAddress();
-            return recoveredCipherText;
-        });
-    }
     provisionWallet(cipherText, backupMethod, backupConfigs, progress = () => {
         // Noop
     }) {
@@ -155,16 +138,16 @@ class Portal {
             return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress);
         });
     }
-    ejectPrivateKey(clientBackupCiphertext, backupMethod, backupConfigs, orgBackupShare) {
+    ejectPrivateKey(clientBackupCipherText, backupMethod, backupConfigs, orgBackupShare) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (clientBackupCiphertext === '') {
-                throw new Error('clientBackupCiphertext cannot be empty string.');
+            if (clientBackupCipherText === '') {
+                throw new Error('clientBackupCipherText cannot be empty string.');
             }
             if (orgBackupShare === '') {
                 throw new Error('orgBackupShare cannot be empty string.');
             }
             const privateKey = yield this.mpc.eject({
-                cipherText: clientBackupCiphertext,
+                cipherText: clientBackupCipherText,
                 backupMethod,
                 backupConfigs,
                 organizationBackupShare: orgBackupShare,

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.0';
+const WEB_SDK_VERSION = '1.0.2';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -23,6 +23,8 @@ class Mpc {
                 passkey: this.portal.passkeyConfig,
                 host: this.portal.host,
                 rpcUrl: this.portal.getRpcUrl(),
+                mpcHost: this.portal.mpcHost,
+                mpcVersion: this.portal.mpcVersion,
                 featureFlags: this.portal.featureFlags,
             };
             const message = {
@@ -275,51 +277,6 @@ class Mpc {
             });
         });
     }
-    legacyRecover(data, progress = () => {
-        // Noop
-    }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                const handleRecover = (message) => {
-                    const { type, data } = message.data;
-                    const { origin } = message;
-                    // ignore any broadcast postMessages
-                    if (origin !== this.getOrigin()) {
-                        return;
-                    }
-                    if (type === 'portal:wasm:legacyRecoverError') {
-                        // Remove the event listeners
-                        window.removeEventListener('message', handleRecover);
-                        window.removeEventListener('message', handleProgress);
-                        reject(new PortalMpcError(data));
-                    }
-                    else if (type === 'portal:wasm:legacyRecoverResult') {
-                        // Remove the event listeners
-                        window.removeEventListener('message', handleRecover);
-                        window.removeEventListener('message', handleProgress);
-                        resolve(data);
-                    }
-                };
-                const handleProgress = (message) => {
-                    const { type, data: status } = message.data;
-                    const { origin } = message;
-                    // ignore any broadcast postMessages
-                    if (origin !== this.getOrigin()) {
-                        return;
-                    }
-                    if (type === 'portal:wasm:legacyRecoverProgress') {
-                        void progress(status);
-                    }
-                };
-                window.addEventListener('message', handleRecover);
-                window.addEventListener('message', handleProgress);
-                this.postMessage({
-                    type: 'portal:wasm:legacyRecover',
-                    data,
-                });
-            });
-        });
-    }
     sign(data, progress = () => {
         // Noop
     }) {

package/lib/esm/provider/index.js

@@ -259,11 +259,10 @@ class Provider {
                 case 'eth_signTypedData_v4':
                 case 'personal_sign': {
                     const result = yield this.portal.mpc.sign({
-                        host: this.portal.host,
+                        chainId: this.portal.chainId.toString(),
                         method,
-                        mpcVersion: this.portal.mpcVersion,
                         params: this.buildParams(method, params),
-                        featureFlags: this.portal.featureFlags,
+                        rpcUrl: this.portal.getRpcUrl(),
                     });
                     return result;
                 }

package/package.json

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

package/src/index.ts

@@ -33,6 +33,7 @@ class Portal {
   public passkeyConfig?: PasskeyConfig
   public host: string
   public mpc: Mpc
+  public mpcHost: string
   public mpcVersion: string
   public provider: Provider
   public ready = false
@@ -56,6 +57,7 @@ class Portal {
     passkey,
     host = 'web.portalhq.io',
     mpcVersion = 'v6',
+    mpcHost = 'mpc-client.portalhq.io',
     featureFlags = {
       optimized: false,
     },
@@ -67,6 +69,7 @@ class Portal {
     this.chainId = chainId
     this.gatewayConfig = gatewayConfig
     this.host = host
+    this.mpcHost = mpcHost
     this.mpcVersion = mpcVersion
     this.featureFlags = featureFlags
 
@@ -205,31 +208,6 @@ class Portal {
     return address
   }
 
-  /**
-   * @deprecated This method is deprecated and will be removed in a future version.
-   * Use the `recoverWallet` method instead.
-   */
-  public async legacyRecoverWallet(
-    cipherText: string,
-    progress: ProgressCallback = () => {
-      // Noop
-    },
-  ): Promise<string> {
-    const recoveredCipherText = await this.mpc.legacyRecover(
-      {
-        cipherText,
-        host: this.host,
-        mpcVersion: this.mpcVersion,
-        featureFlags: this.featureFlags,
-      },
-      progress,
-    )
-
-    this.address = await this.mpc.getAddress()
-
-    return recoveredCipherText
-  }
-
   public async provisionWallet(
     cipherText: string,
     backupMethod: BackupMethods,
@@ -242,13 +220,13 @@ class Portal {
   }
 
   public async ejectPrivateKey(
-    clientBackupCiphertext: string,
+    clientBackupCipherText: string,
     backupMethod: BackupMethods,
     backupConfigs: BackupConfigs,
     orgBackupShare: string,
   ): Promise<string> {
-    if (clientBackupCiphertext === '') {
-      throw new Error('clientBackupCiphertext cannot be empty string.')
+    if (clientBackupCipherText === '') {
+      throw new Error('clientBackupCipherText cannot be empty string.')
     }
 
     if (orgBackupShare === '') {
@@ -256,7 +234,7 @@ class Portal {
     }
 
     const privateKey = await this.mpc.eject({
-      cipherText: clientBackupCiphertext,
+      cipherText: clientBackupCipherText,
       backupMethod,
       backupConfigs,
       organizationBackupShare: orgBackupShare,

package/src/mpc/index.ts

@@ -9,7 +9,6 @@ import type {
   EjectArgs,
   GenerateArgs,
   IframeConfigurationOptions,
-  LegacyRecoverArgs,
   MpcOptions,
   MpcStatus,
   NFT,
@@ -26,7 +25,7 @@ import type {
   WorkerResult,
 } from '../../types'
 
-const WEB_SDK_VERSION = '1.0.0'
+const WEB_SDK_VERSION = '1.0.2'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -329,61 +328,6 @@ class Mpc {
     })
   }
 
-  public async legacyRecover(
-    data: LegacyRecoverArgs,
-    progress: ProgressCallback = () => {
-      // Noop
-    },
-  ): Promise<string> {
-    return new Promise((resolve, reject) => {
-      const handleRecover = (message: MessageEvent<WorkerResult>) => {
-        const { type, data } = message.data
-        const { origin } = message
-
-        // ignore any broadcast postMessages
-        if (origin !== this.getOrigin()) {
-          return
-        }
-
-        if (type === 'portal:wasm:legacyRecoverError') {
-          // Remove the event listeners
-          window.removeEventListener('message', handleRecover)
-          window.removeEventListener('message', handleProgress)
-
-          reject(new PortalMpcError(data as PortalError))
-        } else if (type === 'portal:wasm:legacyRecoverResult') {
-          // Remove the event listeners
-          window.removeEventListener('message', handleRecover)
-          window.removeEventListener('message', handleProgress)
-
-          resolve(data as string)
-        }
-      }
-
-      const handleProgress = (message: MessageEvent<WorkerResult>) => {
-        const { type, data: status } = message.data
-        const { origin } = message
-
-        // ignore any broadcast postMessages
-        if (origin !== this.getOrigin()) {
-          return
-        }
-
-        if (type === 'portal:wasm:legacyRecoverProgress') {
-          void progress(status as MpcStatus)
-        }
-      }
-
-      window.addEventListener('message', handleRecover)
-      window.addEventListener('message', handleProgress)
-
-      this.postMessage({
-        type: 'portal:wasm:legacyRecover',
-        data,
-      })
-    })
-  }
-
   public async sign(
     data: SignArgs,
     progress: ProgressCallback = () => {
@@ -885,6 +829,8 @@ class Mpc {
       passkey: this.portal.passkeyConfig,
       host: this.portal.host,
       rpcUrl: this.portal.getRpcUrl(),
+      mpcHost: this.portal.mpcHost,
+      mpcVersion: this.portal.mpcVersion,
       featureFlags: this.portal.featureFlags,
     }
 

package/src/provider/index.ts

@@ -303,11 +303,10 @@ class Provider {
       case 'eth_signTypedData_v4':
       case 'personal_sign': {
         const result = await this.portal.mpc.sign({
-          host: this.portal.host,
+          chainId: this.portal.chainId.toString(),
           method,
-          mpcVersion: this.portal.mpcVersion,
           params: this.buildParams(method, params),
-          featureFlags: this.portal.featureFlags,
+          rpcUrl: this.portal.getRpcUrl(),
         })
 
         return result

package/types.d.ts

@@ -22,6 +22,7 @@ export type ValidRpcErrorCodes = 4001 | 4100 | 4200 | 4900 | 4901
 // Interfaces
 
 export interface FeatureFlags {
+  isMultiBackupEnabled?: boolean
   optimized: boolean = false
 }
 
@@ -177,6 +178,15 @@ export interface DecryptResult {
   error: PortalError
 }
 
+export interface EjectArgs extends RecoverArgs {
+  organizationBackupShare: string
+}
+
+export interface EjectWorkerArgs extends MpcOperationArgs {
+  clientShare: string
+  organizationBackupShare: string
+}
+
 export interface GatewayConfig {
   [key: number]: string
 }
@@ -231,6 +241,8 @@ export interface IframeConfigurationOptions {
   passkey?: PasskeyConfig
   host: string
   rpcUrl: string
+  mpcHost: string
+  mpcVersion: string
 
   // One of these three is required for authentication
   apiKey?: string
@@ -293,6 +305,14 @@ export interface NFTContract {
   address: string
 }
 
+export interface PasskeyConfig {
+  relyingParty?: string = 'backup.web.portalhq.io'
+}
+
+export interface PasskeyStatusResponse {
+  status: PasskeyStatus
+}
+
 export interface PedersonParams {
   n: string
   s: string
@@ -325,6 +345,7 @@ export interface PortalOptions {
   gdrive?: GDriveConfig
   passkey?: PasskeyConfig
   host?: string
+  mpcHost?: string
   keychain?: KeychainAdapter
   mpcVersion?: string
   featureFlags?: FeatureFlags
@@ -375,9 +396,6 @@ export interface RequestArguments {
   params?: unknown[] | SigningRequestParams
 }
 
-export interface LegacyRecoverArgs extends MpcOperationArgs {
-  cipherText: string
-}
 export interface RecoverArgs extends MpcOperationArgs {
   cipherText: string
   backupMethod: BackupMethods
@@ -385,15 +403,6 @@ export interface RecoverArgs extends MpcOperationArgs {
   featureFlags?: FeatureFlags // TODO: Remove this
 }
 
-export interface EjectArgs extends RecoverArgs {
-  organizationBackupShare: string
-}
-
-export interface EjectWorkerArgs extends MpcOperationArgs {
-  clientShare: string
-  organizationBackupShare: string
-}
-
 export interface RotateResult {
   data: RotateData
   error: PortalError
@@ -414,10 +423,11 @@ export interface RpcErrorOptions {
   data?: unknown
 }
 
-export interface SignArgs extends MpcOperationArgs {
+export interface SignArgs {
+  chainId: string
   method: string
   params: string
-  featureFlags?: FeatureFlags
+  rpcUrl: string
 }
 
 export interface SignData {