fiatPluginTypes.ts

import { asValue } from 'cleaners'
import type { EdgeAccount } from 'edge-core-js'
import type {
  EdgeAssetAction,
  EdgeMetadata,
  EdgeTokenId,
  EdgeTransaction,
  EdgeTxAction
} from 'edge-core-js/types'
import type { PluginPromotion } from 'edge-info-server'

import type { DisablePluginMap } from '../../actions/ExchangeInfoActions'
import type { LaunchPaymentProtoParams } from '../../actions/PaymentProtoActions'
import type {
  ButtonInfo,
  ButtonModalProps
} from '../../components/modals/ButtonsModal'
import type { SendScene2Params } from '../../components/scenes/SendScene2'
import type { Permission } from '../../reducers/PermissionsReducer'
import type { FiatProviderLink } from '../../types/DeepLinkTypes'
import type { HomeAddress, SepaInfo } from '../../types/FormTypes'
import type { GuiPlugin } from '../../types/GuiPluginTypes'
import type { AppParamList } from '../../types/routerTypes'
import type { EdgeAsset } from '../../types/types'
import type {
  getHistoricalCryptoRate,
  getHistoricalFiatRate
} from '../../util/exchangeRates'
import type {
  BuyConversionValues,
  SellConversionValues,
  TrackingEventName,
  TrackingValues
} from '../../util/tracking'
import type { FiatPluginAddressFormParams } from './scenes/AddressFormScene'
import type { FiatPluginOpenWebViewParams } from './scenes/FiatPluginWebView'
import type { FiatPluginSepaTransferParams } from './scenes/InfoDisplayScene'
import type { RewardsCardDashboardParams } from './scenes/RewardsCardDashboardScene'
import type { RewardsCardWelcomeParams } from './scenes/RewardsCardWelcomeScene'
import type { FiatPluginSepaFormParams } from './scenes/SepaFormScene'

export const asFiatDirection = asValue('buy', 'sell')
export type FiatDirection = ReturnType<typeof asFiatDirection>

export const asFiatPaymentType = asValue(
  'ach',
  'applepay',
  'cash',
  'colombiabank',
  'credit',
  'directtobank',
  'fasterpayments',
  'googlepay',
  // TODO: Remove `iach` from the variants when old fiat plugin code has been gutted.
  /** @deprecated because Instant ACH isn't different from regular ACH. Use `ach` instead. */
  'iach',
  'ideal',
  'interac',
  'iobank',
  'klarna',
  'mexicobank',
  'payid',
  'paypal',
  'pix',
  'pse',
  'revolut',
  'sepa',
  'spei',
  'turkishbank',
  'venmo',
  'wire'
)
export type FiatPaymentType = ReturnType<typeof asFiatPaymentType>

export type LinkHandler = (url: FiatProviderLink) => void | Promise<void>

export interface FiatPluginSepaTransferInfo {
  input: {
    amount: string
    currency: string
  }
  output: {
    amount: string
    currency: string
    walletAddress: string
  }
  paymentDetails: {
    id: string
    iban: string
    swiftBic: string
    recipient: string
    reference: string
  }
}

export interface FiatPluginListModalParams {
  title: string
  items: Array<{
    icon: string | number | React.ReactNode
    name: string
    text?: string
  }> // Icon strings are image uri, numbers are local files
  selected?: string // Must match one of the name param in the items array
}

export interface FiatPluginEnterAmountResponse {
  lastUsed: number
  value1: string
  value2: string
}

export interface FiatPluginOpenExternalWebViewParams {
  url: string

  /**
   * Use a webview that is fully external to the app instead of any semi integrated
   * webview like a SafariWebView. If set, this will not kill the app but only
   * redirect to the external webview.
   */
  redirectExternal?: boolean

  /**
   * @param url
   * @returns void
   *
   * providerId is required if deeplinkHandler is provided
   */
  deeplinkHandler?: LinkHandler
  providerId?: string
}

export interface FiatPluginWalletPickerResult {
  walletId: string
  tokenId: EdgeTokenId
}

export interface SaveTxMetadataParams {
  txid: string
  walletId: string
  tokenId: EdgeTokenId
  metadata?: EdgeMetadata
}

