@lifi/sdk/src/core/processMessages.ts

LI.FI Any-to-Any Cross-Chain-Swap SDK

import type { StatusMessage, Substatus } from '@lifi/types'
import type { ProcessStatus, ProcessType } from './types.js'

const processMessages: Record<
  ProcessType,
  Partial<Record<ProcessStatus, string>>
> = {
  TOKEN_ALLOWANCE: {
    STARTED: 'Setting token allowance',
    PENDING: 'Waiting for token allowance',
    DONE: 'Token allowance set',
  },
  SWAP: {
    STARTED: 'Preparing swap transaction',
    ACTION_REQUIRED: 'Sign swap transaction',
    MESSAGE_REQUIRED: 'Sign swap message',
    PENDING: 'Waiting for swap transaction',
    DONE: 'Swap completed',
  },
  CROSS_CHAIN: {
    STARTED: 'Preparing bridge transaction',
    ACTION_REQUIRED: 'Sign bridge transaction',
    MESSAGE_REQUIRED: 'Sign bridge message',
    PENDING: 'Waiting for bridge transaction',
    DONE: 'Bridge transaction confirmed',
  },
  RECEIVING_CHAIN: {
    PENDING: 'Waiting for destination chain',
    DONE: 'Bridge completed',
  },
  PERMIT: {
    STARTED: 'Preparing transaction',
    ACTION_REQUIRED: 'Sign permit message',
    PENDING: 'Waiting for permit message',
    DONE: 'Permit message signed',
  },
}
const substatusMessages: Record<
  StatusMessage,
  Partial<Record<Substatus, string>>
> = {
  PENDING: {
    BRIDGE_NOT_AVAILABLE: 'Bridge communication is temporarily unavailable.',
    CHAIN_NOT_AVAILABLE: 'RPC communication is temporarily unavailable.',
    UNKNOWN_ERROR:
      'An unexpected error occurred. Please seek assistance in the LI.FI discord server.',
    WAIT_SOURCE_CONFIRMATIONS:
      'The bridge deposit has been received. The bridge is waiting for more confirmations to start the off-chain logic.',
    WAIT_DESTINATION_TRANSACTION:
      'The bridge off-chain logic is being executed. Wait for the transaction to appear on the destination chain.',
  },
  DONE: {
    PARTIAL:
      'Some of the received tokens are not the requested destination tokens.',
    REFUNDED: 'The tokens were refunded to the sender address.',
    COMPLETED: 'The transfer is complete.',
  },
  FAILED: {},
  INVALID: {},
  NOT_FOUND: {},
}

export function getProcessMessage(
  type: ProcessType,
  status: ProcessStatus
): string | undefined {
  const processMessage = processMessages[type][status]
  return processMessage
}

export function getSubstatusMessage(
  status: StatusMessage,
  substatus?: Substatus
): string | undefined {
  if (!substatus) {
    return
  }
  const message = substatusMessages[status][substatus]
  return message
}