@lifi/types 9.0.0-alpha.9 → 9.0.0

package/README.md

@@ -1,37 +1,9 @@
-<div align="center">
+### Installation
 
-[![license](https://img.shields.io/badge/license-Apache%202-blue)](/LICENSE.md)
-[![npm latest package](https://img.shields.io/npm/v/@lifi/types/latest.svg)](https://www.npmjs.com/package/@lifi/types)
-[![npm downloads](https://img.shields.io/npm/dm/@lifi/types.svg)](https://www.npmjs.com/package/@lifi/types)
-[![Follow on Twitter](https://img.shields.io/twitter/follow/lifiprotocol.svg?label=follow+LI.FI)](https://twitter.com/lifiprotocol)
-
-</div>
-
-# LI.FI - Types
-
-Types for the LI.FI stack.
-
-## Summary
-
-This package contains all common types for the [LI.FI SDK](https://github.com/lifinance/sdk).
-Learn more about LI.FI on (https://li.fi).
-
-Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.
-
-## Installation
-
-Install dependencies with yarn:
-
-```bash
-yarn add @lifi/types
 ```
-
-or
-
-```bash
 npm install --save @lifi/types
 ```
 
-## Summary
+### Summary
 
 This package contains type definitions for LI.FI projects (https://github.com/lifinance).

package/dist/api.d.ts

@@ -1,32 +1,6 @@
-import { BridgeDefinition } from './bridges';
-import { Chain } from './chains';
-import { ChainId } from './chains/base';
-import { ExchangeDefinition } from './exchanges';
-import { Action, LifiStep } from './step';
-import { Token } from './tokens';
-/**
- * Used as a bigint replacement for TransactionRequest because bigint is not serializable
- */
-export type BigIntish = string;
-export type TransactionRequest = {
-    to?: string;
-    from?: string;
-    nonce?: number;
-    gasLimit?: BigIntish;
-    gasPrice?: BigIntish;
-    data?: string;
-    value?: BigIntish;
-    chainId?: number;
-    type?: number;
-    accessList?: {
-        address: string;
-        storageKeys: string[];
-    }[];
-    maxPriorityFeePerGas?: BigIntish;
-    maxFeePerGas?: BigIntish;
-    customData?: Record<string, any>;
-    ccipReadEnabled?: boolean;
-};
+import { TransactionRequest } from '@ethersproject/providers';
+import { BridgeDefinition, Chain, ChainId, 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 {
@@ -41,18 +15,18 @@ export interface RoutesRequest {
     fromAmountForGas?: string;
 }
 export interface RouteOptions {
-    integrator?: string;
-    fee?: number;
-    insurance?: boolean;
-    maxPriceImpact?: number;
     order?: Order;
     slippage?: number;
-    referrer?: string;
     infiniteApproval?: boolean;
     allowSwitchChain?: boolean;
+    integrator?: string;
     allowDestinationCall?: boolean;
+    referrer?: string;
     bridges?: AllowDenyPrefer;
     exchanges?: AllowDenyPrefer;
+    fee?: number;
+    insurance?: boolean;
+    maxPriceImpact?: number;
 }
 export type ToolsResponse = {
     exchanges: {
@@ -102,14 +76,6 @@ export interface Route {
     steps: LifiStep[];
     tags?: Order[];
 }
-export type ToolErrorType = 'NO_QUOTE';
-export interface ToolError {
-    errorType: ToolErrorType;
-    code: string;
-    action: Action;
-    tool: string;
-    message: string;
-}
 export type ErroredPaths = {
     [subpath: string]: ToolError[];
 };
@@ -180,50 +146,56 @@ export interface QuoteRequest extends ToolConfiguration {
     fromAmountForGas?: string;
     maxPriceImpact?: number;
 }
-export interface ContractCallQuoteRequest extends ToolConfiguration {
+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;
-    toContractAddress: string;
-    toContractCallData: string;
-    toContractGasLimit: string;
-    toApprovalAddress?: string;
     toFallbackAddress?: string;
     contractOutputsToken?: string;
+    contractCalls: ContractCall[];
     slippage?: number | string;
     integrator?: string;
     referrer?: string;
     fee?: number | string;
     allowDestinationCall?: boolean;
 }
-export interface ContractCallQuotesRequest extends ToolConfiguration {
+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;
-    toContractCalls: {
-        sendingAmount: string;
-        sendingToken: string;
-        receivingToken: string;
-        contractAddress: string;
-        approvalAddress?: string;
-        callData: string;
-        gasLimit: string;
-    }[];
-    order?: Order;
+    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;
@@ -266,7 +238,7 @@ 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 "WAIT_SOURCE_CONFIRMATIONS" | "WAIT_DESTINATION_TRANSACTION" | "BRIDGE_NOT_AVAILABLE" | "CHAIN_NOT_AVAILABLE" | "NOT_PROCESSABLE_REFUND_NEEDED" | "REFUND_IN_PROGRESS" | "UNKNOWN_ERROR";
+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;
@@ -294,11 +266,15 @@ export interface ExtendedChain extends Chain {
 export interface ChainsResponse {
     chains: ExtendedChain[];
 }
+export interface ChainsRequest {
+    chainTypes?: ChainType[];
+}
 export interface ToolsRequest {
     chains?: ChainId[];
 }
 export type TokensRequest = {
     chains?: ChainId[];
+    chainTypes?: ChainType[];
 };
 export type TokensResponse = {
     tokens: {

package/dist/apiErrors.d.ts

@@ -0,0 +1,9 @@
+import { Action } from './step';
+export type ToolErrorType = 'NO_QUOTE';
+export interface ToolError {
+    errorType: ToolErrorType;
+    code: string;
+    action: Action;
+    tool: string;
+    message: string;
+}

package/dist/base.d.ts

@@ -0,0 +1,231 @@
+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/{chains/base.js → base.js}

@@ -1,3 +1,66 @@
+export var CoinKey;
+(function (CoinKey) {
+    CoinKey["ETH"] = "ETH";
+    CoinKey["MATIC"] = "MATIC";
+    CoinKey["BNB"] = "BNB";
+    CoinKey["DAI"] = "DAI";
+    CoinKey["FTM"] = "FTM";
+    CoinKey["OKT"] = "OKT";
+    CoinKey["AVAX"] = "AVAX";
+    CoinKey["HT"] = "HT";
+    CoinKey["ONE"] = "ONE";
+    CoinKey["FSN"] = "FSN";
+    CoinKey["MOVR"] = "MOVR";
+    CoinKey["EXP"] = "EXP";
+    CoinKey["TCH"] = "TCH";
+    CoinKey["UBQ"] = "UBQ";
+    CoinKey["META"] = "META";
+    CoinKey["DIODE"] = "DIODE";
+    CoinKey["CELO"] = "CELO";
+    CoinKey["FUSE"] = "FUSE";
+    CoinKey["TLOS"] = "TLOS";
+    CoinKey["CRO"] = "CRO";
+    CoinKey["SHIB"] = "SHIB";
+    CoinKey["L1"] = "L1";
+    CoinKey["RBTC"] = "RBTC";
+    CoinKey["TBG"] = "TBG";
+    CoinKey["VLX"] = "VLX";
+    CoinKey["GLMR"] = "GLMR";
+    CoinKey["METIS"] = "METIS";
+    CoinKey["SOL"] = "SOL";
+    CoinKey["EVM"] = "EVM";
+    // Stable coins
+    CoinKey["USDT"] = "USDT";
+    CoinKey["USDC"] = "USDC";
+    CoinKey["cbtUSDC"] = "cbtUSDC";
+    CoinKey["cbtUSDT"] = "cbtUSDT";
+    CoinKey["cbtWUSDT"] = "cbtWUSDT";
+    CoinKey["cbtWUSDC"] = "cbtWUSDC";
+    CoinKey["cbtCELR"] = "cbtCELR";
+    CoinKey["BUSD"] = "BUSD";
+    CoinKey["USDCe"] = "USDCe";
+    // Testnet
+    CoinKey["TEST"] = "TEST";
+    CoinKey["KAL"] = "KAL";
+    CoinKey["SDIODE"] = "SDIODE";
+    CoinKey["SPARK"] = "SPARK";
+    CoinKey["TRBTC"] = "TRBTC";
+    CoinKey["CXTT"] = "CXTT";
+    // stargate testnet tokens
+    CoinKey["sgMETIS"] = "sgMETIS";
+    CoinKey["sgWOO"] = "sgWOO";
+    CoinKey["sgUSDT"] = "sgUSDT";
+    CoinKey["sgBUSD"] = "sgBUSD";
+    CoinKey["sgUSDC"] = "sgUSDC";
+    // Other tokens
+    CoinKey["WBTC"] = "WBTC";
+    CoinKey["WETH"] = "WETH";
+    CoinKey["SUSHI"] = "SUSHI";
+    CoinKey["DODO"] = "DODO";
+    CoinKey["MCB"] = "MCB";
+    CoinKey["CELR"] = "CELR";
+    CoinKey["IF"] = "IF";
+})(CoinKey || (CoinKey = {}));
 export var ChainKey;
 (function (ChainKey) {
     ChainKey["ETH"] = "eth";
@@ -39,6 +102,7 @@ export var ChainKey;
     ChainKey["ERA"] = "era";
     ChainKey["PZE"] = "pze";
     ChainKey["LNA"] = "lna";
+    ChainKey["BAS"] = "bas";
     // Testnets
     ChainKey["GOR"] = "gor";
     ChainKey["METT"] = "mett";
@@ -102,6 +166,7 @@ export var ChainId;
     ChainId[ChainId["ERA"] = 324] = "ERA";
     ChainId[ChainId["PZE"] = 1101] = "PZE";
     ChainId[ChainId["LNA"] = 59144] = "LNA";
+    ChainId[ChainId["BAS"] = 8453] = "BAS";
     // Testnets
     ChainId[ChainId["GOR"] = 5] = "GOR";
     ChainId[ChainId["METT"] = 12] = "METT";

package/dist/bridges.d.ts

@@ -1,6 +1,23 @@
-import { BaseToken } from './tokens/token';
+/**
+ * @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: string;
+    key: BridgeTool;
     name: string;
     logoURI: string;
     bridgeUrl?: string;
@@ -11,18 +28,7 @@ export interface Bridge {
     analyticsUrl?: string;
 }
 /**
- * Should not be accessed via the types package anymore
  * @deprecated
+ * These values are now obtainable from the LI.FI API
  */
-export interface BridgeDefinition {
-    tool: string;
-    fromChainId: number;
-    fromToken: BaseToken;
-    toChainId: number;
-    toToken: BaseToken;
-    maximumTransfer: string;
-    minimumTransfer: string;
-    swapFeeRate: string;
-    swapFeeMinimum: string;
-    swapFeeMaximum: string;
-}
+export declare const supportedBridges: Array<Bridge>;