@portal-hq/web 3.2.3 → 3.3.1

package/src/provider/index.ts

@@ -10,26 +10,149 @@ import type {
   RpcErrorOptions,
 } from '../../types'
 
+export enum RequestMethod {
+  eth_accounts = 'eth_accounts',
+  eth_blockNumber = 'eth_blockNumber',
+  eth_call = 'eth_call',
+  eth_chainId = 'eth_chainId',
+  eth_coinbase = 'eth_coinbase',
+  eth_compileSolidity = 'eth_compileSolidity',
+  eth_compileLLL = 'eth_compileLLL',
+  eth_compileSerpent = 'eth_compileSerpent',
+  eth_estimateGas = 'eth_estimateGas',
+  eth_gasPrice = 'eth_gasPrice',
+  eth_getBalance = 'eth_getBalance',
+  eth_getBlockByHash = 'eth_getBlockByHash',
+  eth_getBlockByNumber = 'eth_getBlockByNumber',
+  eth_getBlockTransactionCountByHash = 'eth_getBlockTransactionCountByHash',
+  eth_getBlockTransactionCountByNumber = 'eth_getBlockTransactionCountByNumber',
+  eth_getCode = 'eth_getCode',
+  eth_getCompilers = 'eth_getCompilers',
+  eth_getFilterChange = 'eth_getFilterChange',
+  eth_getFilterLogs = 'eth_getFilterLogs',
+  eth_getLogs = 'eth_getLogs',
+  eth_getStorageAt = 'eth_getStorageAt',
+  eth_getTransactionByHash = 'eth_getTransactionByHash',
+  eth_getTransactionByBlockHashAndIndex = 'eth_getTransactionByBlockHashAndIndex',
+  eth_getTransactionByBlockNumberAndIndex = 'eth_getTransactionByBlockNumberAndIndex',
+  eth_getTransactionCount = 'eth_getTransactionCount',
+  eth_getTransactionReceipt = 'eth_getTransactionReceipt',
+  eth_getUncleByBlockHashAndIndex = 'eth_getUncleByBlockHashAndIndex',
+  eth_getUncleByBlockNumberAndIndex = 'eth_getUncleByBlockNumberAndIndex',
+  eth_getUncleCountByBlockHash = 'eth_getUncleCountByBlockHash',
+  eth_getUncleCountByBlockNumber = 'eth_getUncleCountByBlockNumber',
+  eth_getWork = 'eth_getWork',
+  eth_hashrate = 'eth_hashrate',
+  eth_mining = 'eth_mining',
+  eth_newBlockFilter = 'eth_newBlockFilter',
+  eth_newFilter = 'eth_newFilter',
+  eth_newPendingTransactionFilter = 'eth_newPendingTransactionFilter',
+  personal_sign = 'personal_sign',
+  eth_protocolVersion = 'eth_protocolVersion',
+  eth_requestAccounts = 'eth_requestAccounts',
+  eth_sendRawTransaction = 'eth_sendRawTransaction',
+  eth_sendTransaction = 'eth_sendTransaction',
+  eth_sign = 'eth_sign',
+  eth_signTransaction = 'eth_signTransaction',
+  eth_signTypedData = 'eth_signTypedData',
+  eth_signTypedData_v3 = 'eth_signTypedData_v3',
+  eth_signTypedData_v4 = 'eth_signTypedData_v4',
+  eth_submitHashrate = 'eth_submitHashrate',
+  eth_submitWork = 'eth_submitWork',
+  eth_syncing = 'eth_syncing',
+  eth_uninstallFilter = 'eth_uninstallFilter',
+
+  // Net Methods
+  net_listening = 'net_listening',
+  net_peerCount = 'net_peerCount',
+  net_version = 'net_version',
+
+  // Web3 Methods
+  web3_clientVersion = 'web3_clientVersion',
+  web3_sha3 = 'web3_sha3',
+
+  // Solana RPC Methods
+  sol_getAccountInfo = 'getAccountInfo',
+  sol_getBalance = 'getBalance',
+  sol_getBlock = 'getBlock',
+  sol_getBlockCommitment = 'getBlockCommitment',
+  sol_getBlockHeight = 'getBlockHeight',
+  sol_getBlockProduction = 'getBlockProduction',
+  sol_getBlockTime = 'getBlockTime',
+  sol_getBlocks = 'getBlocks',
+  sol_getBlocksWithLimit = 'getBlocksWithLimit',
+  sol_getClusterNodes = 'getClusterNodes',
+  sol_getEpochInfo = 'getEpochInfo',
+  sol_getEpochSchedule = 'getEpochSchedule',
+  sol_getFeeForMessage = 'getFeeForMessage',
+  sol_getFirstAvailableBlock = 'getFirstAvailableBlock',
+  sol_getGenesisHash = 'getGenesisHash',
+  sol_getHealth = 'getHealth',
+  sol_getHighestSnapshotSlot = 'getHighestSnapshotSlot',
+  sol_getIdentity = 'getIdentity',
+  sol_getInflationGovernor = 'getInflationGovernor',
+  sol_getInflationRate = 'getInflationRate',
+  sol_getInflationReward = 'getInflationReward',
+  sol_getLargestAccounts = 'getLargestAccounts',
+  sol_getLatestBlockhash = 'getLatestBlockhash',
+  sol_getLeaderSchedule = 'getLeaderSchedule',
+  sol_getMaxRetransmitSlot = 'getMaxRetransmitSlot',
+  sol_getMaxShredInsertSlot = 'getMaxShredInsertSlot',
+  sol_getMinimumBalanceForRentExemption = 'getMinimumBalanceForRentExemption',
+  sol_getMultipleAccounts = 'getMultipleAccounts',
+  sol_getProgramAccounts = 'getProgramAccounts',
+  sol_getRecentPerformanceSamples = 'getRecentPerformanceSamples',
+  sol_getRecentPrioritizationFees = 'getRecentPrioritizationFees',
+  sol_getSignatureStatuses = 'getSignatureStatuses',
+  sol_getSignaturesForAddress = 'getSignaturesForAddress',
+  sol_getSlot = 'getSlot',
+  sol_getSlotLeader = 'getSlotLeader',
+  sol_getSlotLeaders = 'getSlotLeaders',
+  sol_getStakeActivation = 'getStakeActivation',
+  sol_getStakeMinimumDelegation = 'getStakeMinimumDelegation',
+  sol_getSupply = 'getSupply',
+  sol_getTokenAccountBalance = 'getTokenAccountBalance',
+  sol_getTokenAccountsByDelegate = 'getTokenAccountsByDelegate',
+  sol_getTokenAccountsByOwner = 'getTokenAccountsByOwner',
+  sol_getTokenLargestAccounts = 'getTokenLargestAccounts',
+  sol_getTokenSupply = 'getTokenSupply',
+  sol_getTransaction = 'getTransaction',
+  sol_getTransactionCount = 'getTransactionCount',
+  sol_getVersion = 'getVersion',
+  sol_getVoteAccounts = 'getVoteAccounts',
+  sol_isBlockhashValid = 'isBlockhashValid',
+  sol_minimumLedgerSlot = 'minimumLedgerSlot',
+  sol_requestAirdrop = 'requestAirdrop',
+  sol_sendTransaction = 'sendTransaction',
+  sol_simulateTransaction = 'simulateTransaction',
+
+  // Solana Wallet Methods
+  sol_signAndConfirmTransaction = 'sol_signAndConfirmTransaction',
+  sol_signAndSendTransaction = 'sol_signAndSendTransaction',
+  sol_signMessage = 'sol_signMessage',
+  sol_signTransaction = 'sol_signTransaction',
+}
+
 const passiveSignerMethods = [
-  'eth_accounts',
-  'eth_chainId',
-  'eth_requestAccounts',
+  RequestMethod.eth_accounts,
+  RequestMethod.eth_chainId,
+  RequestMethod.eth_requestAccounts,
 ]
 
 const signerMethods = [
-  'eth_accounts',
-  'eth_chainId',
-  'eth_requestAccounts',
-  'eth_sendTransaction',
-  'eth_sign',
-  'eth_signTransaction',
-  'eth_signTypedData_v3',
-  'eth_signTypedData_v4',
-  'personal_sign',
-  'sol_signAndConfirmTransaction',
-  'sol_signAndSendTransaction',
-  'sol_signMessage',
-  'sol_signTransaction',
+  RequestMethod.eth_accounts,
+  RequestMethod.eth_chainId,
+  RequestMethod.eth_requestAccounts,
+  RequestMethod.eth_sendTransaction,
+  RequestMethod.eth_sign,
+  RequestMethod.eth_signTransaction,
+  RequestMethod.eth_signTypedData_v3,
+  RequestMethod.eth_signTypedData_v4,
+  RequestMethod.personal_sign,
+  RequestMethod.sol_signAndConfirmTransaction,
+  RequestMethod.sol_signAndSendTransaction,
+  RequestMethod.sol_signMessage,
+  RequestMethod.sol_signTransaction,
 ]
 
 class Provider {
@@ -37,9 +160,13 @@ class Provider {
 
   private portal: Portal
 
-  constructor({ portal }: ProviderOptions) {
+  // eip155 chain reference ID
+  private chainReferenceId?: number
+
+  constructor({ portal, chainId }: ProviderOptions) {
     this.events = {}
     this.portal = portal
+    this.chainReferenceId = chainId
   }
 
   /**
@@ -118,11 +245,12 @@ class Provider {
    * @returns Promise<any>
    */
   public async request({
-    chainId,
+    chainId: requestChainId,
     method,
     params,
   }: RequestArguments): Promise<any> {
     const isSignerMethod = signerMethods.includes(method)
+    const chainId = this.getCAIP2ChainId(requestChainId)
 
     if (!isSignerMethod && !method.startsWith('wallet_')) {
       // Send to Gateway for RPC calls
@@ -174,6 +302,16 @@ class Provider {
     }
   }
 
+  public setChainId(chainId: number) {
+    if (!Number.isInteger(chainId))
+      throw new Error(
+        `[PortalProvider] Chain ID must be an integer, got ${chainId}`,
+      )
+
+    this.chainReferenceId = chainId
+    this.emit('chainChanged', { chainId })
+  }
+
   /************************
    * Private Methods
    ************************/
@@ -307,22 +445,22 @@ class Provider {
     }
 
     switch (method) {
-      case 'eth_chainId': {
+      case RequestMethod.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 RequestMethod.eth_accounts:
+      case RequestMethod.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': {
+      case RequestMethod.eth_sendTransaction:
+      case RequestMethod.eth_sign:
+      case RequestMethod.eth_signTransaction:
+      case RequestMethod.eth_signTypedData_v3:
+      case RequestMethod.eth_signTypedData_v4:
+      case RequestMethod.personal_sign: {
         this.enforceEip155ChainId(chainId)
         const result = await this.portal.mpc.sign({
           chainId: chainId as string,
@@ -332,10 +470,10 @@ class Provider {
         })
         return result
       }
-      case 'sol_signAndConfirmTransaction':
-      case 'sol_signAndSendTransaction':
-      case 'sol_signMessage':
-      case 'sol_signTransaction': {
+      case RequestMethod.sol_signAndConfirmTransaction:
+      case RequestMethod.sol_signAndSendTransaction:
+      case RequestMethod.sol_signMessage:
+      case RequestMethod.sol_signTransaction: {
         this.enforceSolanaChainId(chainId)
         const result = await this.portal.mpc.sign({
           chainId: chainId as string,
@@ -380,14 +518,14 @@ class Provider {
     let params = txParams
 
     switch (method) {
-      case 'eth_sign':
-      case 'personal_sign':
-      case 'eth_signTypedData_v3':
-      case 'eth_signTypedData_v4':
-      case 'sol_signAndConfirmTransaction':
-      case 'sol_signAndSendTransaction':
-      case 'sol_signMessage':
-      case 'sol_signTransaction':
+      case RequestMethod.eth_sign:
+      case RequestMethod.personal_sign:
+      case RequestMethod.eth_signTypedData_v3:
+      case RequestMethod.eth_signTypedData_v4:
+      case RequestMethod.sol_signAndConfirmTransaction:
+      case RequestMethod.sol_signAndSendTransaction:
+      case RequestMethod.sol_signMessage:
+      case RequestMethod.sol_signTransaction:
         if (!Array.isArray(txParams)) {
           params = [txParams]
         }
@@ -400,6 +538,13 @@ class Provider {
 
     return params
   }
+
+  private getCAIP2ChainId = (chainId?: string) => {
+    if (!chainId && !this.chainReferenceId)
+      throw new Error('[PortalProvider] Chain ID is required for the operation')
+
+    return chainId || `eip155:${this.chainReferenceId}`
+  }
 }
 
 export default Provider

package/types.d.ts

@@ -1,7 +1,7 @@
 import { type DkgData, PortalError } from '@portal-hq/utils'
-import type { MpcErrorCodes } from './src/mpc/errors'
 
-import Portal, { BackupMethods } from './src/index'
+import type { MpcErrorCodes } from './src/mpc/errors'
+import Portal, { BackupMethods, PortalCurve } from './src/index'
 
 export type EventHandler = (event: Event<any>) => void | Promise<void>
 export type EthereumTransaction = EIP1559Transaction | LegacyTransaction
@@ -14,6 +14,7 @@ export type MessageData =
   | SignArgs
 export type ProgressCallback = (status: MpcStatus) => void | Promise<void>
 export type ValidRpcErrorCodes = 4001 | 4100 | 4200 | 4900 | 4901
+
 // Interfaces
 
 export interface FeatureFlags {
@@ -47,11 +48,6 @@ export interface BackupResult {
   cipherText: string
 }
 
-export interface Bk {
-  X: string
-  Rank: number
-}
-
 export interface Address {
   id: string
   network: Network
@@ -97,11 +93,12 @@ interface ClientResponseEnvironment {
 }
 
 interface ClientResponseMetadata {
-  namespaces: ClientNamespaceMetadata
+  namespaces: Record<ChainNamespace, NamespaceMetadataItem>
 }
 
-interface ClientResponseNamespaceMetadata {
-  [key: Namespace]: NamespaceMetadataItem
+interface NamespaceMetadataItem {
+  curve: PortalCurve
+  address: string
 }
 
 interface ClientResponseSharePair {
@@ -119,10 +116,10 @@ export interface ClientResponseWallet {
   createdAt: string
 
   backupSharePairs: ClientResponseBackupSharePair[]
-  curve: WalletCurve
+  curve: PortalCurve
   ejectableUntil?: string
   publicKey: string
-  signingSharePairs: ClientResponseShairPair[]
+  signingSharePairs: ClientResponseSharePair[]
 }
 
 export interface DappOnNetwork {
@@ -153,16 +150,9 @@ export interface DecryptArgs {
 }
 
 export interface DkgData {
-  allY: Pubkey[]
-  bks: Bk[]
-  p: string
-  partialPubKey: Pubkey[]
-  pederson: PedersonParams[]
-  pubkey: Pubkey
-  q: string
+  backupSharePairId?: string
   share: string
   signingSharePairId?: string
-  ssid: string
 }
 
 export interface EIP1559Transaction {
@@ -348,12 +338,6 @@ export interface PasskeyStatusResponse {
   status: PasskeyStatus
 }
 
-export interface PedersonParams {
-  n: string
-  s: string
-  t: string
-}
-
 export interface PortalApiOptions {
   apiKey: string
   baseUrl: string
@@ -383,16 +367,15 @@ export interface PortalOptions {
   keychain?: KeychainAdapter
   mpcVersion?: string
   featureFlags?: FeatureFlags
+  chainId?: string
 }
 
 export interface ProviderOptions {
   // Required options
   portal: Portal
-}
 
-export interface Pubkey {
-  X: string
-  Y: string
+  // Optional
+  chainId?: number
 }
 
 export interface QuoteArgs {
@@ -427,14 +410,14 @@ export interface RegisteredEventHandler {
 
 export interface RequestArguments {
   chainId?: string
-  method: string
+  method: RequestMethod
   params?: unknown[] | SigningRequestParams
 }
 
 export interface RecoverArgs extends MpcOperationArgs {
-  cipherText: string
-  backupMethod: BackupMethods
   backupConfigs: BackupConfigs
+  backupMethod: BackupMethods
+  cipherText: string
   featureFlags?: FeatureFlags // TODO: Remove this
 }
 
@@ -514,6 +497,109 @@ export interface SimulatedTransaction {
   requestError?: SimulatedTransactionError
 }
 
+export type EvaluateTransactionParam =
+  | {
+      to: string
+      value?: string
+      data?: string
+      gas?: string
+      gasPrice?: string
+      maxFeePerGas?: string
+      maxPriorityFeePerGas?: string
+    }
+  | {
+      transactions: string[]
+    }
+
+type EvaluateTransactionOperationType = 'validation' | 'simulation' | 'all'
+
+export interface EvaluatedTransaction {
+  validation?: Validation
+  simulation?: Simulation
+  block?: number
+}
+
+interface AssetMovement {
+  summary: string
+  value: string
+  usdPrice?: string
+  rawValue: string
+}
+
+interface AssetDiff {
+  asset: Record<
+    string,
+    {
+      type: string
+      decimals: number
+      chainName?: string
+      chainId?: number
+      logoUrl?: string
+      name?: string
+      symbol?: string
+    }
+  >
+  in: Record<string, AssetMovement>[]
+  out: Record<string, AssetMovement>[]
+}
+
+interface AccountSummary {
+  assetsDiffs: Record<string, AssetDiff>[]
+  [k: string]: any
+}
+
+type Simulation = SuccessfulSimulation | UnsuccessfulSimulation
+
+interface SuccessfulSimulation {
+  accountAddress: string
+  accountSummary: AccountSummary
+  addressDetails: Record<string, any>
+  assetsDiffs: Record<string, AssetDiff[]>
+  status: string
+  exposures?: Record<string, any>
+  totalUsdDiff?: Record<string, any>
+  totalUsdExposure?: Record<string, any>
+  solana?: {
+    delegations: Record<string, Record<string, any>[]>
+    assetsOwnershipDiff: Record<string, Record<string, any>[]>
+  }
+}
+interface UnsuccessfulSimulation {
+  status: 'Error'
+  error: string
+}
+
+type Validation = SuccessfulValidation | UnsuccessfulValidation
+
+interface SuccessfulValidation {
+  classification?: string | null
+  description?: string | null
+  features: {
+    type?: 'Malicious' | 'Warning' | 'Benign' | 'Info'
+    featureId?: string
+    description: string
+    address?: string | null
+  }[]
+  reason?: string | null
+  resultType: 'Benign' | 'Warning' | 'Malicious'
+  status: string
+}
+
+interface UnsuccessfulValidation {
+  error: string
+  classification?: string | null
+  description?: string | null
+  features: {
+    type?: 'Malicious' | 'Warning' | 'Benign' | 'Info'
+    featureId?: string
+    description: string
+    address?: string | null
+  }[]
+  reason?: string | null
+  resultType: 'Error'
+  status: 'Error'
+}
+
 export interface Transaction {
   asset: string
   blockNum: string
@@ -537,6 +623,185 @@ export interface Transaction {
   value: number
 }
 
+export interface Asset {
+  nativeBalance: {
+    balance: string
+    decimals: number
+    name: string
+    rawBalance: string
+    symbol: string
+    metadata: Record<string, any>
+  }
+  tokenBalances: {
+    balance: string
+    decimals: number
+    name: string
+    rawBalance: string
+    symbol: string
+    metadata: Record<string, any>
+  }[]
+  nfts?: NFTAsset[]
+}
+
+export interface NFTAsset {
+  nftId: string
+  name: string
+  description: string
+  imageUrl: string
+  chain: string
+  contractAddress: string
+  tokenId: string
+  collection: {
+    name: string
+    description: string | null
+    imageUrl: string
+  }
+  lastSale: {
+    price: number
+    currency: string
+    date: string
+  } | null
+  rarity: {
+    rank: number | null
+    score: number | null
+  }
+  floorPrice: {
+    price: number
+    currency: string
+  } | null
+  detailedInfo: {
+    ownerCount: number
+    tokenCount: number
+    createdDate: string | null
+    attributes: Attribute[]
+    owners: Owner[]
+    extendedCollectionInfo: ExtendedCollectionInfo
+    extendedSaleInfo: ExtendedSaleInfo | null
+    marketplaceInfo: MarketplaceInfo[]
+    mediaInfo: MediaInfo
+  }
+}
+
+interface Attribute {
+  traitType: string
+  value: string | number
+  displayType: string | null
+}
+
+interface Owner {
+  ownerAddress: string
+  quantity: number
+  firstAcquiredDate: string
+  lastAcquiredDate: string
+}
+
+interface ExtendedCollectionInfo {
+  bannerImageUrl: string | null
+  externalUrl: string | null
+  twitterUsername: string | null
+  discordUrl: string | null
+  instagramUsername: string | null
+  mediumUsername: string | null
+  telegramUrl: string | null
+  distinctOwnerCount: number
+  distinctNftCount: number
+  totalQuantity: number
+}
+
+interface ExtendedSaleInfo {
+  fromAddress: string
+  toAddress: string
+  priceUsdCents: number
+  transaction: string
+  marketplaceId: string
+  marketplaceName: string
+}
+
+interface MarketplaceInfo {
+  marketplaceId: string
+  marketplaceName: string
+  marketplaceCollectionId: string
+  nftUrl: string
+  collectionUrl: string
+  verified: boolean | null
+  floorPrice: {
+    value: number
+    paymentToken: {
+      paymentTokenId: string
+      name: string
+      symbol: string
+      address: string | null
+      decimals: number
+    }
+    valueUsdCents: number | null
+  } | null
+}
+
+interface MediaInfo {
+  previews: {
+    imageSmallUrl: string
+    imageMediumUrl: string
+    imageLargeUrl: string
+    imageOpengraphUrl: string
+    blurhash: string
+    predominantColor: string
+  }
+  animationUrl: string | null
+  backgroundColor: string | null
+}
+
+export type BuiltTransaction = BuiltEip155Transaction | BuiltSolanaTransaction
+
+export interface BuiltEip155Transaction {
+  transaction: {
+    from: string
+    to: string
+    data: string
+  }
+  metadata: {
+    amount: string
+    fromAddress: string
+    toAddress: string
+    tokenAddress: string
+    tokenDecimals: number
+    rawAmount: string
+  }
+}
+
+export interface BuiltSolanaTransaction {
+  transaction: string
+  metadata: {
+    amount: string
+    fromAddress: string
+    toAddress: string
+    tokenMintAddress: string
+    tokenDecimals: number
+    tokenProgramId: string
+    tokenExtensions: any[]
+    rawAmount: string
+    lastValidBlockHeight: string
+    serializedTransactionBase64Encoded: string
+    serializedTransactionBase58Encoded: string
+    unsignedTransactionMessage: {
+      signatures: null
+      message: {
+        accountKeys: string[]
+        header: {
+          numRequiredSignatures: number
+          numReadonlySignedAccounts: number
+          numReadonlyUnsignedAccounts: number
+        }
+        instructions: {
+          programIdIndex: number
+          accounts: number[]
+          data: string
+        }[]
+        recentBlockhash: string
+      }
+    }
+  }
+}
+
 export interface SwitchEthereumChainParameter {
   chainId: string
 }