@portal-hq/web 0.0.8 → 0.1.1

package/lib/commonjs/index.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BackupMethods = exports.MpcStatuses = exports.MpcErrorCodes = exports.MpcError = void 0;
+exports.GetTransactionsOrder = exports.BackupMethods = exports.MpcStatuses = exports.MpcErrorCodes = exports.MpcError = void 0;
 const mpc_1 = __importDefault(require("./mpc"));
 const provider_1 = __importDefault(require("./provider"));
 class Portal {
@@ -20,7 +20,7 @@ class Portal {
     // Required
     gatewayConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -38,6 +38,9 @@ class Portal {
         if (gdrive) {
             this.gDriveConfig = gdrive;
         }
+        else if (passkey) {
+            this.passkeyConfig = passkey;
+        }
         this.mpc = new mpc_1.default({
             portal: this,
         });
@@ -117,7 +120,7 @@ class Portal {
             return cipherText;
         });
     }
-    recoverWallet(cipherText, backupMethod, backupConfigs, progress = () => {
+    recoverWallet(cipherText, backupMethod, backupConfigs = {}, progress = () => {
         // Noop
     }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -129,6 +132,7 @@ class Portal {
                 mpcVersion: this.mpcVersion,
                 featureFlags: this.featureFlags,
             }, progress);
+            this.address = address;
             return address;
         });
     }
@@ -157,6 +161,26 @@ class Portal {
             return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress);
         });
     }
+    ejectPrivateKey(clientBackupCiphertext, backupMethod, backupConfigs, orgBackupShare) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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,
+                backupMethod,
+                backupConfigs,
+                organizationBackupShare: orgBackupShare,
+                host: this.host,
+                mpcVersion: this.mpcVersion,
+                featureFlags: this.featureFlags,
+            });
+            return privateKey;
+        });
+    }
     /****************************
      * Provider Methods
      ****************************/
@@ -354,5 +378,11 @@ var BackupMethods;
 (function (BackupMethods) {
     BackupMethods["gdrive"] = "GDRIVE";
     BackupMethods["password"] = "PASSWORD";
+    BackupMethods["passkey"] = "PASSKEY";
 })(BackupMethods = exports.BackupMethods || (exports.BackupMethods = {}));
+var GetTransactionsOrder;
+(function (GetTransactionsOrder) {
+    GetTransactionsOrder["ASC"] = "asc";
+    GetTransactionsOrder["DESC"] = "desc";
+})(GetTransactionsOrder = exports.GetTransactionsOrder || (exports.GetTransactionsOrder = {}));
 exports.default = Portal;

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.0.8';
+const WEB_SDK_VERSION = '0.1.1';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -23,6 +23,7 @@ class Mpc {
                 autoApprove: this.portal.autoApprove,
                 chainId: this.portal.chainId,
                 gdrive: this.portal.gDriveConfig,
+                passkey: this.portal.passkeyConfig,
                 host: this.portal.host,
                 rpcUrl: this.portal.getRpcUrl(),
                 featureFlags: this.portal.featureFlags,
@@ -248,6 +249,35 @@ class Mpc {
             });
         });
     }
+    eject(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleEject = (message) => {
+                    const { type, data } = message.data;
+                    const { origin } = message;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:wasm:ejectError') {
+                        // Remove the event listeners
+                        window.removeEventListener('message', handleEject);
+                        reject(new errors_1.PortalMpcError(data));
+                    }
+                    else if (type === 'portal:wasm:ejectResult') {
+                        // Remove the event listeners
+                        window.removeEventListener('message', handleEject);
+                        resolve(data);
+                    }
+                };
+                window.addEventListener('message', handleEject);
+                this.postMessage({
+                    type: 'portal:wasm:eject',
+                    data,
+                });
+            });
+        });
+    }
     legacyRecover(data, progress = () => {
         // Noop
     }) {

package/lib/esm/index.js

@@ -14,7 +14,7 @@ class Portal {
     // Required
     gatewayConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
+    apiKey, authToken, authUrl, autoApprove = false, chainId = 1, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v5', featureFlags = {
         optimized: false,
     }, }) {
         this.ready = false;
@@ -32,6 +32,9 @@ class Portal {
         if (gdrive) {
             this.gDriveConfig = gdrive;
         }
+        else if (passkey) {
+            this.passkeyConfig = passkey;
+        }
         this.mpc = new Mpc({
             portal: this,
         });
@@ -111,7 +114,7 @@ class Portal {
             return cipherText;
         });
     }
