@portal-hq/web 3.7.0 → 3.8.0

package/types.d.ts

@@ -3,6 +3,98 @@ import { type DkgData, PortalError } from '@portal-hq/utils'
 import type { MpcErrorCodes } from './src/mpc/errors'
 import Portal, { BackupMethods, PortalCurve } from './src/index'
 
+// Re-export shared types for backward compatibility
+export type {
+  Address,
+  AddressResult,
+  BackupConfigs,
+  BackupData,
+  BackupResponse,
+  BackupResult,
+  Balance,
+  BuiltEip155Transaction,
+  BuiltSolanaTransaction,
+  BuiltTransaction,
+  CustomBackupConfig,
+  Dapp,
+  DappImage,
+  DappOnNetwork,
+  DecryptArgs,
+  DecryptData,
+  DecryptResult,
+  EIP1559Transaction,
+  EjectPrivateKeysResult,
+  EjectResult,
+  EncryptArgs,
+  EncryptedData,
+  EncryptedResult,
+  EncryptedWithPasswordData,
+  EncryptedWithPasswordResult,
+  EvaluatedTransaction,
+  EvaluateTransactionParam,
+  FeatureFlags,
+  FundParams,
+  FundResponse,
+  FundResponseData,
+  FundResponseMetadata,
+  GDriveConfig,
+  GenerateData,
+  GenerateResponse,
+  GenerateResult,
+  LegacyTransaction,
+  MpcStatus,
+  Network,
+  NFT,
+  NFTContract,
+  OrgBackupShares,
+  PasskeyConfig,
+  PasskeyStatusResponse,
+  PasswordConfig,
+  QuoteArgs,
+  QuoteResponse,
+  RotateData,
+  RotateResult,
+  SendAssetParams,
+  SendAssetResponse,
+  SharesOnDeviceResponse,
+  SignArgs,
+  SignResult,
+  SimulatedTransaction,
+  SimulatedTransactionChange,
+  SimulatedTransactionError,
+  SimulateTransactionParam,
+  SwitchEthereumChainParameter,
+  Transaction,
+  Type,
+  TypedData,
+  GetAssetsResponse,
+  IframeConfigurationOptions,
+  NFTAsset,
+  EvaluateTransactionOperationType,
+  PortalError,
+} from './src/shared/types'
+
+import type {
+  BackupConfigs,
+  FeatureFlags,
+  GDriveConfig,
+  MpcStatus,
+  OrgBackupShares,
+  PasskeyConfig,
+  DecryptArgs,
+  EncryptArgs,
+  SignArgs,
+  BackupResult,
+  DecryptResult,
+  EncryptedResult,
+  EncryptedWithPasswordResult,
+  GenerateResult,
+  SignResult,
+  EjectResult,
+  EIP1559Transaction,
+  LegacyTransaction,
+} from './src/shared/types'
+
 export type EventHandler = (event: Event<any>) => void | Promise<void>
 export type EthereumTransaction = EIP1559Transaction | LegacyTransaction
 export type MessageData =
@@ -17,59 +109,9 @@ export type ValidRpcErrorCodes = 4001 | 4100 | 4200 | 4900 | 4901
 
 // Interfaces
 
