@portal-hq/web 2.0.1 → 3.0.1

package/src/mpc/index.ts

@@ -4,7 +4,6 @@ import Portal, { BackupMethods, GetTransactionsOrder } from '../index'
 import type {
   BackupArgs,
   BackupResponse,
-  BackupSharePairMetadata,
   Balance,
   ClientResponse,
   EjectArgs,
@@ -19,14 +18,15 @@ import type {
   QuoteResponse,
   RecoverArgs,
   SignArgs,
-  SigningSharePairMetadata,
   SimulateTransactionParam,
   SimulatedTransaction,
   Transaction,
+  SharesOnDeviceResponse,
   WorkerResult,
+  EjectResult,
 } from '../../types'
 
-const WEB_SDK_VERSION = '2.0.1'
+const WEB_SDK_VERSION = '3.0.1'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -87,7 +87,7 @@ class Mpc {
           const storageCallback = async () => {
             await this.setBackupStatus(
               'STORED_CLIENT_BACKUP_SHARE',
-              result.backupIds,
+              result.backupIds as string[],
             )
           }
 
@@ -306,10 +306,10 @@ class Mpc {
     })
   }
 
-  public async eject(data: EjectArgs): Promise<string> {
+  public async eject(data: EjectArgs): Promise<EjectResult> {
     return new Promise((resolve, reject) => {
       const handleEject = (message: MessageEvent<WorkerResult>) => {
-        const { type, data } = message.data
+        const { type, data: result } = message.data
         const { origin } = message
 
         // ignore any broadcast postMessages
@@ -321,12 +321,12 @@ class Mpc {
           // Remove the event listeners
           window.removeEventListener('message', handleEject)
 
-          reject(new PortalMpcError(data as PortalError))
+          reject(new PortalMpcError(result as PortalError))
         } else if (type === 'portal:wasm:ejectResult') {
           // Remove the event listeners
           window.removeEventListener('message', handleEject)
 
-          resolve(data as string)
+          resolve(result as EjectResult)
         }
       }
 
@@ -345,11 +345,6 @@ class Mpc {
       // Noop
     },
   ): Promise<string> {
-    const message = {
-      type: 'portal:wasm:sign',
-      data,
-    }
-
     return new Promise((resolve, reject) => {
       // Create a function to be bound when sign is triggered
       const handleSign = (event: MessageEvent<WorkerResult>) => {
@@ -397,7 +392,47 @@ class Mpc {
       window.addEventListener('message', handleProgress)
 
       // Send the request to the iframe
-      this.postMessage(message)
+      this.postMessage({
+        type: 'portal:wasm:sign',
+        data,
+      })
+    })
+  }
+
+  public async checkSharesOnDevice(): Promise<SharesOnDeviceResponse> {
+    return new Promise((resolve, reject) => {
+      const handleCheckSharesOnDevice = (event: MessageEvent<WorkerResult>) => {
+        const { type, data } = event.data
+        const { origin } = event
+
+        // ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:checkSharesOnDeviceError') {
+          // Remove the event listener
+          window.removeEventListener('message', handleCheckSharesOnDevice)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:checkSharesOnDeviceResult') {
+          // Remove the event listener
+          window.removeEventListener('message', handleCheckSharesOnDevice)
+
+          // Resolve the promise with the result
+          resolve(data as SharesOnDeviceResponse)
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleCheckSharesOnDevice)
+
+      // Send the request to the iframe
+      this.postMessage({
+        type: 'portal:checkSharesOnDevice',
+        data: {},
+      })
     })
   }
 
@@ -519,7 +554,7 @@ class Mpc {
   public async getQuote(
     apiKey: string,
     args: QuoteArgs,
-    chainId?: string,
+    chainId: string,
   ): Promise<QuoteResponse> {
     return new Promise((resolve, reject) => {
       const handleGetQuote = (event: MessageEvent<WorkerResult>) => {
@@ -562,7 +597,7 @@ class Mpc {
 
   public async getSources(
     apiKey: string,
-    chainId?: string,
+    chainId: string,
   ): Promise<Record<string, string>> {
     return new Promise((resolve, reject) => {
       const handleGetSources = (event: MessageEvent<WorkerResult>) => {
@@ -603,10 +638,10 @@ class Mpc {
   }
 
   public async getTransactions(
+    chainId: string,
     limit?: number,
     offset?: number,
     order?: GetTransactionsOrder,
-    chainId?: string,
   ): Promise<Transaction[]> {
     return new Promise((resolve, reject) => {
       const handleGetTransactions = (event: MessageEvent<WorkerResult>) => {
@@ -640,10 +675,10 @@ class Mpc {
       this.postMessage({
         type: 'portal:getTransactions',
         data: {
+          chainId,
           limit,
           offset,
           order,
-          chainId,
         },
       })
     })
@@ -674,7 +709,7 @@ class Mpc {
           window.removeEventListener('message', handleSetBackupStatus)
 
           // Resolve the promise with the result
-          return resolve(data)
+          return resolve(data as boolean)
         }
       }
 
@@ -779,84 +814,6 @@ class Mpc {
     })
   }
 
-  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: {},
-      })
-    })
-  }
-
   /***************************
    * Private Methods
    ***************************/
@@ -887,11 +844,9 @@ class Mpc {
       authToken: this.portal.authToken,
       authUrl: this.portal.authUrl,
       autoApprove: this.portal.autoApprove,
-      chainId: this.portal.chainId,
       gdrive: this.portal.gDriveConfig,
       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

@@ -26,6 +26,10 @@ const signerMethods = [
   'eth_signTypedData_v3',
   'eth_signTypedData_v4',
   'personal_sign',
+  'sol_signAndConfirmTransaction',
+  'sol_signAndSendTransaction',
+  'sol_signMessage',
+  'sol_signTransaction',
 ]
 
 class Provider {
@@ -118,10 +122,6 @@ class Provider {
     method,
     params,
   }: RequestArguments): Promise<any> {
-    if (method === 'eth_chainId') {
-      return chainId ? parseInt(chainId.split(':')[1]) : this.portal.chainId
-    }
-
     const isSignerMethod = signerMethods.includes(method)
 
     if (!isSignerMethod && !method.startsWith('wallet_')) {
@@ -264,16 +264,22 @@ class Provider {
     method,
     params,
   }: RequestArguments): Promise<any> {
-    // Pass request off to the gateway
-    const result = await fetch(this.portal.getRpcUrl(), {
+    // Prepare the request body
+    const requestBody = {
       body: JSON.stringify({
         jsonrpc: '2.0',
-        id: chainId ? parseInt(chainId.split(':')[1]) : this.portal.chainId,
+        id: '0',
         method,
         params,
       }),
       method: 'POST',
-    })
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    }
+
+    // Pass request off to the gateway
+    const result = await fetch(this.portal.getRpcUrl(chainId), requestBody)
 
     return result.json()
   }
@@ -301,26 +307,42 @@ class Provider {
     }
 
     switch (method) {
-      case 'eth_chainId':
-        return `0x${this.portal.chainId.toString(16)}`
+      case 'eth_chainId': {
+        this.enforceEip155ChainId(chainId)
+        const chainReferenceId = parseInt((chainId as string).split(':')[1])
+        return `0x${chainReferenceId.toString(16)}`
+      }
       case 'eth_accounts':
-      case 'eth_requestAccounts':
+      case 'eth_requestAccounts': {
+        this.enforceEip155ChainId(chainId)
         return [this.portal.address]
+      }
       case 'eth_sendTransaction':
       case 'eth_sign':
       case 'eth_signTransaction':
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
       case 'personal_sign': {
+        this.enforceEip155ChainId(chainId)
         const result = await this.portal.mpc.sign({
-          chainId: chainId
-            ? chainId.split(':')[1]
-            : this.portal.chainId.toString(),
+          chainId: chainId as string,
           method,
           params: this.buildParams(method, params),
-          rpcUrl: this.portal.getRpcUrl(),
+          rpcUrl: this.portal.getRpcUrl(chainId),
+        })
+        return result
+      }
+      case 'sol_signAndConfirmTransaction':
+      case 'sol_signAndSendTransaction':
+      case 'sol_signMessage':
+      case 'sol_signTransaction': {
+        this.enforceSolanaChainId(chainId)
+        const result = await this.portal.mpc.sign({
+          chainId: chainId as string,
+          method,
+          params: this.buildParams(method, params),
+          rpcUrl: this.portal.getRpcUrl(chainId),
         })
-
         return result
       }
       default:
@@ -330,6 +352,30 @@ class Provider {
     }
   }
 
+  private enforceEip155ChainId = (chainId?: string) => {
+    if (!chainId) {
+      throw new Error('[PortalProvider] Chain ID is required for the operation')
+    }
+
+    if (!chainId.startsWith('eip155:')) {
+      throw new Error(
+        `[PortalProvider] Chain ID must be prefixed with "eip155:" for the operation, got ${chainId}`,
+      )
+    }
+  }
+
+  private enforceSolanaChainId = (chainId?: string) => {
+    if (!chainId) {
+      throw new Error('[PortalProvider] Chain ID is required for the operation')
+    }
+
+    if (!chainId.startsWith('solana:')) {
+      throw new Error(
+        `[PortalProvider] Chain ID must be prefixed with "solana:" for the operation, got ${chainId}`,
+      )
+    }
+  }
+
   private buildParams = (method: string, txParams: any) => {
     let params = txParams
 
@@ -338,6 +384,10 @@ class Provider {
       case 'personal_sign':
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
+      case 'sol_signAndConfirmTransaction':
+      case 'sol_signAndSendTransaction':
+      case 'sol_signMessage':
+      case 'sol_signTransaction':
         if (!Array.isArray(txParams)) {
           params = [txParams]
         }

package/types.d.ts

@@ -1,13 +1,8 @@
 import { type DkgData, PortalError } from '@portal-hq/utils'
 import type { MpcErrorCodes } from './src/mpc/errors'
 
-import Api from '../iframe/core/api'
-import GDriveStorage from '../iframe/core/storage/gdrive'
-import PasskeyStorage from '../iframe/core/storage/passkey'
 import Portal from './src/index'
-import Provider from './src/provider'
 
-export type GatewayLike = GatewayConfig | string
 export type EventHandler = (event: Event<any>) => void | Promise<void>
 export type EthereumTransaction = EIP1559Transaction | LegacyTransaction
 export type MessageData =
@@ -40,19 +35,6 @@ 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
 }
@@ -87,6 +69,11 @@ export interface Balance {
   balance: string
 }
 
+export interface SharesOnDeviceResponse {
+  ED25519: boolean
+  SECP256K1: boolean
+}
+
 export interface ClientResponse {
   id: string
   address: string
@@ -179,6 +166,11 @@ export interface EIP1559Transaction {
   value?: string
 }
 
+export interface EjectResult {
+  ED25519: string
+  SECP256K1: string
+}
+
 export interface EncryptArgs {
   dkgData: string
 }
@@ -220,8 +212,8 @@ export interface EjectWorkerArgs extends MpcOperationArgs {
   organizationBackupShare: string
 }
 
-export interface GatewayConfig {
-  [key: number]: string
+export interface RpcConfig {
+  [key: string]: string
 }
 
 export interface GDriveConfig {
@@ -268,12 +260,10 @@ export interface GenerateResponse {
 
 export interface IframeConfigurationOptions {
   autoApprove: boolean
-  chainId: number
   featureFlags?: FeatureFlags
   gdrive?: GDriveConfig
   passkey?: PasskeyConfig
   host: string
-  rpcUrl: string
   mpcHost: string
   mpcVersion: string
 
@@ -355,7 +345,7 @@ export interface PedersonParams {
 export interface PortalApiOptions {
   apiKey: string
   baseUrl: string
-  chainId: number
+  chainId: string
   host: string
   portal: Portal
 }
@@ -367,14 +357,13 @@ export interface PortalError {
 
 export interface PortalOptions {
   // Required options
-  gatewayConfig: GatewayLike
+  rpcConfig: RpcConfig
 
   // Optional options
   apiKey?: string
   authToken?: string
   authUrl?: string
   autoApprove?: boolean
-  chainId?: number
   gdrive?: GDriveConfig
   passkey?: PasskeyConfig
   host?: string
@@ -517,7 +506,7 @@ export interface Transaction {
   asset: string
   blockNum: string
   category: string
-  chainId: number
+  chainId: string
   erc1155Metadata: null | string
   erc721TokenId: null | string
   from: string
@@ -537,7 +526,7 @@ export interface Transaction {
 }
 
 export interface SwitchEthereumChainParameter {
-  chainId: number
+  chainId: string
 }
 
 export interface TypedData {
@@ -578,4 +567,5 @@ export interface WorkerResult {
     | ReadyResult
     | RecoverResult
     | SignResult
+    | EjectResult
 }