-    recoverWallet(cipherText, backupMethod, backupConfigs, progress = () => {
+    recoverWallet(cipherText, backupMethod, backupConfigs = {}, progress = () => {
         // Noop
     }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -123,6 +126,7 @@ class Portal {
                 mpcVersion: this.mpcVersion,
                 featureFlags: this.featureFlags,
             }, progress);
+            this.address = address;
             return address;
         });
     }
@@ -151,6 +155,26 @@ class Portal {
             return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress);
         });
     }
+    ejectPrivateKey(clientBackupCiphertext, backupMethod, backupConfigs, orgBackupShare) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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,
+                backupMethod,
+                backupConfigs,
+                organizationBackupShare: orgBackupShare,
+                host: this.host,
+                mpcVersion: this.mpcVersion,
+                featureFlags: this.featureFlags,
+            });
+            return privateKey;
+        });
+    }
     /****************************
      * Provider Methods
      ****************************/
@@ -346,5 +370,11 @@ export var BackupMethods;
 (function (BackupMethods) {
     BackupMethods["gdrive"] = "GDRIVE";
     BackupMethods["password"] = "PASSWORD";
+    BackupMethods["passkey"] = "PASSKEY";
 })(BackupMethods || (BackupMethods = {}));
+export var GetTransactionsOrder;
+(function (GetTransactionsOrder) {
+    GetTransactionsOrder["ASC"] = "asc";
+    GetTransactionsOrder["DESC"] = "desc";
+})(GetTransactionsOrder || (GetTransactionsOrder = {}));
 export default Portal;

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.0.8';
+const WEB_SDK_VERSION = '0.1.1';
 class Mpc {
     constructor({ portal }) {
         this.configureIframe = () => {
@@ -20,6 +20,7 @@ class Mpc {
                 autoApprove: this.portal.autoApprove,
                 chainId: this.portal.chainId,
                 gdrive: this.portal.gDriveConfig,
+                passkey: this.portal.passkeyConfig,
                 host: this.portal.host,
                 rpcUrl: this.portal.getRpcUrl(),
                 featureFlags: this.portal.featureFlags,
@@ -245,6 +246,35 @@ class Mpc {
             });
         });
     }