export interface SaveTxActionParams {
  txid: string
  walletId: string
  tokenId: EdgeTokenId
  savedAction: EdgeTxAction
  assetAction: EdgeAssetAction
}

export type FiatPluginPermissions = Permission[]

export interface FiatPluginUi {
  addressWarnings: (parsedUri: any, currencyCode: string) => Promise<boolean>
  buttonModal: <Buttons extends Record<string, ButtonInfo>>(
    params: Omit<ButtonModalProps<Buttons>, 'bridge'>
  ) => Promise<keyof Buttons | undefined>
  confirmation: (params: { title: string; message: string }) => Promise<void>
  showToastSpinner: <T>(message: string, promise: Promise<T>) => Promise<T>
  openWebView: (params: FiatPluginOpenWebViewParams) => Promise<void>
  openExternalWebView: (
    params: FiatPluginOpenExternalWebViewParams
  ) => Promise<void>
  walletPicker: (params: {
    headerTitle: string
    allowedAssets?: EdgeAsset[]
    showCreateWallet?: boolean
  }) => Promise<FiatPluginWalletPickerResult | undefined>
  showError: (error: unknown) => Promise<void>
  listModal: (params: FiatPluginListModalParams) => Promise<string | undefined>
  enterAmount: (params: AppParamList['guiPluginEnterAmount']) => void
  emailForm: (params: {
    message?: string
  }) => Promise<
    { email: string; firstName: string; lastName: string } | undefined
  >
  addressForm: (
    params: FiatPluginAddressFormParams
  ) => Promise<HomeAddress | undefined>
  requestPermission: (
    permissions: FiatPluginPermissions,
    displayName: string,
    mandatory: boolean
  ) => Promise<boolean>
  rewardsCardDashboard: (params: RewardsCardDashboardParams) => Promise<void>
  rewardsCardWelcome: (params: RewardsCardWelcomeParams) => Promise<void>
  saveTxAction: (params: SaveTxActionParams) => Promise<void>
  saveTxMetadata: (params: SaveTxMetadataParams) => Promise<void>
  send: (params: SendScene2Params) => Promise<EdgeTransaction>
  sendPaymentProto: (params: {
    uri: string
    params: LaunchPaymentProtoParams
  }) => Promise<void>
  sepaForm: (params: FiatPluginSepaFormParams) => Promise<SepaInfo | undefined>
  sepaTransferInfo: (params: FiatPluginSepaTransferParams) => Promise<void>
  setClipboard: (value: string) => Promise<void>
  showToast: (message: string, autoHideMs?: number) => Promise<void>
  trackConversion: (
    event: TrackingEventName,
    opts: {
      conversionValues: SellConversionValues | BuyConversionValues
    }
  ) => Promise<void>
  exitScene: () => Promise<void>
  waitForAnimationFrame: () => Promise<void>
}

export interface FiatPluginUtils {
  getHistoricalCryptoRate: typeof getHistoricalCryptoRate
  getHistoricalFiatRate: typeof getHistoricalFiatRate
}

export interface FiatPluginFactoryArgs {
  // TODO:
  // io: {
  //   log: EdgeLog, // scoped logs
  // }
  account: EdgeAccount
  deviceId: string
  disablePlugins: DisablePluginMap
  longPress?: boolean
  guiPlugin: GuiPlugin
  showUi: FiatPluginUi
  pluginUtils: FiatPluginUtils
  onLogEvent: (event: TrackingEventName, values?: TrackingValues) => void
}

export interface FiatPluginRegionCode {
  countryCode: string
  stateProvinceCode?: string
}
export interface FiatPluginStartParams {
  direction: 'buy' | 'sell'
  defaultIsoFiat: string
  paymentTypes: FiatPaymentType[]
  regionCode: FiatPluginRegionCode
  forceFiatCurrencyCode?: string
  defaultFiatAmount?: string
  pluginPromotions?: PluginPromotion[]
  providerId?: string
}
export interface FiatPlugin {
  pluginId: string
  startPlugin: (params: FiatPluginStartParams) => Promise<void>
}

export type FiatPluginFactory = (
  params: FiatPluginFactoryArgs
) => Promise<FiatPlugin>