@lifi/types 11.0.0-beta.1 → 11.0.0-beta.2

package/src/bridges.ts

@@ -0,0 +1,30 @@
+import type { BaseToken } from './tokens/token.js'
+
+export interface Bridge {
+  key: string
+  name: string
+  logoURI: string
+  bridgeUrl?: string
+  discordUrl?: string
+  supportUrl?: string
+  docsUrl?: string
+  explorerUrl?: string
+  analyticsUrl?: string
+}
+
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
+export interface BridgeDefinition {
+  tool: string
+  fromChainId: number
+  fromToken: BaseToken
+  toChainId: number
+  toToken: BaseToken
+  maximumTransfer: string
+  minimumTransfer: string
+  swapFeeRate: string
+  swapFeeMinimum: string
+  swapFeeMaximum: string
+}

package/src/chains/Chain.ts

@@ -0,0 +1,20 @@
+import { CoinKey } from '../tokens/base.js'
+import { ChainKey } from './base.js'
+
+export enum ChainType {
+  EVM = 'EVM',
+  // Solana virtual machine
+  SVM = 'SVM',
+}
+
+export interface _Chain {
+  key: ChainKey
+  chainType: ChainType
+  name: string
+  coin: CoinKey
+  id: number
+  mainnet: boolean
+  logoURI?: string
+  // faucetUrls is DEPRECATED - will be removed in the next breaking release
+  faucetUrls?: string[]
+}

package/src/chains/EVMChain.ts

@@ -0,0 +1,25 @@
+import type { _Chain } from './Chain.js'
+
+export interface EVMChain extends _Chain {
+  // tokenlistUrl is DEPRECATED - will be removed in the next breaking release
+  tokenlistUrl?: string
+  metamask: AddEthereumChainParameter
+  multicallAddress?: string
+}
+
+export interface AddEthereumChainParameter {
+  chainId: string
+  blockExplorerUrls: string[]
+  chainName: string
+  nativeCurrency: {
+    name: string
+    symbol: string
+    decimals: number
+  }
+  rpcUrls: string[]
+}
+
+// This type alias is required to avoid breaking
+// changes with the new non EVM support types release
+// This will be removed in the future in favour of _Chain
+export type Chain = EVMChain

package/src/chains/SolanaChain.ts

@@ -0,0 +1,8 @@
+import type { _Chain } from './Chain.js'
+import type { AddEthereumChainParameter } from './EVMChain.js'
+
+export interface SolanaChain extends _Chain {
+  tokenlistUrl?: string
+  metamask: AddEthereumChainParameter
+  multicallAddress?: string
+}

package/src/chains/base.ts