-export interface FeatureFlags {
-  isMultiBackupEnabled?: boolean
-}
-
-export interface AddressResult {
-  data: string
-  type: string
-}
-
 export interface BackupArgs extends MpcOperationArgs {
   backupMethod: BackupMethods
-  backupConfigs: BackupConfigs = {}
-}
-
-
-export interface CustomBackupConfig {
-  encryptionKey: string
-}
-
-export interface BackupConfigs {
-  passwordStorage?: PasswordConfig
-  customStorage?: CustomBackupConfig
-}
-
-export interface OrgBackupShares {
-  SECP256K1: string
-  ED25519?: string
-}
-
-export interface PasswordConfig {
-  password: string
-}
-
-export interface BackupData {
-  share: string
-}
-
-export interface BackupResult {
-  backupIds: string[]
-  cipherText: string
-  encryptionKey?: string
-}
-
-export interface Address {
-  id: string
-  network: Network
-  value: string
-}
-
-export interface BackupResponse {
-  cipherText: string
-  storageCallback: () => Promise<void>
-  encryptionKey?: string
+  backupConfigs: BackupConfigs = { }
 }
 
 export interface BackupShareResult {
@@ -106,48 +148,6 @@ export interface BackupOptions extends PasskeyOptions {
   backupMethod?: BackupMethods
 }
 
-export interface Balance {
-  contractAddress: string
-  balance: string
-}
-
-export interface SendAssetParams {
-  amount: string
-  to: string
-  token: string
-  sponsorGas?: boolean
-}
-
-export interface FundParams {
-  amount: string
-  token: string
-}
-
-export interface FundResponseData {
-  explorerUrl: string
-  txHash: string
-}
-
-export interface FundResponseMetadata {
-  amount: string
-  chainId: string
-  clientId: string
-  custodianId: string
-  environmentId: string
-  token: string
-}
-
-export interface FundResponse {
-  data?: FundResponseData
-  metadata: FundResponseMetadata
-  error?: string
-}
-
-export interface SharesOnDeviceResponse {
-  ED25519: boolean
-  SECP256K1: boolean
-}
-
 export interface ClientResponse {
   id: string
   address: string
@@ -201,93 +201,6 @@ export interface ClientResponseWallet {
   signingSharePairs: ClientResponseSharePair[]
 }
 
-export interface DappOnNetwork {
-  clientUrl?: string
-  dapp: Dapp
-  id: string
-  network: Network
-}
-
-export interface Dapp {
-  id: string
-  name: string
-
-  addresses: Address[]
-  dappOnNetworks: DappOnNetwork[]
-  image: DappImage
-}
-
-export interface DappImage {
-  id: string
-  filename: string
-  data: string
-}
-
-export interface DecryptArgs {
-  cipherText: string
-  key: string
-}
-
-export interface DkgData {
-  backupSharePairId?: string
-  share: string
-  signingSharePairId?: string
-}
-
-export interface EIP1559Transaction {
-  from: string
-  to: string
-
-  // Optional
-  data?: string
-  gasLimit?: string
-  maxFeePerGas?: string
-  maxPriorityFeePerGas?: string
-  nonce?: string
-  value?: string
-}
-
-export interface EjectResult {
-  SECP256K1: string
-}
-
-export interface EjectPrivateKeysResult {
-  ED25519: string
-  SECP256K1: string
-}
-
-export interface EncryptArgs {
-  dkgData: string
-}
-
-export interface EncryptedWithPasswordData {
-  cipherText: string
-}
-
-export interface EncryptedData {
-  cipherText: string
-  key: string
-}
-
-export interface EncryptedResult {
-  data: EncryptData
-  error: PortalError
-}
-
-export interface EncryptedWithPasswordResult {
-  data: EncryptedWithPasswordData
-  error: PortalError
-}
-
-export interface DecryptData {
-  plaintext: string
-}
-
-export interface DecryptResult {
-  data: DecryptData
-  error: PortalError
-}
-
 export interface EjectArgs extends RecoverArgs {
   organizationBackupShare: string
 }
@@ -305,73 +218,18 @@ export interface RpcConfig {
   [key: string]: string
 }
 
-export interface GDriveConfig {
-  clientId: string
-}
-
 export interface GDriveStorageOptions {
   portal: Portal
 }
 
 export type GenerateArgs = MpcOperationArgs
 
-export interface PasskeyConfig {
-  relyingParty?: string = 'portalhq.io'
-  relyingPartyOrigins?: [string] = ['https://web.portalhq.io']
-  webAuthnHost?: string = 'backup.web.portalhq.io'
-}
 export interface PasskeyStorageOptions {
   portal: IPortal
-  relyingParty?: string = 'portalhq.io'
-  relyingPartyOrigins?: [string] = ['https://web.portalhq.io']
-  webAuthnHost?: string = 'backup.web.portalhq.io'
-  authOrigin?: string = 'web.portalhq.io'
-}
-export interface PasskeyStatusResponse {
-  status: PasskeyStatus
-}
-
-export interface GenerateData {
-  address: string
-  dkgResult: DkgData
-}
-
-export interface GenerateResult {
-  data: GenerateData
-  error: PortalError
-}
-
-export interface GenerateResponse {
-  address: string
-  cipherText?: string
-  share?: string
-}
-
-export interface IframeConfigurationOptions {
-  autoApprove: boolean
-  featureFlags?: FeatureFlags
-  gdrive?: GDriveConfig
-  passkey?: PasskeyConfig
-  host: string
-  mpcHost: string
-  mpcVersion: string
-
-  // One of these three is required for authentication
-  apiKey?: string
-  authToken?: string
-  authUrl?: string
-}
-
-export interface LegacyTransaction {
-  from: string
-  to: string
-
-  // Optional
-  data?: string
-  gasLimit?: string
-  gasPrice?: string
-  nonce?: string
-  value?: string
+  relyingParty?: string
+  relyingPartyOrigins?: string[]
+  webAuthnHost?: string
+  authOrigin?: string
 }
 
 export interface MpcErrorData {
@@ -389,42 +247,6 @@ export interface MpcOptions {
   portal: Portal
 }
 
-export interface MpcStatus {
-  status: MpcStatuses
-  done: boolean
-}
-
-export interface Network {
-  id: string
-  chainId: string
-  name: string
-}
-
-export interface NFT {
-  contract: NFTContract
-  id: TokenId
-  balance: string
-  title: string
-  description: string
-  tokenUri: TokenUri
-  media: Media[]
-  metadata: Metadata
-  timeLastUpdated: string
-  contractMetadata: ContractMetadata
-}
-
-export interface NFTContract {
-  address: string
-}
-
-export interface PasskeyConfig {
-  relyingParty?: string = 'backup.web.portalhq.io'
-}
-
-export interface PasskeyStatusResponse {
-  status: PasskeyStatus
-}
-
 export interface PortalApiOptions {
   apiKey: string
   baseUrl: string
@@ -433,11 +255,6 @@ export interface PortalApiOptions {
   portal: Portal
 }
 
-export interface PortalError {
-  code: number
-  message?: string
-}
-
 export interface PortalOptions {
   // Required options
   rpcConfig: RpcConfig
@@ -465,31 +282,6 @@ export interface ProviderOptions {
   chainId?: number
 }
 
-export interface QuoteArgs {
-  affiliateAddress?: string
-  buyAmount?: number
-  buyToken: string
-  buyTokenPercentageFee?: number
-  enableSlippageProtection?: boolean
-  excludedSources?: string
-  feeRecipient?: string
-  gasPrice?: number
-  includedSources?: string
-  intentOnFilling?: boolean
-  priceImpactProtectionPercentage?: number
-  sellAmount?: number
-  sellToken: string
-  skipValidation?: boolean
-  slippagePercentage?: number
-  takerAddress?: string
-}
-
-export interface QuoteResponse {
-  allowanceTarget: string
-  cost: string
-  transaction: Eip1559 | LegacyTx
-}
-
 export interface RegisteredEventHandler {
   handler: EventHandler
   once?: boolean
@@ -506,17 +298,7 @@ export interface RecoverArgs extends MpcOperationArgs {
   backupConfigs: BackupConfigs
   backupMethod: BackupMethods
   cipherText: string
-  featureFlags?: FeatureFlags // TODO: Remove this
-}
-
-export interface RotateResult {
-  data: RotateData
-  error: PortalError
-}
-
-export interface RotateData {
-  address: string
-  dkgResult: DkgData
+  featureFlags?: FeatureFlags
 }
 
 export interface RpcErrorDefinition {
@@ -529,409 +311,40 @@ export interface RpcErrorOptions {
   data?: unknown
 }
 
-export interface SignArgs {
-  chainId: string
-  method: string
-  params: string
-  rpcUrl: string
-  sponsorGas?: boolean
-}
-
 export interface SignData {
   R: string
   S: string
 }
 
-export interface SignResult {
-  data: string
-  error: PortalError
-}
-
 export interface SignerOptions {
   portal: Portal
 }
 
-export interface SimulateTransactionParam {
-  to: string
-  value?: string
-  data?: string
-  gas?: string
-  gasPrice?: string
-  maxFeePerGas?: string
-  maxPriorityFeePerGas?: string
-}
-
-export interface SimulatedTransactionChange {
-  amount?: string
-  assetType?: string
-  changeType?: string
-  contractAddress?: string
-  decimals?: number
-  from?: string
-  name?: string
-  rawAmount?: string
-  symbol?: string
-  to?: string
-  tokenId?: number
-}
-
-export interface SimulatedTransactionError {
-  message: string
-}
-
-export interface SimulatedTransaction {
-  changes: SimulatedTransactionChange[]
-  gasUsed?: string
-  error?: SimulatedTransactionError
-  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
-  category: string
-  chainId: string
-  erc1155Metadata: null | string
-  erc721TokenId: null | string
-  from: string
-  hash: string
-  metadata: {
-    blockTimestamp: string
-  }
-  rawContract: {
-    address: string
-    decimal: string
-    value: string
-  }
-  to: string
-  tokenId: null | string
-  uniqueId: string
-  value: number
-}
-
-export interface GetAssetsResponse {
-  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
-}
-
-export interface TypedData {
-  types: Type[]
-  primaryType: string
-  domain: string
-  message: string
-}
-
-export interface Type {
-  name: string
-  type: string
-}
-
 export interface WorkerMessage {
   type: string
   data:
-    | BackupArgs
-    | DecryptArgs
-    | EncryptArgs
-    | GenerateArgs
-    | RecoverArgs
-    | SignArgs
+  | BackupArgs
+  | DecryptArgs
+  | EncryptArgs
+  | GenerateArgs
+  | RecoverArgs
+  | SignArgs
 }
 
 export interface WorkerResult {
   type: string
   data:
-    | boolean
-    | string
-    | BackupResult
-    | DecryptResult
-    | EncryptedResult
-    | EncryptedWithPasswordResult
-    | GenerateResult
-    | MpcStatus
-    | PortalError
-    | ReadyResult
-    | RecoverResult
-    | SignResult
-    | EjectResult
+  | boolean
+  | string
+  | BackupResult
+  | DecryptResult
+  | EncryptedResult
+  | EncryptedWithPasswordResult
+  | GenerateResult
+  | MpcStatus
+  | PortalError
+  | ReadyResult
+  | RecoverResult
+  | SignResult
+  | EjectResult
 }