@lifi/types 10.0.0 → 11.0.0-alpha.0

package/dist/cjs/api.d.ts

@@ -1,355 +0,0 @@
-import { TransactionRequest } from '@ethersproject/providers';
-import { BridgeDefinition, Chain, ChainId, ChainKey, ChainType, ExchangeDefinition, LifiStep, Token } from '.';
-import { ToolError } from './apiErrors';
-export declare const Orders: readonly ["RECOMMENDED", "FASTEST", "CHEAPEST", "SAFEST"];
-export type Order = (typeof Orders)[number];
-export interface RoutesRequest {
-    fromChainId: number;
-    fromAmount: string;
-    fromTokenAddress: string;
-    fromAddress?: string;
-    toChainId: number;
-    toTokenAddress: string;
-    toAddress?: string;
-    options?: RouteOptions;
-    fromAmountForGas?: string;
-}
-export interface RouteOptions {
-    order?: Order;
-    slippage?: number;
-    infiniteApproval?: boolean;
-    allowSwitchChain?: boolean;
-    integrator?: string;
-    allowDestinationCall?: boolean;
-    referrer?: string;
-    bridges?: AllowDenyPrefer;
-    exchanges?: AllowDenyPrefer;
-    fee?: number;
-    insurance?: boolean;
-    maxPriceImpact?: number;
-}
-export type ToolsResponse = {
-    exchanges: {
-        key: string;
-        name: string;
-        logoURI: string;
-        supportedChains: ChainId[];
-    }[];
-    bridges: {
-        key: string;
-        name: string;
-        logoURI: string;
-        supportedChains: {
-            fromChainId: ChainId;
-            toChainId: ChainId;
-        }[];
-    }[];
-};
-export interface AllowDenyPrefer {
-    allow?: string[];
-    deny?: string[];
-    prefer?: string[];
-}
-export declare const _InsuranceState: readonly ["INSURED", "INSURABLE", "NOT_INSURABLE"];
-export type InsuranceState = (typeof _InsuranceState)[number];
-export interface Insurance {
-    state: InsuranceState;
-    feeAmountUsd: string;
-}
-export interface Route {
-    id: string;
-    insurance: Insurance;
-    fromChainId: number;
-    fromAmountUSD: string;
-    fromAmount: string;
-    fromToken: Token;
-    fromAddress?: string;
-    toChainId: number;
-    toAmountUSD: string;
-    toAmount: string;
-    toAmountMin: string;
-    toToken: Token;
-    toAddress?: string;
-    gasCostUSD?: string;
-    containsSwitchChain?: boolean;
-    infiniteApproval?: boolean;
-    steps: LifiStep[];
-    tags?: Order[];
-}
-export type ErroredPaths = {
-    [subpath: string]: ToolError[];
-};
-export type ErroredRoute = {
-    overallPath: string;
-    subpaths: ErroredPaths;
-};
-export type FilteredResult = {
-    overallPath: string;
-    reason: string;
-};
-export type UnavailableRoutes = {
-    filteredOut: FilteredResult[];
-    failed: ErroredRoute[];
-};
-export interface RoutesResponse {
-    routes: Route[];
-    unavailableRoutes: UnavailableRoutes;
-}
-export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges';
-/**
- * We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
- * @deprecated
- */
-export interface PossibilitiesRequest {
-    chains?: number[];
-    bridges?: AllowDenyPrefer;
-    exchanges?: AllowDenyPrefer;
-    include?: PossibilityTopic[];
-}
-/**
- * Should not be accessed via the types package anymore
- * @deprecated
- */
-export interface PossibilitiesResponse {
-    chains?: Chain[];
-    tokens?: Token[];
-    bridges?: BridgeDefinition[];
-    exchanges?: ExchangeDefinition[];
-}
-export interface GetTokenRequest {
-    chain: number | string;
-    token: string;
-}
-export interface ToolConfiguration {
-    allowBridges?: string[];
-    denyBridges?: string[];
-    preferBridges?: string[];
-    allowExchanges?: string[];
-    denyExchanges?: string[];
-    preferExchanges?: string[];
-}
-export interface QuoteRequest extends ToolConfiguration {
-    fromChain: number | string;
-    fromToken: string;
-    fromAddress: string;
-    fromAmount: string;
-    toChain: number | string;
-    toToken: string;
-    toAddress?: string;
-    order?: Order;
-    slippage?: number | string;
-    integrator?: string;
-    referrer?: string;
-    fee?: number | string;
-    insurance?: boolean;
-    allowDestinationCall?: boolean;
-    fromAmountForGas?: string;
-    maxPriceImpact?: number;
-}
-export interface ContractCall {
-    fromAmount: string;
-    fromTokenAddress: string;
-    toContractAddress: string;
-    toContractCallData: string;
-    toContractGasLimit: string;
-    toApprovalAddress?: string;
-    toTokenAddress?: string;
-}
-export interface ContractCallsQuoteRequest extends ToolConfiguration {
-    fromChain: number | string;
-    fromToken: string;
-    fromAddress: string;
-    toChain: number | string;
-    toToken: string;
-    toAmount: string;
-    toFallbackAddress?: string;
-    contractOutputsToken?: string;
-    contractCalls: ContractCall[];
-    slippage?: number | string;
-    integrator?: string;
-    referrer?: string;
-    fee?: number | string;
-    allowDestinationCall?: boolean;
-}
-export interface ContractCallQuoteRequest extends ToolConfiguration {
-    fromChain: number | string;
-    fromToken: string;
-    fromAddress: string;
-    toChain: number | string;
-    toToken: string;
-    toAmount: string;
-    toContractAddress: string;
-    toContractCallData: string;
-    toContractGasLimit: string;
-    toApprovalAddress?: string;
-    toFallbackAddress?: string;
-    contractOutputsToken?: string;
-    slippage?: number | string;
-    integrator?: string;
-    referrer?: string;
-    fee?: number | string;
-    allowDestinationCall?: boolean;
-}
-export interface ConnectionsRequest extends ToolConfiguration {
-    fromChain?: number | string;
-    fromToken?: string;
-    toChain?: number | string;
-    toToken?: string;
-    chainTypes?: ChainType[];
-}
-export interface Connection {
-    fromChainId: number;
-    toChainId: number;
-    fromTokens: Token[];
-    toTokens: Token[];
-}
-export interface ConnectionsResponse {
-    connections: Connection[];
-}
-export interface GetStatusRequest {
-    txHash: string;
-    bridge?: string;
-    fromChain?: number | string;
-    toChain?: number | string;
-}
-export interface BaseTransactionInfo {
-    txHash: string;
-    chainId: ChainId;
-    txLink: string;
-}
-export interface ExtendedTransactionInfo extends BaseTransactionInfo {
-    amount?: string;
-    amountUSD?: string;
-    token?: Token;
-    gasPrice: string;
-    gasUsed: string;
-    gasToken: Token;
-    gasAmount: string;
-    gasAmountUSD: string;
-    timestamp?: number;
-}
-export interface PendingReceivingInfo {
-    chainId: ChainId;
-}
-declare const _StatusMessage: readonly ["NOT_FOUND", "INVALID", "PENDING", "DONE", "FAILED"];
-export type StatusMessage = (typeof _StatusMessage)[number];
-declare const _SubstatusPending: readonly ["WAIT_SOURCE_CONFIRMATIONS", "WAIT_DESTINATION_TRANSACTION", "BRIDGE_NOT_AVAILABLE", "CHAIN_NOT_AVAILABLE", "NOT_PROCESSABLE_REFUND_NEEDED", "REFUND_IN_PROGRESS", "UNKNOWN_ERROR"];
-export type SubstatusPending = (typeof _SubstatusPending)[number];
-declare const _SubstatusDone: readonly ["COMPLETED", "PARTIAL", "REFUNDED"];
-export type SubstatusDone = (typeof _SubstatusDone)[number];
-export type Substatus = SubstatusPending | SubstatusDone;
-export declare const isSubstatusPending: (substatus: Substatus) => substatus is "UNKNOWN_ERROR" | "WAIT_SOURCE_CONFIRMATIONS" | "WAIT_DESTINATION_TRANSACTION" | "BRIDGE_NOT_AVAILABLE" | "CHAIN_NOT_AVAILABLE" | "NOT_PROCESSABLE_REFUND_NEEDED" | "REFUND_IN_PROGRESS";
-export declare const isSubstatusDone: (substatus: Substatus) => substatus is "COMPLETED" | "PARTIAL" | "REFUNDED";
-export interface BaseStatusData {
-    status: StatusMessage;
-    substatus?: Substatus;
-    substatusMessage?: string;
-}
-export interface StatusData extends BaseStatusData {
-    tool: string;
-    sending: BaseTransactionInfo;
-    receiving: PendingReceivingInfo;
-}
-export type StatusResponse = FullStatusData | StatusData;
-interface TransferMetadata {
-    integrator: string;
-}
-export interface FullStatusData extends StatusData {
-    transactionId: string;
-    sending: ExtendedTransactionInfo;
-    receiving: PendingReceivingInfo | ExtendedTransactionInfo;
-    lifiExplorerLink: string;
-    fromAddress: string;
-    toAddress: string;
-    metadata: TransferMetadata;
-    bridgeExplorerLink?: string;
-}
-export interface ExtendedChain extends Chain {
-    nativeToken: Token;
-}
-export interface ChainsResponse {
-    chains: ExtendedChain[];
-}
-export interface ChainsRequest {
-    chainTypes?: ChainType[];
-}
-export interface ToolsRequest {
-    chains?: (ChainKey | ChainId)[];
-}
-export type TokensRequest = {
-    chains?: (ChainId | ChainKey)[];
-    chainTypes?: ChainType[];
-};
-export type TokensResponse = {
-    tokens: {
-        [chainId: number]: Token[];
-    };
-};
-export type RequestOptions = {
-    signal?: AbortSignal;
-};
-export interface Integrator {
-    integratorId: string;
-    feeBalances: FeeBalance[];
-}
-export type FeeBalance = {
-    chainId: ChainId;
-    tokenBalances: TokenBalance[];
-};
-export type TokenBalance = {
-    token: Token;
-    amount: string;
-    amountUsd: string;
-};
-export interface IntegratorWithdrawalRequest {
-    integratorId: string;
-    chainId: ChainId;
-    tokens?: string[];
-}
-export interface IntegratorWithdrawalTransactionResponse {
-    transactionRequest: TransactionRequest;
-}
-declare const _LIFuelState: readonly ["PENDING", "DONE", "NOT_FOUND"];
-type LIFuelState = (typeof _LIFuelState)[number];
-export type LIFuelStatusResponse = {
-    status: LIFuelState;
-    sending?: ExtendedTransactionInfo;
-    receiving?: PendingReceivingInfo | ExtendedTransactionInfo;
-};
-export type GasRecommendationRequest = {
-    chainId: ChainId;
-    fromChain?: ChainId;
-    fromToken?: string;
-};
-export type RefetchSourceLIFuelRequest = {
-    txHash: string;
-    chainId: ChainId;
-};
-export type LIFuelStatusRequest = {
-    txHash: string;
-};
-export type RefetchLIFuelRequest = {
-    txHash: string;
-    chainId: ChainId;
-};
-export type GasRecommendationResponse = {
-    available: false;
-    message: string;
-} | {
-    available: true;
-    recommended: TokenBalance;
-    limit: TokenBalance;
-    serviceFee: TokenBalance;
-    fromToken?: Token;
-    fromAmount?: string;
-};
-export interface WalletAnalytics {
-    walletAddress: string;
-    transactions: StatusResponse[];
-}
-export interface WalletAnalyticsRequest {
-    walletAddress: string;
-    fromTimestamp: number;
-    toTimestamp: number;
-}
-export {};