+    eject(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleEject = (message) => {
+                    const { type, data } = message.data;
+                    const { origin } = message;
+                    // ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:wasm:ejectError') {
+                        // Remove the event listeners
+                        window.removeEventListener('message', handleEject);
+                        reject(new PortalMpcError(data));
+                    }
+                    else if (type === 'portal:wasm:ejectResult') {
+                        // Remove the event listeners
+                        window.removeEventListener('message', handleEject);
+                        resolve(data);
+                    }
+                };
+                window.addEventListener('message', handleEject);
+                this.postMessage({
+                    type: 'portal:wasm:eject',
+                    data,
+                });
+            });
+        });
+    }
     legacyRecover(data, progress = () => {
         // Noop
     }) {

package/package.json

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

package/src/index.ts

@@ -6,9 +6,9 @@ import type {
   FeatureFlags,
   GDriveConfig,
   GatewayLike,
-  GetTransactionsOrder,
   NFT,
   PortalOptions,
+  PasskeyConfig,
   ProgressCallback,
   QuoteArgs,
   QuoteResponse,
@@ -28,6 +28,7 @@ class Portal {
   public autoApprove: boolean
   public chainId: number
   public gDriveConfig?: GDriveConfig
+  public passkeyConfig?: PasskeyConfig
   public host: string
   public mpc: Mpc
   public mpcVersion: string
@@ -50,6 +51,7 @@ class Portal {
     autoApprove = false,
     chainId = 1,
     gdrive,
+    passkey,
     host = 'web.portalhq.io',
     mpcVersion = 'v5',
     featureFlags = {
@@ -68,6 +70,8 @@ class Portal {
 
     if (gdrive) {
       this.gDriveConfig = gdrive
+    } else if (passkey) {
+      this.passkeyConfig = passkey
     }
 
     this.mpc = new Mpc({
@@ -176,7 +180,7 @@ class Portal {
   public async recoverWallet(
     cipherText: string,
     backupMethod: BackupMethods,
-    backupConfigs: BackupConfigs,
+    backupConfigs: BackupConfigs = {},
     progress: ProgressCallback = () => {
       // Noop
     },
@@ -193,6 +197,8 @@ class Portal {
       progress,
     )
 
+    this.address = address
+
     return address
   }
 
@@ -232,6 +238,35 @@ class Portal {
     return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress)
   }
 
+  public async ejectPrivateKey(
+    clientBackupCiphertext: string,
+    backupMethod: BackupMethods,
+    backupConfigs: BackupConfigs,
+    orgBackupShare: string,
+  ): Promise<string> {
+    if (clientBackupCiphertext === '') {
+      throw new Error('clientBackupCiphertext cannot be empty string.')
+    }
+
+    if (orgBackupShare === '') {
+      throw new Error('orgBackupShare cannot be empty string.')
+    }
+    
+    const privateKey = await this.mpc.eject(
+      {
+        cipherText: clientBackupCiphertext,
+        backupMethod,
+        backupConfigs,
+        organizationBackupShare: orgBackupShare,
+        host: this.host,
+        mpcVersion: this.mpcVersion,
+        featureFlags: this.featureFlags,
+      }
+    )
+
+    return privateKey
+  }
+
   /****************************
    * Provider Methods
    ****************************/
@@ -440,6 +475,12 @@ export enum MpcStatuses {
 export enum BackupMethods {
   gdrive = 'GDRIVE',
   password = 'PASSWORD',
+  passkey = 'PASSKEY',
+}
+
+export enum GetTransactionsOrder {
+  ASC = 'asc',
+  DESC = 'desc',
 }
 
 export default Portal

package/src/mpc/index.ts

@@ -1,12 +1,12 @@
 import { PortalMpcError } from './errors'
 
-import Portal, { BackupMethods } from '../index'
+import Portal, { BackupMethods, GetTransactionsOrder } from '../index'
 import type {
   BackupArgs,
   Balance,
   ClientWithCustodianData,
+  EjectArgs,
   GenerateArgs,
-  GetTransactionsOrder,
   IframeConfigurationOptions,
   LegacyRecoverArgs,
   MpcOptions,
@@ -24,7 +24,7 @@ import type {
   WorkerResult,
 } from '../../types'
 
-const WEB_SDK_VERSION = '0.0.8'
+const WEB_SDK_VERSION = '0.1.1'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -294,6 +294,42 @@ class Mpc {
     })
   }
 
+
+  public async eject(
+    data: EjectArgs,
+  ): Promise<string> {
+    return new Promise((resolve, reject) => {
+      const handleEject = (message: MessageEvent<WorkerResult>) => {
+        const { type, data } = message.data
+        const { origin } = message
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:wasm:ejectError') {
+          // Remove the event listeners
+          window.removeEventListener('message', handleEject)
+
+          reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:wasm:ejectResult') {
+          // Remove the event listeners
+          window.removeEventListener('message', handleEject)
+
+          resolve(data as string)
+        }
+      }
+
+      window.addEventListener('message', handleEject)
+
+      this.postMessage({
+        type: 'portal:wasm:eject',
+        data,
+      })
+    })
+  }
+
   public async legacyRecover(
     data: LegacyRecoverArgs,
     progress: ProgressCallback = () => {
@@ -764,6 +800,7 @@ class Mpc {
       autoApprove: this.portal.autoApprove,
       chainId: this.portal.chainId,
       gdrive: this.portal.gDriveConfig,
+      passkey: this.portal.passkeyConfig,
       host: this.portal.host,
       rpcUrl: this.portal.getRpcUrl(),
       featureFlags: this.portal.featureFlags,

package/types.d.ts

@@ -18,7 +18,7 @@ export type MessageData =
   | SignArgs
 export type ProgressCallback = (status: MpcStatus) => void | Promise<void>
 export type ValidRpcErrorCodes = 4001 | 4100 | 4200 | 4900 | 4901
-
+export type PasskeyConfig = PasskeyConfig
 // Interfaces
 
 export interface FeatureFlags {
@@ -178,6 +178,14 @@ export interface GDriveStorageOptions {
 
 export type GenerateArgs = MpcOperationArgs
 
+export interface PasskeyConfig {
+  relyingParty?: string = 'backup.web.portalhq.io'
+}
+
+export interface PasskeyStatusResponse {
+  status: PasskeyStatus
+}
+
 export interface GenerateData {
   address: string
   dkgResult: DkgData
@@ -199,6 +207,7 @@ export interface IframeConfigurationOptions {
   chainId: number
   featureFlags?: FeatureFlags
   gdrive?: GDriveConfig
+  passkey?: PasskeyConfig
   host: string
   rpcUrl: string
 
@@ -293,6 +302,7 @@ export interface PortalOptions {
   autoApprove?: boolean
   chainId?: number
   gdrive?: GDriveConfig
+  passkey?: PasskeyConfig
   host?: string
   keychain?: KeychainAdapter
   mpcVersion?: string
@@ -354,6 +364,15 @@ 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
@@ -429,11 +448,6 @@ export interface SimulatedTransaction {
   requestError?: SimulatedTransactionError
 }
 
-export enum GetTransactionsOrder {
-  ASC = 'asc',
-  DESC = 'desc',
-}
-
 export interface Transaction {
   asset: string
   blockNum: string