@@ -0,0 +1,129 @@
+export enum ChainKey {
+  ETH = 'eth',
+  POL = 'pol',
+  BSC = 'bsc',
+  DAI = 'dai',
+  OKT = 'okt',
+  FTM = 'ftm',
+  AVA = 'ava',
+  ARB = 'arb',
+  HEC = 'hec',
+  OPT = 'opt',
+  ONE = 'one',
+  FSN = 'fsn',
+  MOR = 'mor',
+  EXP = 'exp',
+  TCH = 'tch',
+  UBQ = 'ubq',
+  MET = 'met',
+  DIO = 'dio',
+  CEL = 'cel',
+  FUS = 'fus',
+  TLO = 'tlo',
+  CRO = 'cro',
+  BOB = 'bob',
+  SHI = 'shi',
+  GL1 = 'gl1',
+  RSK = 'rsk',
+  TBW = 'tbw',
+  VEL = 'vel',
+  MOO = 'moo',
+  MAM = 'mam',
+  AUR = 'aur',
+  TER = 'ter',
+  OAS = 'oas',
+  SOL = 'sol',
+  EVM = 'evm',
+  ARN = 'arn',
+  ERA = 'era',
+  PZE = 'pze',
+  LNA = 'lna',
+  BAS = 'bas',
+
+  // Testnets
+  GOR = 'gor',
+  METT = 'mett',
+  DIOT = 'diot',
+  MUM = 'mum',
+  ARBG = 'arbg',
+  OPTG = 'optg',
+  BSCT = 'bsct',
+  HECT = 'hect',
+  ONET = 'onet',
+  FUST = 'fust',
+  TLOT = 'tlot',
+  RSKT = 'rskt',
+  SOLT = 'solt',
+  OAST = 'oast',
+  TERT = 'tert',
+  AVAT = 'avat',
+  EVMT = 'evmt',
+  MORT = 'mort',
+  FTMT = 'ftmt',
+  LNAT = 'lnat',
+}
+
+export enum ChainId {
+  ETH = 1,
+  POL = 137,
+  BSC = 56,
+  DAI = 100,
+  OKT = 66,
+  FTM = 250,
+  AVA = 43114,
+  ARB = 42161,
+  HEC = 128,
+  OPT = 10,
+  ONE = 1666600000,
+  FSN = 32659,
+  MOR = 1285,
+  EXP = 2,
+  TCH = 7,
+  UBQ = 8,
+  MET = 11,
+  DIO = 15,
+  CEL = 42220,
+  FUS = 122,
+  TLO = 40,
+  CRO = 25,
+  BOB = 288,
+  SHI = 27,
+  GL1 = 29,
+  RSK = 30,
+  TBW = 35,
+  VEL = 106,
+  MOO = 1284,
+  MAM = 1088,
+  AUR = 1313161554,
+  SOL = 1151111081099710, // this id is made up by the LI.FI team!
+  TER = 1161011141099710, // this id is made up by the LI.FI team!
+  OAS = 111971151099710, // this id is made up by the LI.FI team!
+  EVM = 9001,
+  ARN = 42170,
+  ERA = 324,
+  PZE = 1101,
+  LNA = 59144,
+  BAS = 8453,
+
+  // Testnets
+  GOR = 5,
+  METT = 12,
+  DIOT = 13,
+  MUM = 80001,
+  ARBG = 421613,
+  OPTG = 420,
+  BSCT = 97,
+  HECT = 256,
+  ONET = 1666700000,
+  FUST = 123,
+  TLOT = 41,
+  RSKT = 31,
+  SOLT = 1151111081161011, // this id is made up by the LI.FI team!
+  TERT = 1161011141161011, // this id is made up by the LI.FI team!
+  OAST = 1119711511610111, // this id is made up by the LI.FI team!
+  AVAT = 43113,
+  EVMT = 9000,
+  MORT = 1287,
+  FTMT = 4002,
+  LNAT = 59140,
+}

package/src/chains/index.ts

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

package/src/errors.ts

@@ -0,0 +1,15 @@
+// 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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,8 @@
+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/{dist/quests.d.ts → src/quests.ts}

@@ -1,24 +1,30 @@
 export interface BaseQuest {
-    id: string;
-    name: string;
-    description: string;
+  id: string
+  name: string
+  description: string
 }
+
 export interface QuestStatus extends BaseQuest {
-    completed: boolean;
+  completed: boolean
 }
+
 export type GetQuestStatusRequest = {
-    questId: string;
-    walletAddress: string;
-};
+  questId: string
+  walletAddress: string
+}
+
 export type GetQuestsStatusRequest = {
-    walletAddress: string;
-};
+  walletAddress: string
+}
+
 export type GetQuestStatusResponse = {
-    quest: QuestStatus;
-};
+  quest: QuestStatus
+}
+
 export type GetQuestsStatusResponse = {
-    quests: QuestStatus[];
-};
+  quests: QuestStatus[]
+}
+
 export type GetAllQuestsResponse = {
-    quests: BaseQuest[];
-};
+  quests: BaseQuest[]
+}

package/src/step.ts

@@ -0,0 +1,192 @@
+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

@@ -0,0 +1,66 @@
+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

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

package/src/tokens/token.ts

@@ -0,0 +1,34 @@
+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
+  }
+}