package/dist/cjs/apiErrors.d.ts

@@ -1,23 +0,0 @@
-import { Action } from './step';
-export type ToolErrorType = 'NO_QUOTE';
-export interface ToolError {
-    errorType: ToolErrorType;
-    code: string;
-    action: Action;
-    tool: string;
-    message: string;
-}
-export declare 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/dist/cjs/base.d.ts

@@ -1,231 +0,0 @@
-import { BridgeTool } from './bridges';
-import { ExchangeTools } from './exchanges';
-export declare 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",
-    USDT = "USDT",
-    USDC = "USDC",
-    cbtUSDC = "cbtUSDC",
-    cbtUSDT = "cbtUSDT",
-    cbtWUSDT = "cbtWUSDT",
-    cbtWUSDC = "cbtWUSDC",
-    cbtCELR = "cbtCELR",
-    BUSD = "BUSD",
-    USDCe = "USDCe",
-    TEST = "TEST",
-    KAL = "KAL",
-    SDIODE = "SDIODE",
-    SPARK = "SPARK",
-    TRBTC = "TRBTC",
-    CXTT = "CXTT",
-    sgMETIS = "sgMETIS",
-    sgWOO = "sgWOO",
-    sgUSDT = "sgUSDT",
-    sgBUSD = "sgBUSD",
-    sgUSDC = "sgUSDC",
-    WBTC = "WBTC",
-    WETH = "WETH",
-    SUSHI = "SUSHI",
-    DODO = "DODO",
-    MCB = "MCB",
-    CELR = "CELR",
-    IF = "IF"
-}
-export declare 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",
-    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 declare 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,
-    TER = 1161011141099710,
-    OAS = 111971151099710,
-    EVM = 9001,
-    ARN = 42170,
-    ERA = 324,
-    PZE = 1101,
-    LNA = 59144,
-    BAS = 8453,
-    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,
-    TERT = 1161011141161011,
-    OAST = 1119711511610111,
-    AVAT = 43113,
-    EVMT = 9000,
-    MORT = 1287,
-    FTMT = 4002,
-    LNAT = 59140
-}
-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: string;
-    blockNumber?: number;
-}
-export interface Coin {
-    key: CoinKey;
-    name: string;
-    logoURI: string;
-    verified: boolean;
-    chains: {
-        [ChainId: string]: StaticToken;
-    };
-}
-export interface ExchangeDefinition {
-    tool: ExchangeTools;
-    chains: number[];
-}
-/**
- * Should not be accessed via the types package anymore
- * @deprecated
- */
-export interface BridgeDefinition {
-    tool: BridgeTool;
-    fromChainId: number;
-    fromToken: BaseToken;
-    toChainId: number;
-    toToken: BaseToken;
-    maximumTransfer: string;
-    minimumTransfer: string;
-    swapFeeRate: string;
-    swapFeeMinimum: string;
-    swapFeeMaximum: string;
-}

package/dist/cjs/bridges.d.ts

@@ -1,34 +0,0 @@
-/**
- * @deprecated
- * These values are now obtainable from the LI.FI API
- */
-export declare enum BridgeTool {
-    connext = "connext",
-    hop = "hop",
-    multichain = "multichain",
-    cbridge = "cbridge",
-    hyphen = "hyphen",
-    polygon = "polygon",
-    arbitrum = "arbitrum",
-    avalanche = "avalanche",
-    optimism = "optimism",
-    across = "across",
-    portal = "portal",
-    stargate = "stargate"
-}
-export interface Bridge {
-    key: BridgeTool;
-    name: string;
-    logoURI: string;
-    bridgeUrl?: string;
-    discordUrl?: string;
-    supportUrl?: string;
-    docsUrl?: string;
-    explorerUrl?: string;
-    analyticsUrl?: string;
-}
-/**
- * @deprecated
- * These values are now obtainable from the LI.FI API
- */
-export declare const supportedBridges: Array<Bridge>;