@portal-hq/web 3.7.0 → 3.8.0

package/src/shared/types/common.ts

@@ -0,0 +1,681 @@
+/**
+ * Common shared types used by both browser and iframe packages
+ */
+
+// Basic types
+export interface FeatureFlags {
+  isMultiBackupEnabled?: boolean
+}
+
+export interface Network {
+  id: string
+  chainId: string
+  name: string
+}
+
+export interface Address {
+  id: string
+  network: Network
+  value: string
+}
+
+export interface Balance {
+  contractAddress: string
+  balance: string
+}
+
+export interface PortalError {
+  code: number
+  message?: string
+}
+
+// DKG types
+export interface DkgData {
+  backupSharePairId?: string
+  share: string
+  signingSharePairId?: string
+}
+
+// Transaction types
+export interface EIP1559Transaction {
+  from: string
+  to: string
+
+  // Optional
+  data?: string
+  gasLimit?: string
+  maxFeePerGas?: string
+  maxPriorityFeePerGas?: string
+  nonce?: string
+  value?: string
+}
+
+export interface LegacyTransaction {
+  from: string
+  to: string
+
+  // Optional
+  data?: string
+  gasLimit?: string
+  gasPrice?: string
+  nonce?: string
+  value?: string
+}
+
+export type EthereumTransaction = EIP1559Transaction | LegacyTransaction
+
+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
+}
+
+// Built transaction types
+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
+    | {
+        from: string
+        to: string
+        data?: string
+        value?: 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
+      }
+    }
+  }
+}
+
+// Simulation types
+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[]
+    }
+
+export 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
+}
+
+export 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
+}
+
+export 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'
+}
+
+// NFT types
+export interface NFTContract {
+  address: string
+}
+
+export interface TokenId {
+  tokenId: string
+  tokenMetadata: TokenMetadata
+}
+
+export interface TokenMetadata {
+  tokenType: string
+}
+
+export interface TokenUri {
+  gateway: string
+  raw: string
+}
+
+export interface Media {
+  gateway: string
+  thumbnail: string
+  raw: string
+  format: string
+  bytes: number
+}
+
+export interface Metadata {
+  name: string
+  description: string
+  image: string
+  external_url?: string
+}
+
+export interface ContractMetadata {
+  name: string
+  symbol: string
+  tokenType: string
+  contractDeployer: string
+  deployedBlockNumber: number
+  openSea?: OpenSeaMetadata
+}
+
+export interface OpenSeaMetadata {
+  collectionName: string
+  safelistRequestStatus: string
+  imageUrl?: string
+  description: string
+  externalUrl: string
+  lastIngestedAt: string
+  floorPrice?: number
+  twitterUsername?: string
+  discordUrl?: string
+}
+
+export interface NFT {
+  contract: NFTContract
+  id: TokenId
+  balance: string
+  title: string
+  description: string
+  tokenUri: TokenUri
+  media: Media[]
+  metadata: Metadata
+  timeLastUpdated: string
+  contractMetadata: ContractMetadata
+}
+
+// Config types
+export interface GDriveConfig {
+  clientId: string
+}
+
+export interface PasskeyConfig {
+  relyingParty?: string
+  relyingPartyOrigins?: string[]
+  webAuthnHost?: string
+}
+
+export interface RpcConfig {
+  [key: string]: string
+}
+
+export interface CustomBackupConfig {
+  encryptionKey: string
+}
+
+// Backup method types - matches enum values from both browser and iframe packages
+export type BackupMethod = 'GDRIVE' | 'PASSWORD' | 'PASSKEY' | 'CUSTOM' | 'UNKNOWN'
+
+export interface BackupConfigs {
+  passwordStorage?: PasswordConfig
+  customStorage?: CustomBackupConfig
+}
+
+export interface BackupWorkerResult {
+  result: EncryptedData | EncryptedWithPasswordData
+  backupMethod: BackupMethod
+}
+
+export interface PasswordConfig {
+  password: string
+}
+
+export interface OrgBackupShares {
+  SECP256K1: string
+  ED25519?: string
+}
+
+// Fund types
+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
+}
+
+// Send asset types
+export interface SendAssetParams {
+  amount: string
+  to: string
+  token: string
+  sponsorGas?: boolean
+}
+
+export interface SendAssetResponse {
+  transactionHash: string
+  metadata: {
+    amount?: string
+    lastValidBlockHeight?: string
+    rawAmount?: string
+    tokenAddress?: string
+    tokenDecimals?: number
+    tokenSymbol?: string
+  }
+}
+
+// Encrypt/Decrypt types
+export interface EncryptedData {
+  cipherText: string
+  key: string
+}
+
+export interface EncryptedWithPasswordData {
+  cipherText: string
+}
+
+// Alias for backward compatibility
+export type EncryptWithPasswordData = EncryptedWithPasswordData
+
+export interface DecryptData {
+  plaintext: string
+}
+
+// Quote types
+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: EIP1559Transaction | LegacyTransaction
+}
+
+// Misc types
+export interface SwitchEthereumChainParameter {
+  chainId: string
+}
+
+export interface TypedData {
+  types: Type[]
+  primaryType: string
+  domain: string
+  message: string
+}
+
+export interface Type {
+  name: string
+  type: string
+}
+
+// Dapp types
+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
+}
+
+// MPC operation types
+export interface SignArgs {
+  chainId: string
+  method: string
+  params: string
+  rpcUrl: string
+  sponsorGas?: boolean
+}
+
+export interface SignResult {
+  data: string
+  error: PortalError
+}
+
+export interface EncryptArgs {
+  dkgData: string
+}
+
+export interface DecryptArgs {
+  cipherText: string
+  key?: string
+  privateKey?: string
+}
+
+export interface GenerateData {
+  address: string
+  dkgResult: DkgData
+}
+
+export interface EncryptedResult {
+  data: EncryptedData | EncryptedWithPasswordData
+  error: PortalError
+}
+
+export interface DecryptResult {
+  data: DecryptData
+  error: PortalError
+}
+
+export interface EncryptedWithPasswordResult {
+  data: EncryptedWithPasswordData
+  error: PortalError
+}
+
+export interface MpcStatus {
+  status: string
+  done: boolean
+}
+
+export interface SharesOnDeviceResponse {
+  ED25519: boolean
+  SECP256K1: boolean
+}
+
+export interface EjectResult {
+  SECP256K1: string
+}
+
+export interface EjectPrivateKeysResult {
+  ED25519: string
+  SECP256K1: string
+}
+
+export interface GenerateResult {
+  data: GenerateData
+  error: PortalError
+}
+
+export interface GenerateResponse {
+  address: string
+  cipherText?: string
+  share?: string
+}
+
+export interface RotateData {
+  address: string
+  dkgResult: DkgData
+}
+
+export interface RotateResult {
+  data: RotateData
+  error: PortalError
+}
+
+export interface BackupData {
+  share: string
+}
+
+export interface BackupResult {
+  backupIds: string[]
+  cipherText: string
+  encryptionKey?: string
+}
+
+export interface BackupResponse {
+  cipherText: string
+  storageCallback: () => Promise<void>
+  encryptionKey?: string
+}
+
+export interface AddressResult {
+  data: string
+  type: string
+}
+
+// Passkey types
+export interface PasskeyStatusResponse {
+  status: string
+}
+
+export interface PasskeyStorageOptions<TPortal = unknown> {
+  portal: TPortal
+  relyingParty?: string
+  relyingPartyOrigins?: string[]
+  webAuthnHost?: string
+  authOrigin?: string
+}
+
+// Client Response types
+export type SharePairStatus = 'completed' | 'incomplete'
+
+export interface ClientResponseCustodian {
+  id: string
+  name: string
+}
+
+export interface ClientResponseSharePair {
+  id: string
+  createdAt: string
+  status: SharePairStatus
+}
+
+export interface WalletPublicKey {
+  X: string
+  Y: string
+}
+
+// MPC Operation types
+export interface MpcOperationArgs {
+  host: string
+  mpcVersion: string
+  apiKey?: string
+  featureFlags?: FeatureFlags
+}
+
+export type GenerateArgs = MpcOperationArgs
+
+export interface EjectWorkerArgs extends MpcOperationArgs {
+  clientShare: string
+  organizationBackupShare: string
+}