@portal-hq/provider 3.0.6 → 4.0.1

package/src/providers/index.ts

@@ -1,24 +1,25 @@
 import PortalConnect from '@portal-hq/connect'
+import { PortalCurve } from '@portal-hq/core'
 import {
   Events,
   HttpRequester,
   IPortalProvider,
   InvalidApiKeyError,
-  InvalidChainIdError,
   InvalidGatewayConfigError,
   KeychainAdapter,
+  PortalRequests,
   ProviderRpcError,
   type RequestArguments,
   RpcErrorCodes,
 } from '@portal-hq/utils'
-import { RpcErrorOptions } from '@portal-hq/utils/types'
+import { AddressesByNamespace, RpcErrorOptions } from '@portal-hq/utils/types'
 
 import {
   type EventHandler,
   type GatewayLike,
   type ProviderOptions,
   type RegisteredEventHandler,
-  type SwitchEthereumChainParameter,
+  SwitchEthereumChainParameter,
 } from '../../types'
 import { MpcSigner, Signer } from '../signers'
 
@@ -38,52 +39,52 @@ const signerMethods = [
   'eth_signTypedData_v3',
   'eth_signTypedData_v4',
   'personal_sign',
+  'sol_signAndConfirmTransaction',
+  'sol_signAndSendTransaction',
+  'sol_signMessage',
+  'sol_signTransaction',
+  'raw_sign',
 ]
 
 class Provider implements IPortalProvider {
   public apiKey: string
   public autoApprove: boolean
-  public chainId: number
+  public chainId?: string
   public log: Console
-  public gateway: HttpRequester
+  public gateway: PortalRequests
 
   private events: Record<string, RegisteredEventHandler[]>
   private gatewayConfig: GatewayLike
-  private isSimulator: boolean
   private keychain: KeychainAdapter
   private readonly portalApi: HttpRequester
   private signer: Signer
 
-  public get address(): Promise<string | undefined> {
-    return this.keychain.getAddress(this.isSimulator)
+  public get addresses(): Promise<AddressesByNamespace | undefined> {
+    return this.keychain.getAddresses()
   }
 
-  public get gatewayUrl(): string {
-    return this.getGatewayUrl()
+  public get address(): Promise<string | undefined> {
+    return this.keychain.getAddress()
   }
 
   constructor({
     // Required
     apiKey,
-    chainId,
     keychain,
     gatewayConfig,
 
     // Optional
-    isSimulator = false,
     autoApprove = false,
     apiHost = 'api.portalhq.io',
     mpcHost = 'mpc.portalhq.io',
     version = 'v6',
-    featureFlags = { optimized: false },
+    chainId = 'eip155:11155111',
+    featureFlags = {},
   }: ProviderOptions) {
     // Handle required fields
     if (!apiKey || apiKey.length === 0) {
       throw new InvalidApiKeyError()
     }
-    if (!chainId) {
-      throw new InvalidChainIdError()
-    }
     if (!gatewayConfig) {
       throw new InvalidGatewayConfigError()
     }
@@ -94,7 +95,6 @@ class Provider implements IPortalProvider {
     this.chainId = chainId
     this.events = {}
     this.gatewayConfig = gatewayConfig
-    this.isSimulator = isSimulator
     this.keychain = keychain
 
     // Add a logger
@@ -108,9 +108,7 @@ class Provider implements IPortalProvider {
     })
 
     // Initialize Gateway HttpRequester
-    this.gateway = new HttpRequester({
-      baseUrl: this.getGatewayUrl(),
-    })
+    this.gateway = new PortalRequests()
 
     // Initialize an MpcSigner
     this.signer = new MpcSigner({
@@ -149,23 +147,27 @@ class Provider implements IPortalProvider {
    *
    * @returns string
    */
-  public getGatewayUrl(): string {
+  public getGatewayUrl(chainId?: string): string {
+    chainId = chainId ?? this.chainId
+    if (!chainId) {
+      throw new Error('[PortalProvider] No chainId provided')
+    }
     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)
+      !this.gatewayConfig.hasOwnProperty(chainId)
     ) {
       // If there's no explicit mapping for the current chainId, error out
       throw new Error(
-        `[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`,
+        `[PortalProvider] No RPC endpoint configured for chainId: ${chainId}`,
       )
     }
 
     // Get the entry for the current chainId from the gatewayConfig
-    const config = this.gatewayConfig[this.chainId]
+    const config = this.gatewayConfig[chainId]
 
     if (typeof config === 'string') {
       return config
@@ -173,7 +175,7 @@ class Provider implements IPortalProvider {
 
     // If we got this far, there's no way to support the chain with the current config
     throw new Error(
-      `[PortalProvider] Could not find a valid gatewayConfig entry for chainId: ${this.chainId}`,
+      `[PortalProvider] Could not find a valid gatewayConfig entry for chainId: ${chainId}`,
     )
   }
 
@@ -259,8 +261,18 @@ class Provider implements IPortalProvider {
     chainId,
     connect,
   }: RequestArguments): Promise<any> {
+    chainId = chainId ?? this.chainId
+    if (!chainId) {
+      throw new Error('[PortalProvider] No chainId provided')
+    }
     if (method === 'eth_chainId') {
-      return this.chainId
+      if (typeof chainId === 'string' && chainId.includes(':')) {
+        return chainId.split(':')[1]
+      } else {
+        throw new Error(
+          "[PortalProvider] Invalid chainId format. Must be 'namespace:reference'",
+        )
+      }
     }
 
     // Handle changing chains
@@ -268,7 +280,7 @@ class Provider implements IPortalProvider {
       const param = (params as any[])[0]
       const chainId = parseInt(param.chainId as string, 16)
 
-      this.chainId = chainId
+      this.chainId = `eip155:${String(chainId)}`
 
       this.emit('portal_signatureReceived', {
         method,
@@ -282,7 +294,11 @@ class Provider implements IPortalProvider {
     let result: any
     if (!isSignerMethod && !method.startsWith('wallet_')) {
       // Send to Gateway for RPC calls
-      const response = await this.handleGatewayRequests({ method, params })
+      const response = await this.handleGatewayRequests({
+        method,
+        params,
+        chainId,
+      })
 
       this.emit('portal_signatureReceived', {
         method,
@@ -304,6 +320,24 @@ class Provider implements IPortalProvider {
         connect,
       })
 
+      if (transactionHash) {
+        try {
+          await this.portalApi.post('/api/v1/analytics/track', {
+            headers: {
+              Authentication: `Bearer ${this.apiKey}`,
+            },
+            body: {
+              event: Events.TransactionSigned,
+              properties: {
+                method,
+              },
+            },
+          })
+        } catch (error) {
+          // Do nothing, because we don't want metrics gathering
+          // to block the SDK
+        }
+      }
       if (transactionHash) {
         this.emit('portal_signatureReceived', {
           method,
@@ -326,7 +360,6 @@ class Provider implements IPortalProvider {
 
     return result
   }
-
   /**
    * Updates the chainId of this instance and builds a new RPC HttpRequester for
    * the gateway used for the new chain
@@ -335,29 +368,35 @@ class Provider implements IPortalProvider {
    * @returns BaseProvider
    */
   public async setChainId(
-    chainId: number,
+    chainId: string | number,
     connect?: PortalConnect,
-  ): Promise<Provider> {
+  ): Promise<IPortalProvider> {
+    if (typeof chainId === 'number') {
+      chainId = `eip155:${String(chainId)}`
+    }
     // Update the chainId
     this.chainId = chainId
+    if (chainId.includes(':')) {
+      const chainIdParts = chainId.split(':')
+      const reference = parseInt(chainIdParts[1])
 
-    // Re-initialize the Gateway HttpRequester
-    this.gateway = new HttpRequester({
-      baseUrl: this.getGatewayUrl(),
-    })
-
-    // Emit event for update
-    this.emit('chainChanged', {
-      chainId: this.chainId,
-    } as SwitchEthereumChainParameter)
-
-    if (connect && connect.connected) {
-      connect.emit('portalConnect_chainChanged', {
-        chainId: this.chainId,
+      // Emit event for update
+      this.emit('chainChanged', {
+        chainId: reference,
       } as SwitchEthereumChainParameter)
+
+      if (connect && connect.connected) {
+        connect.emit('portalConnect_chainChanged', {
+          chainId: reference,
+        } as SwitchEthereumChainParameter)
+      }
+      // Dispatch 'connect' event
+      this.dispatchConnect(chainId)
+    } else {
+      console.error(
+        `[PortalProvider] Invalid chainId format. Must be 'namespace:reference', but got ${chainId}`,
+      )
     }
-    // Dispatch 'connect' event
-    this.dispatchConnect()
 
     return new Promise((resolve) => resolve(this))
   }
@@ -444,9 +483,10 @@ class Provider implements IPortalProvider {
     })
   }
 
-  private dispatchConnect() {
+  private dispatchConnect(chainId: string) {
+    const reference = chainId.split(':')[1]
     this.emit('connect', {
-      chainId: `0x${this.chainId.toString(16)}`,
+      chainId: `0x${Number(reference).toString(16)}`,
     })
   }
 
@@ -459,12 +499,15 @@ class Provider implements IPortalProvider {
   private async handleGatewayRequests({
     method,
     params,
+    chainId,
   }: RequestArguments): Promise<any> {
+    const gatewayUrl = this.getGatewayUrl(chainId)
     // Pass request off to the gateway
-    return await this.gateway.post<any>('', {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return await this.gateway.post<any>(gatewayUrl, '', {
       body: {
         jsonrpc: '2.0',
-        id: this.chainId,
+        id: chainId,
         method,
         params,
       },
@@ -493,10 +536,20 @@ class Provider implements IPortalProvider {
       )
       return
     }
+    let namespace = 'eip155'
+    let reference = chainId
+    if (typeof chainId == 'string' && chainId.includes(':')) {
+      const tmp = chainId.split(':')
+      namespace = tmp[0]
+      reference = tmp[1]
+    }
+
+    const curve =
+      namespace == 'eip155' ? PortalCurve.SECP256K1 : PortalCurve.ED25519
 
     switch (method) {
       case 'eth_chainId':
-        return `0x${this.chainId.toString(16)}`
+        return `0x${Number(reference).toString(16)}`
       case 'eth_accounts':
       case 'eth_requestAccounts':
       case 'eth_sendTransaction':
@@ -504,30 +557,35 @@ class Provider implements IPortalProvider {
       case 'eth_signTransaction':
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
-      case 'personal_sign': {
+      case 'personal_sign':
+      case 'sol_signAndConfirmTransaction':
+      case 'sol_signAndSendTransaction':
+      case 'sol_signMessage':
+      case 'sol_signTransaction': {
         const result = await this.signer?.sign(
-          { chainId: this.chainId, method, params },
+          {
+            chainId: `${namespace}:${reference}`,
+            method,
+            params,
+            curve,
+            isRaw: false,
+          },
           this,
         )
 
-        if (result) {
-          try {
-            await this.portalApi.post('/api/v1/analytics/track', {
-              headers: {
-                Authentication: `Bearer ${this.apiKey}`,
-              },
-              body: {
-                event: Events.TransactionSigned,
-                properties: {
-                  method,
-                },
-              },
-            })
-          } catch (error) {
-            // Do nothing, because we don't want metrics gathering
-            // to block the SDK
-          }
-        }
+        return result
+      }
+      case 'raw_sign': {
+        const result = await this.signer?.sign(
+          {
+            chainId: '',
+            method: '',
+            params,
+            curve,
+            isRaw: true,
+          },
+          this,
+        )
 
         return result
       }

package/src/signers/mpc.ts

@@ -1,3 +1,4 @@
+import { PortalCurve } from '@portal-hq/core'
 import { FeatureFlags } from '@portal-hq/core/types'
 import {
   IPortalProvider,
@@ -16,29 +17,18 @@ import {
 import Signer from './abstract'
 
 class MpcSigner implements Signer {
-  private isSimulator: boolean
   private keychain: KeychainAdapter
   private mpc: PortalMobileMpc
   private mpcHost: string // should we add a default here mpc.portalhq.io
   private version = 'v6'
   private featureFlags: FeatureFlags
 
-  private get address(): Promise<string | undefined> {
-    return this.keychain.getAddress(this.isSimulator)
-  }
-
-  private get signingShare(): Promise<string> {
-    return this.keychain.getDkgResult(this.isSimulator)
-  }
-
   constructor({
     keychain,
-    isSimulator = false,
     mpcHost = 'mpc.portalhq.io',
     version = 'v6',
-    featureFlags = { optimized: false },
+    featureFlags = {},
   }: MpcSignerOptions) {
-    this.isSimulator = isSimulator
     this.keychain = keychain
     this.mpc = NativeModules.PortalMobileMpc
     this.mpcHost = mpcHost
@@ -56,37 +46,71 @@ class MpcSigner implements Signer {
     message: SigningRequestArguments,
     provider: IPortalProvider,
   ): Promise<any> {
-    const address = await this.address
+    const eip155Address = await this.keychain.getEip155Address()
+
     const apiKey = provider.apiKey
 
-    const { method, params } = message
+    const { method, chainId, curve, isRaw } = message
 
     switch (method) {
       case 'eth_requestAccounts':
-        return [address]
+        return [eip155Address]
       case 'eth_accounts':
-        return [address]
+        return [eip155Address]
       default:
         break
     }
 
-    const signingShare = await this.signingShare
+    const shares = await this.keychain.getShares()
+
+    let signingShare = shares.secp256k1.share
+
+    if (curve === PortalCurve.ED25519) {
+      if (!shares.ed25519) {
+        throw new Error(
+          '[Portal.Provider.MpcSigner] The ED25519 share is missing from the keychain.',
+        )
+      }
+      signingShare = shares.ed25519.share
+    }
 
     const metadata: PortalMobileMpcMetadata = {
       clientPlatform: 'REACT_NATIVE',
       isMultiBackupEnabled: this.featureFlags.isMultiBackupEnabled,
       mpcServerVersion: this.version,
-      optimized: this.featureFlags.optimized,
+      optimized: true,
+      curve,
+      chainId,
+      isRaw,
     }
+
     const stringifiedMetadata = JSON.stringify(metadata)
+
+    let formattedParams: string
+    let rpcUrl: string
+
+    if (isRaw) {
+      formattedParams = this.buildParams(method, message.params)
+      rpcUrl = ''
+    } else {
+      formattedParams = JSON.stringify(this.buildParams(method, message.params))
+      rpcUrl = provider.getGatewayUrl(chainId)
+    }
+
+    if (typeof formattedParams !== 'string') {
+      throw new Error(
+        `[Portal.Provider.MpcSigner] The formatted params for the signing request could not be converted to a string. The params were: ${formattedParams}`,
+      )
+    }
+
     const result = await this.mpc.sign(
       apiKey,
       this.mpcHost,
-      signingShare,
+      JSON.stringify(signingShare),
       message.method,
-      JSON.stringify(this.buildParams(method, params)),
-      provider.gatewayUrl,
-      provider.chainId.toString(),
+      formattedParams,
+      rpcUrl,
+      chainId,
       stringifiedMetadata,
     )
 
@@ -107,16 +131,21 @@ class MpcSigner implements Signer {
       case 'personal_sign':
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
+      case 'sol_signMessage':
+      case 'sol_signTransaction':
+      case 'sol_signAndSendTransaction':
+      case 'sol_signAndConfirmTransaction':
         if (!Array.isArray(txParams)) {
           params = [txParams]
         }
         break
       default:
         if (Array.isArray(txParams)) {
-          params = txParams[0]
+          if (txParams.length === 1) {
+            params = txParams[0]
+          }
         }
     }
-
     return params
   }
 }

package/types.d.ts

@@ -12,7 +12,7 @@ export type ValidHttpRequestMethods = 'DELETE' | 'GET' | 'POST' | 'PUT'
 // Interfaces
 
 export interface GatewayConfig {
-  [key: number]: string
+  [key: string]: string
 }
 
 export interface MpcSignerOptions extends SignerOptions {
@@ -33,10 +33,13 @@ export interface PortalMobileMpcMetadata {
     | 'PASSKEY'
     | 'PASSWORD'
     | 'UNKNOWN'
+  chainId?: string
+  curve?: PortalCurve
   clientPlatform: string
   isMultiBackupEnabled?: boolean
   mpcServerVersion: string
-  optimized: boolean
+  optimized: true
+  isRaw?: boolean
 }
 
 export interface PortalMobileMpc {
@@ -67,11 +70,11 @@ export interface PortalMobileMpc {
 export interface ProviderOptions {
   // Required
   apiKey: string
-  chainId: number
   keychain: KeychainAdapter
   gatewayConfig: GatewayLike
 
   // Optional
+  chainId?: string
   isSimulator?: boolean
   autoApprove?: boolean
   apiHost?: string