@lifi/types 10.0.0-beta.1 → 10.0.0

package/src/chains/index.ts

@@ -1,4 +0,0 @@
-export * from './Chain.js'
-export * from './EVMChain.js'
-export * from './SolanaChain.js'
-export * from './base.js'

package/src/errors.ts

@@ -1,15 +0,0 @@
-// Error codes emitted by the LI.FI API
-export enum ErrorCode {
-  DefaultError = 1000,
-  FailedToBuildTransactionError = 1001,
-  NoQuoteError = 1002,
-  NotFoundError = 1003,
-  NotProcessableError = 1004,
-  RateLimitError = 1005,
-  ServerError = 1006,
-  SlippageError = 1007,
-  ThirdPartyError = 1008,
-  TimeoutError = 1009,
-  UnauthorizedError = 1010,
-  ValidationError = 1011,
-}

package/src/exchanges.ts

@@ -1,27 +0,0 @@
-import type { StaticToken } from './tokens/token.js'
-
-export interface ExchangeAggregator {
-  key: string
-  name: string
-  logoURI: string
-  webUrl: string
-}
-
-export interface Exchange {
-  key: string
-  name: string
-  chainId: number
-  logoURI: string
-  webUrl: string
-  graph?: string
-  tokenlistUrl: string
-  routerAddress: string
-  factoryAddress: string
-  initCodeHash: string
-  baseTokens: readonly StaticToken[]
-}
-
-export interface ExchangeDefinition {
-  tool: string
-  chains: number[]
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-export * from './api.js'
-export * from './bridges.js'
-export * from './chains/index.js'
-export * from './errors.js'
-export * from './exchanges.js'
-export * from './quests.js'
-export * from './step.js'
-export * from './tokens/index.js'

package/src/step.ts

@@ -1,192 +0,0 @@
-import type { Substatus, TransactionRequest } from './api.js'
-import type { Token } from './tokens/index.js'
-
-export interface FeeCost {
-  name: string
-  description: string
-  percentage: string
-  token: Token
-  amount: string
-  amountUSD: string
-  included: boolean
-}
-
-export interface GasCost {
-  type: 'SUM' | 'APPROVE' | 'SEND' | 'FEE'
-  price: string // suggested current standard price for chain
-  estimate: string // estimate how much gas will be needed
-  limit: string // suggested gas limit (estimate +25%)
-  amount: string // estimate * price = amount of tokens that will be needed
-  amountUSD: string // usd value of token amount
-  token: Token // the used gas token
-}
-
-// ACTION
-export interface Action {
-  fromChainId: number
-  fromAmount: string
-  fromToken: Token
-  fromAddress?: string
-
-  toChainId: number
-  toToken: Token
-  toAddress?: string
-
-  slippage: number
-}
-
-// ESTIMATE
-export interface Estimate {
-  tool: string
-  fromAmount: string
-  fromAmountUSD?: string
-  toAmount: string
-  toAmountMin: string
-  toAmountUSD?: string
-  approvalAddress: string
-  feeCosts?: FeeCost[]
-  // This is a list to account for approval gas costs and transaction gas costs. However, approval gas costs are not used at the moment
-  gasCosts?: GasCost[]
-  // estimated duration in seconds
-  executionDuration: number
-}
-
-// EXECUTION
-export type Status =
-  | 'NOT_STARTED'
-  | 'STARTED'
-  | 'ACTION_REQUIRED'
-  | 'CHAIN_SWITCH_REQUIRED'
-  | 'PENDING'
-  | 'FAILED'
-  | 'DONE'
-  | 'RESUME'
-  | 'CANCELLED'
-
-export type ProcessType =
-  | 'TOKEN_ALLOWANCE'
-  | 'SWITCH_CHAIN'
-  | 'SWAP'
-  | 'CROSS_CHAIN'
-  | 'RECEIVING_CHAIN'
-  | 'TRANSACTION'
-
-export interface Process {
-  startedAt: number
-  doneAt?: number
-  failedAt?: number
-  type: ProcessType
-  status: Status
-  substatus?: Substatus
-  message?: string
-  txHash?: string
-  txLink?: string
-  multisigTxHash?: string
-  error?: {
-    code: string | number
-    message: string
-    htmlMessage?: string
-  }
-
-  // additional information
-  [key: string]: any
-}
-
-export interface Execution {
-  status: Status
-  process: Array<Process>
-  fromAmount?: string
-  toAmount?: string
-  toToken?: Token
-  feeCosts?: FeeCost[]
-  gasCosts?: GasCost[]
-}
-
-export const emptyExecution: Execution = {
-  status: 'NOT_STARTED',
-  process: [],
-}
-
-// STEP
-export const _StepType = [
-  'lifi',
-  'swap',
-  'cross',
-  'protocol',
-  'custom',
-] as const
-export type StepType = (typeof _StepType)[number]
-export type StepTool = string
-export type StepToolDetails = {
-  key: string
-  name: string
-  logoURI: string
-}
-
-export interface StepBase {
-  id: string
-  type: StepType
-  tool: StepTool
-  toolDetails: StepToolDetails
-  integrator?: string
-  referrer?: string
-  action: Action
-  estimate?: Estimate
-  transactionRequest?: TransactionRequest
-}
-
-export interface DestinationCallInfo {
-  toContractAddress: string
-  toContractCallData: string
-  toFallbackAddress: string
-  callDataGasLimit: string
-}
-
-export type CallAction = Action & DestinationCallInfo
-
-export interface SwapStep extends StepBase {
-  type: 'swap'
-  action: Action
-  estimate: Estimate
-}
-
-export interface CrossStep extends StepBase {
-  type: 'cross'
-  action: Action
-  estimate: Estimate
-}
-
-export interface ProtocolStep extends StepBase {
-  type: 'protocol'
-  action: Action
-  estimate: Estimate
-}
-
-export interface CustomStep extends StepBase {
-  type: 'custom'
-  action: CallAction
-  estimate: Estimate
-}
-
-export type Step = SwapStep | CrossStep | CustomStep | ProtocolStep
-
-export interface LiFiStep extends Omit<Step, 'type'> {
-  type: 'lifi'
-  includedSteps: Step[]
-}
-
-export function isSwapStep(step: Step): step is SwapStep {
-  return step.type === 'swap'
-}
-
-export function isCrossStep(step: Step): step is CrossStep {
-  return step.type === 'cross'
-}
-
-export function isProtocolStep(step: Step): step is ProtocolStep {
-  return step.type === 'protocol'
-}
-
-export function isCustomStep(step: Step): step is CustomStep {
-  return step.type === 'custom'
-}

package/src/tokens/base.ts

@@ -1,66 +0,0 @@
-export enum CoinKey {
-  ETH = 'ETH',
-  MATIC = 'MATIC',
-  BNB = 'BNB',
-  DAI = 'DAI',
-  FTM = 'FTM',
-  OKT = 'OKT',
-  AVAX = 'AVAX',
-  HT = 'HT',
-  ONE = 'ONE',
-  FSN = 'FSN',
-  MOVR = 'MOVR',
-  EXP = 'EXP',
-  TCH = 'TCH',
-  UBQ = 'UBQ',
-  META = 'META',
-  DIODE = 'DIODE',
-  CELO = 'CELO',
-  FUSE = 'FUSE',
-  TLOS = 'TLOS',
-  CRO = 'CRO',
-  SHIB = 'SHIB',
-  L1 = 'L1',
-  RBTC = 'RBTC',
-  TBG = 'TBG',
-  VLX = 'VLX',
-  GLMR = 'GLMR',
-  METIS = 'METIS',
-  SOL = 'SOL',
-  EVM = 'EVM',
-
-  // Stable coins
-  USDT = 'USDT',
-  USDC = 'USDC',
-  cbtUSDC = 'cbtUSDC', // cBridge testnet USDC
-  cbtUSDT = 'cbtUSDT', // cBridge testnet USDT
-  cbtWUSDT = 'cbtWUSDT', // cBridge testnet wrapped USDT
-  cbtWUSDC = 'cbtWUSDC', // cBridge testnet wrapped USDC
-  cbtCELR = 'cbtCELR', // cBridge testnet CELR
-  BUSD = 'BUSD',
-  USDCe = 'USDCe',
-
-  // Testnet
-  TEST = 'TEST',
-  KAL = 'KAL',
-  SDIODE = 'SDIODE',
-  SPARK = 'SPARK',
-  TRBTC = 'TRBTC',
-  CXTT = 'CXTT', // Connext Test token
-
-  // stargate testnet tokens
-  sgMETIS = 'sgMETIS', // sgMETIS test token
-  sgWOO = 'sgWOO', // sgWOO test token
-  sgUSDT = 'sgUSDT', // sgUSDT test token
-  sgBUSD = 'sgBUSD', // sgBUSD test token
-  sgUSDC = 'sgUSDC', // sgUSDC test token
-
-  // Other tokens
-  WBTC = 'WBTC',
-  WETH = 'WETH',
-  SUSHI = 'SUSHI',
-  DODO = 'DODO',
-  MCB = 'MCB',
-  CELR = 'CELR',
-  IF = 'IF',
-}

package/src/tokens/index.ts

@@ -1,2 +0,0 @@
-export * from './base.js'
-export * from './token.js'

package/src/tokens/token.ts

@@ -1,34 +0,0 @@
-import { ChainId } from '../chains/base.js'
-import { CoinKey } from './base.js'
-
-export interface BaseToken {
-  chainId: ChainId
-  address: string
-}
-
-export interface StaticToken extends BaseToken {
-  symbol: string
-  decimals: number
-  name: string
-  coinKey?: CoinKey
-  logoURI?: string
-}
-
-export interface Token extends StaticToken {
-  priceUSD: string
-}
-
-export interface TokenAmount extends Token {
-  amount?: bigint
-  blockNumber?: bigint
-}
-
-export interface Coin {
-  key: CoinKey
-  name: string
-  logoURI: string
-  verified: boolean
-  chains: {
-    [ChainId: string]: StaticToken
-  }
-}