@portal-hq/web 2.0.1 → 3.0.1

package/src/index.ts

@@ -1,24 +1,32 @@
+import {
+  Connection,
+  PublicKey,
+  Transaction as SolanaTransaction,
+  SystemProgram,
+} from '@solana/web3.js'
+
 import type {
   BackupConfigs,
   BackupResponse,
-  BackupSharePairMetadata,
   Balance,
   ClientResponse,
   EthereumTransaction,
   FeatureFlags,
   GDriveConfig,
-  GatewayLike,
+  RpcConfig,
   NFT,
   PasskeyConfig,
   PortalOptions,
   ProgressCallback,
   QuoteArgs,
   QuoteResponse,
-  SigningSharePairMetadata,
   SimulateTransactionParam,
   SimulatedTransaction,
   Transaction,
   TypedData,
+  SharesOnDeviceResponse,
+  RequestArguments,
+  EjectResult,
 } from '../types'
 import Mpc from './mpc'
 import Provider from './provider'
@@ -29,7 +37,6 @@ class Portal {
   public authToken?: string
   public authUrl?: string
   public autoApprove: boolean
-  public chainId: number
   public gDriveConfig?: GDriveConfig
   public passkeyConfig?: PasskeyConfig
   public host: string
@@ -41,19 +48,18 @@ class Portal {
   public featureFlags: FeatureFlags
 
   private errorCallbacks: ((reason: string) => any | Promise<any>)[] = []
-  private gatewayConfig: GatewayLike
+  private rpcConfig: RpcConfig
   private readyCallbacks: (() => any | Promise<any>)[] = []
 
   constructor({
     // Required
-    gatewayConfig,
+    rpcConfig,
 
     // Optional
     apiKey,
     authToken,
     authUrl,
     autoApprove = false,
-    chainId = 1,
     gdrive,
     passkey,
     host = 'web.portalhq.io',
@@ -67,8 +73,7 @@ class Portal {
     this.authToken = authToken
     this.authUrl = authUrl
     this.autoApprove = autoApprove
-    this.chainId = chainId
-    this.gatewayConfig = gatewayConfig
+    this.rpcConfig = rpcConfig
     this.host = host
     this.mpcHost = mpcHost
     this.mpcVersion = mpcVersion
@@ -220,12 +225,12 @@ class Portal {
     return this.recoverWallet(cipherText, backupMethod, backupConfigs, progress)
   }
 
-  public async ejectPrivateKey(
+  public async eject(
     clientBackupCipherText: string,
     backupMethod: BackupMethods,
     backupConfigs: BackupConfigs,
     orgBackupShare: string,
-  ): Promise<string> {
+  ): Promise<EjectResult> {
     if (clientBackupCipherText === '') {
       throw new Error('clientBackupCipherText cannot be empty string.')
     }
@@ -234,7 +239,7 @@ class Portal {
       throw new Error('orgBackupShare cannot be empty string.')
     }
 
-    const privateKey = await this.mpc.eject({
+    const { SECP256K1, ED25519 } = await this.mpc.eject({
       cipherText: clientBackupCipherText,
       backupMethod,
       backupConfigs,
@@ -244,17 +249,73 @@ class Portal {
       featureFlags: this.featureFlags,
     })
 
-    return privateKey
+    return {
+      SECP256K1,
+      ED25519,
+    }
+  }
+
+  public async getEip155Address(): Promise<string> {
+    const client = await this.mpc?.getClient()
+    const eip155Address = client?.metadata?.namespaces?.eip155?.address || ''
+    return eip155Address
+  }
+
+  public async getSolanaAddress(): Promise<string> {
+    const client = await this.mpc?.getClient()
+    const solAddress = client?.metadata?.namespaces?.solana?.address || ''
+    return solAddress
+  }
+
+  public async doesWalletExist(chainId?: string): Promise<boolean> {
+    const client = await this.mpc?.getClient()
+
+    if (chainId) {
+      const namespace = chainId?.split(':')?.[0] || ''
+      const namespaceInfo = client?.metadata?.namespaces?.[namespace]
+      return !!namespaceInfo
+    }
+
+    return client?.wallets?.length > 0
+  }
+
+  public async isWalletOnDevice(chainId?: string): Promise<boolean> {
+    const client = await this.mpc?.getClient()
+    const sharesOnDevice = await this.mpc?.checkSharesOnDevice()
+
+    if (chainId) {
+      const namespace = chainId?.split(':')?.[0] || ''
+      const curve = client?.metadata?.namespaces?.[namespace]?.curve || ''
+      return sharesOnDevice[curve as keyof SharesOnDeviceResponse] || false
+    }
+
+    return sharesOnDevice.ED25519 && sharesOnDevice.SECP256K1
   }
 
   /****************************
    * Provider Methods
    ****************************/
 
+  public async request(request: RequestArguments): Promise<any> {
+    return this.provider.request(request)
+  }
+
+  /**
+   * Estimates the amount of gas that will be required to execute an Ethereum transaction.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_estimateGas' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {EthereumTransaction} transaction - The transaction object containing the necessary transaction details.
+   * @returns {Promise<any>} A Promise that resolves to the gas estimate.
+   */
   public async ethEstimateGas(
+    chainId: string,
     transaction: EthereumTransaction,
-    chainId?: string,
   ): Promise<any> {
+    console.warn(
+      '"portal.ethEstimateGas" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_estimateGas',
@@ -262,7 +323,18 @@ class Portal {
     })
   }
 
-  public async ethGasPrice(chainId?: string): Promise<string> {
+  /**
+   * Gets the current gas price for the Ethereum network.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_gasPrice' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @returns {Promise<string>} A Promise that resolves to the current gas price.
+   */
+  public async ethGasPrice(chainId: string): Promise<string> {
+    console.warn(
+      '"portal.ethGasPrice" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_gasPrice',
@@ -270,7 +342,18 @@ class Portal {
     }) as Promise<string>
   }
 
-  public async ethGetBalance(chainId?: string): Promise<string> {
+  /**
+   * Gets the balance of the current Ethereum address.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_getBalance' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @returns {Promise<string>} A Promise that resolves to the current balance.
+   */
+  public async ethGetBalance(chainId: string): Promise<string> {
+    console.warn(
+      '"portal.ethGetBalance" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_getBalance',
@@ -278,10 +361,22 @@ class Portal {
     }) as Promise<string>
   }
 
+  /**
+   * Sends an Ethereum transaction.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_getTransactionCount' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {EthereumTransaction} transaction - The transaction object containing the necessary transaction details.
+   * @returns {Promise<string>} A Promise that resolves to the transaction hash.
+   */
   public async ethSendTransaction(
+    chainId: string,
     transaction: EthereumTransaction,
-    chainId?: string,
   ): Promise<string> {
+    console.warn(
+      '"portal.ethSendTransaction" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_sendTransaction',
@@ -289,18 +384,22 @@ class Portal {
     }) as 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>
-  }
-
+  /**
+   * Signs an Ethereum transaction.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_signTransaction' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {EthereumTransaction} transaction - The transaction object containing the necessary transaction details.
+   * @returns {Promise<string>} A Promise that resolves to the signed transaction.
+   */
   public async ethSignTransaction(
+    chainId: string,
     transaction: EthereumTransaction,
-    chainId?: string,
   ): Promise<string> {
+    console.warn(
+      '"portal.ethSignTransaction" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_signTransaction',
@@ -308,10 +407,22 @@ class Portal {
     }) as Promise<string>
   }
 
+  /**
+   * Signs an Ethereum message using EIP-712.
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_signTypedData' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {TypedData} data - The typed data object to sign.
+   * @returns {Promise<string>} A Promise that resolves to the signed message.
+   */
   public async ethSignTypedData(
+    chainId: string,
     data: TypedData,
-    chainId?: string,
   ): Promise<string> {
+    console.warn(
+      '"portal.ethSignTypedData" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_signTypedData',
@@ -319,10 +430,22 @@ class Portal {
     }) as Promise<string>
   }
 
+  /**
+   * Signs an Ethereum message using EIP-712 (legacy).
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_signTypedData_v3' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {TypedData} data - The typed data object to sign.
+   * @returns {Promise<string>} A Promise that resolves to the signed message.
+   */
   public async ethSignTypedDataV3(
+    chainId: string,
     data: TypedData,
-    chainId?: string,
   ): Promise<string> {
+    console.warn(
+      '"portal.ethSignTypedDataV3" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_signTypedData_v3',
@@ -330,10 +453,22 @@ class Portal {
     }) as Promise<string>
   }
 
+  /**
+   * Signs an Ethereum message using EIP-712 (v4).
+   *
+   * @deprecated This method is deprecated. Use `portal.request` with method 'eth_signTypedData_v4' instead.
+   *
+   * @param {string} chainId - The chain ID of the Ethereum network.
+   * @param {TypedData} data - The typed data object to sign.
+   * @returns {Promise<string>} A Promise that resolves to the signed message.
+   */
   public async ethSignTypedDataV4(
+    chainId: string,
     data: TypedData,
-    chainId?: string,
   ): Promise<string> {
+    console.warn(
+      '"portal.ethSignTypedDataV4" is deprecated. Use "portal.request" instead.',
+    )
     return this.provider.request({
       chainId,
       method: 'eth_signTypedData_v4',
@@ -341,10 +476,10 @@ class Portal {
     }) as Promise<string>
   }
 
-  public async personalSign(
-    message: string,
-    chainId?: string,
-  ): Promise<string> {
+  public async personalSign(chainId: string, message: string): Promise<string> {
+    console.warn(
+      '"portal.personalSign" is deprecated. Use "portal.request" instead.',
+    )
     return (await this.provider.request({
       chainId,
       method: 'personal_sign',
@@ -352,43 +487,162 @@ class Portal {
     })) as Promise<string>
   }
 
+  public async sendSol({
+    chainId,
+    to,
+    lamports,
+  }: {
+    chainId: string
+    to: string
+    lamports: number
+  }): Promise<string> {
+    // Ensure the chainId is solana.
+    if (!chainId.startsWith('solana:')) {
+      throw new Error(
+        '[Portal] Invalid chainId. Please provide a chainId that starts with "solana:"',
+      )
+    }
+
+    // Ensure the to address is a valid Solana address.
+    if (!to || typeof to !== 'string' || to.length !== 44) {
+      throw new Error(
+        '[Portal] Invalid "to" Solana address provided, must be 44 characters',
+      )
+    }
+
+    // Validate the lamports.
+    if (typeof lamports !== 'number' || lamports <= 0) {
+      throw new Error(
+        '[Portal] Invalid lamports amount, must be a positive number greater than 0',
+      )
+    }
+
+    // Get the most recent blockhash.
+    const blockhashResponse = await this.provider.request({
+      chainId: chainId,
+      method: 'getLatestBlockhash',
+      params: [],
+    })
+    const blockhash = blockhashResponse?.value?.blockhash || ''
+
+    // If we didn't get a blockhash, throw an error.
+    if (!blockhash) {
+      throw new Error('[Portal] Failed to get most recent blockhash')
+    }
+
+    // Get the Solana address from the client, validate the addresses.
+    const solanaAddress = await this.getSolanaAddress()
+    if (!solanaAddress) {
+      throw new Error('[Portal] Failed to get Solana address')
+    }
+
+    // Get the Solana gateway URL.
+    const gatewayUrl = this.getRpcUrl(chainId)
+    if (!gatewayUrl) {
+      throw new Error('[Portal] No RPC endpoint configured for chainId')
+    }
+
+    // Create a new connection to the Solana network.
+    new Connection(gatewayUrl, 'confirmed')
+
+    // The sender's public key.
+    const fromPublicKey = new PublicKey(solanaAddress)
+
+    // The recipient's public key.
+    const toPublicKey = new PublicKey(to)
+
+    // Create a new transaction.
+    const transaction = new SolanaTransaction().add(
+      SystemProgram.transfer({
+        fromPubkey: fromPublicKey,
+        toPubkey: toPublicKey,
+        lamports,
+      }),
+    )
+    transaction.recentBlockhash = blockhash
+    transaction.feePayer = fromPublicKey
+    const compiledMessage = transaction.compileMessage()
+
+    // Build the transaction and its message.
+    const message = {
+      accountKeys: compiledMessage.accountKeys.map((key) => key.toBase58()),
+      header: compiledMessage.header,
+      instructions: compiledMessage.instructions,
+      recentBlockhash: blockhash,
+    }
+    const formattedTransaction = {
+      signatures: null,
+      message,
+    }
+
+    // Attempt to sign and send the transaction
+    const transactionResult = await this.provider.request({
+      chainId: chainId,
+      method: 'sol_signAndSendTransaction',
+      params: [formattedTransaction],
+    })
+
+    // If we didn't get a transactionResult, throw an error.
+    if (!transactionResult) {
+      throw new Error('[Portal] Failed to send Solana transaction')
+    }
+
+    // Return the transactionResult.
+    return transactionResult
+  }
+
+  public sendEth = async ({
+    chainId,
+    to,
+    value,
+  }: {
+    chainId: string
+    to: string
+    value: string
+  }) => {
+    return this.provider.request({
+      chainId,
+      method: 'eth_sendTransaction',
+      params: [
+        {
+          from: this.address,
+          to,
+          value,
+        },
+      ],
+    })
+  }
+
   /*******************************
    * API Methods
    *******************************/
 
-  public async getBalances(): Promise<Balance[]> {
-    return await this.mpc?.getBalances()
+  public async getBalances(chainId: string): Promise<Balance[]> {
+    return await this.mpc?.getBalances(chainId)
   }
 
   public async getClient(): Promise<ClientResponse> {
     return this.mpc?.getClient()
   }
 
-  public async getNFTs(): Promise<NFT[]> {
-    return this.mpc?.getNFTs()
-  }
-
-  public async getBackupShareMetadata(): Promise<BackupSharePairMetadata[]> {
-    return this.mpc?.getBackupShareMetadata()
-  }
-
-  public async getSigningShareMetadata(): Promise<SigningSharePairMetadata[]> {
-    return this.mpc?.getSigningShareMetadata()
+  public async getNFTs(chainId: string): Promise<NFT[]> {
+    return this.mpc?.getNFTs(chainId)
   }
 
   public async getTransactions(
+    chainId: string,
     limit?: number,
     offset?: number,
     order?: GetTransactionsOrder,
-    chainId?: string,
   ): Promise<Transaction[]> {
-    return this.mpc?.getTransactions(limit, offset, order, chainId)
+    return this.mpc?.getTransactions(chainId, limit, offset, order)
   }
 
   public async simulateTransaction(
+    chainId: string,
     transaction: SimulateTransactionParam,
   ): Promise<SimulatedTransaction> {
-    return this.mpc?.simulateTransaction(transaction)
+    return this.mpc?.simulateTransaction(transaction, chainId)
   }
 
   /*******************************
@@ -398,14 +652,14 @@ class Portal {
   public async getQuote(
     apiKey: string,
     args: QuoteArgs,
-    chainId?: string,
+    chainId: string,
   ): Promise<QuoteResponse> {
     return this.mpc?.getQuote(apiKey, args, chainId)
   }
 
   public async getSources(
     apiKey: string,
-    chainId?: string,
+    chainId: string,
   ): Promise<Record<string, string>> {
     return this.mpc?.getSources(apiKey, chainId)
   }
@@ -425,31 +679,33 @@ class Portal {
    * RPC Methods
    ****************************/
 
-  public getRpcUrl() {
-    if (typeof this.gatewayConfig === 'string') {
-      // If the gatewayConfig is just a static URL, return that
-      return this.gatewayConfig
-    } else if (
-      typeof this.gatewayConfig === 'object' &&
-      // eslint-disable-next-line no-prototype-builtins
-      !this.gatewayConfig.hasOwnProperty(this.chainId)
-    ) {
-      // If there's no explicit mapping for the current chainId, error out
+  public getRpcUrl(chainId?: string) {
+    // Ensure a chainId is provided.
+    if (!chainId) {
+      throw new Error(
+        '[Portal] No chainId provided. Please provide a chainId to get the RPC endpoint',
+      )
+    }
+
+    // Ensure the chainId is configured in the rpcConfig.
+    // eslint-disable-next-line no-prototype-builtins
+    if (!this.rpcConfig.hasOwnProperty(chainId)) {
       throw new Error(
-        `[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`,
+        `[Portal] No RPC endpoint configured for chainId: ${chainId}`,
       )
     }
 
-    // Get the entry for the current chainId from the gatewayConfig
-    const config = this.gatewayConfig[this.chainId]
+    // Derive the RPC endpoint from the rpcConfig.
+    const gatewayUrl = this.rpcConfig[chainId]
 
-    if (typeof config === 'string') {
-      return config
+    // If the RPC endpoint is a string, return it as-is.
+    if (typeof gatewayUrl === 'string') {
+      return gatewayUrl
     }
 
-    // If we got this far, there's no way to support the chain with the current config
+    // Otherwise, something is wrong with the configuration.
     throw new Error(
-      `[PortalProvider] Could not find a valid gatewayConfig entry for chainId: ${this.chainId}`,
+      `[Portal] Could not find a valid rpcConfig entry for chainId: ${chainId}`,
     )
   }
 

package/src/mpc/errors/index.ts

@@ -72,7 +72,7 @@ export class MpcError extends Error {
     super(error.message(context))
 
     // Custom error context
-    this.code = error.code
+    this.code = error?.code || 999
     if (context) {
       this.context = context
     }
@@ -160,7 +160,7 @@ export class PortalMpcError extends Error {
   public constructor(error: PortalError) {
     super(error.message)
 
-    this.code = error.code
+    this.code = error?.code || 999
   }
 }