@swapkit/types 1.0.0-rc.4 → 1.0.0-rc.41

package/dist/index.d.ts

@@ -1,40 +1,15 @@
 /// <reference types="node" />
 
-import type { FixedNumber } from 'ethers';
-
-export declare type AddChainWalletParams = {
-    chain: Chain;
-    wallet: ChainWallet;
-    walletMethods: any;
+export declare type AddChainWalletParams<T extends Chain> = {
+    address: string;
+    balance: any[];
+    walletType: WalletOption;
+    chain: T;
+    [key: string]: any;
 };
 
 export declare const AGG_SWAP: QuoteMode[];
 
-export declare class ApiError extends Error {
-    readonly status: number;
-    readonly revision: string;
-    readonly type?: ERROR_TYPE;
-    readonly module: ERROR_MODULE;
-    readonly code: ERROR_CODE;
-    readonly message: string;
-    readonly display: string;
-    readonly stack?: string;
-    readonly options: ApiErrorOptions;
-    readonly displayMessageParams?: string[];
-    constructor({ status, revision, module, code, message, type, options: { shouldLog, shouldThrow, shouldTrace }, displayMessageParams, }: ErrorInfo);
-    static fromErrorInfo(errorInfo: ErrorInfo): ApiError;
-    toErrorInfo(): ErrorInfo;
-    get identifier(): string;
-    get displayMessage(): string;
-    handle(): ErrorInfo;
-}
-
-export declare type ApiErrorOptions = {
-    shouldLog?: boolean;
-    shouldTrace?: boolean;
-    shouldThrow?: boolean;
-};
-
 declare type ApisType = {
     [key in UTXOChain]?: string | any;
 } & {
@@ -50,7 +25,7 @@ export declare enum ApiUrl {
     MayanodeStagenet = "https://stagenet.mayanode.mayachain.info",
     ThornodeMainnet = "https://thornode.thorswap.net",
     ThornodeStagenet = "https://stagenet-thornode.ninerealms.com",
-    ThorswapApi = "https://api.thorswap.finance",
+    ThorswapApi = "https://api.thorswap.net",
     ThorswapStatic = "https://static.thorswap.net"
 }
 
@@ -70,14 +45,17 @@ export declare enum BaseDecimal {
     BTC = 8,
     DASH = 8,
     DOGE = 8,
+    DOT = 10,
     ETH = 18,
+    FLIP = 18,
     GAIA = 6,
     KUJI = 6,
     LTC = 8,
     MATIC = 18,
     MAYA = 10,
     OP = 18,
-    THOR = 8
+    THOR = 8,
+    ZEC = 8
 }
 
 export declare enum Chain {
@@ -88,12 +66,15 @@ export declare enum Chain {
     Bitcoin = "BTC",
     BitcoinCash = "BCH",
     Cosmos = "GAIA",
+    Dash = "DASH",
     Dogecoin = "DOGE",
     Ethereum = "ETH",
     Kujira = "KUJI",
     Litecoin = "LTC",
     Maya = "MAYA",
     Optimism = "OP",
+    Polkadot = "DOT",
+    Chainflip = "FLIP",
     Polygon = "MATIC",
     THORChain = "THOR"
 }
@@ -108,7 +89,9 @@ export declare enum ChainId {
     BinanceSmartChainHex = "0x38",
     Bitcoin = "bitcoin",
     BitcoinCash = "bitcoincash",
+    Chainflip = "chainflip",
     Cosmos = "cosmoshub-4",
+    Dash = "dash",
     Dogecoin = "dogecoin",
     Kujira = "kaiyo-1",
     Ethereum = "1",
@@ -118,6 +101,7 @@ export declare enum ChainId {
     MayaStagenet = "mayachain-stagenet-v1",
     Optimism = "10",
     OptimismHex = "0xa",
+    Polkadot = "polkadot",
     Polygon = "137",
     PolygonHex = "0x89",
     THORChain = "thorchain-mainnet-v1",
@@ -134,12 +118,15 @@ export declare const ChainToChainId: {
     BTC: ChainId;
     BCH: ChainId;
     GAIA: ChainId;
+    DASH: ChainId;
     DOGE: ChainId;
     ETH: ChainId;
     KUJI: ChainId;
     LTC: ChainId;
     MAYA: ChainId;
     OP: ChainId;
+    DOT: ChainId;
+    FLIP: ChainId;
     MATIC: ChainId;
     THOR: ChainId;
 };
@@ -154,12 +141,15 @@ export declare const ChainToHexChainId: {
     BTC: ChainId;
     BCH: ChainId;
     GAIA: ChainId;
+    DASH: ChainId;
     DOGE: ChainId;
     ETH: ChainId;
     KUJI: ChainId;
     LTC: ChainId;
     MAYA: ChainId;
     OP: ChainId;
+    DOT: ChainId;
+    FLIP: ChainId;
     MATIC: ChainId;
     THOR: ChainId;
 };
@@ -172,24 +162,25 @@ export declare const ChainToRPC: {
     BTC: RPCUrl;
     BCH: RPCUrl;
     GAIA: RPCUrl;
+    DASH: RPCUrl;
     DOGE: RPCUrl;
     ETH: RPCUrl;
     KUJI: RPCUrl;
     LTC: RPCUrl;
     MAYA: RPCUrl;
     OP: RPCUrl;
+    DOT: RPCUrl;
+    FLIP: RPCUrl;
     MATIC: RPCUrl;
     THOR: RPCUrl;
 };
 
-declare type ChainWallet = {
-    address: string;
-    balance: any[];
-    walletType: WalletOption;
-};
-
 export declare type ConnectConfig = {
     stagenet?: boolean;
+    /**
+     * @required
+     */
+    thorswapApiKey?: string;
     /**
      * @required for AVAX & BSC
      */
@@ -199,7 +190,11 @@ export declare type ConnectConfig = {
      */
     ethplorerApiKey?: string;
     /**
-     * @required for BTC, LTC, DOGE & BCH
+     * @required for BTC, BCH, LTC, DOGE
+     */
+    blockchairApiKey?: string;
+    /**
+     * @deprecated - use blockchairApiKey instead
      */
     utxoApiKey?: string;
     /**
@@ -213,12 +208,24 @@ export declare type ConnectConfig = {
         email: string;
         appUrl: string;
     };
+    /**
+     * @optional for KeepKey config
+     */
+    keepkeyConfig?: {
+        apiKey: string;
+        pairingInfo: {
+            name: string;
+            imageUrl: string;
+            basePath: string;
+            url: string;
+        };
+    };
 };
 
-declare type ConnectMethodNames = 'connectEVMWallet' | 'connectKeplr' | 'connectKeystore' | 'connectLedger' | 'connectOkx' | 'connectTrezor' | 'connectWalletconnect' | 'connectXDEFI';
+declare type ConnectMethodNames = "connectEVMWallet" | "connectKeplr" | "connectKeystore" | "connectKeepkey" | "connectLedger" | "connectOkx" | "connectTrezor" | "connectWalletconnect" | "connectXDEFI";
 
 export declare type ConnectWalletParams = {
-    addChain: (params: AddChainWalletParams) => void;
+    addChain: <T extends Chain>(params: AddChainWalletParams<T>) => void;
     config: ConnectConfig;
     rpcUrls: {
         [chain in Chain]?: string;
@@ -237,7 +244,13 @@ export declare enum ContractAddress {
 
 export declare type CosmosChain = Chain.Cosmos | Chain.THORChain | Chain.Binance | Chain.Maya | Chain.Kujira;
 
-export declare const CosmosChainList: CosmosChain[];
+/**
+ * @deprecated
+ * Use `CosmosChains` instead
+ */
+export declare const CosmosChainList: readonly [Chain.Cosmos, Chain.THORChain, Chain.Binance, Chain.Maya, Chain.Kujira];
+
+export declare const CosmosChains: readonly [Chain.Cosmos, Chain.THORChain, Chain.Binance, Chain.Maya, Chain.Kujira];
 
 export declare enum DerivationPath {
     ARB = "m/44'/60'/0'/0",
@@ -246,8 +259,11 @@ export declare enum DerivationPath {
     BNB = "m/44'/714'/0'/0",
     BSC = "m/44'/60'/0'/0",
     BTC = "m/84'/0'/0'/0",
+    DASH = "m/44'/5'/0'/0",
     DOGE = "m/44'/3'/0'/0",
+    DOT = "////",
     ETH = "m/44'/60'/0'/0",
+    FLIP = "////",
     GAIA = "m/44'/118'/0'/0",
     KUJI = "m/44'/118'/0'/0",
     LTC = "m/84'/2'/0'/0",
@@ -295,132 +311,15 @@ export declare const erc20ABI: ({
     anonymous?: undefined;
 })[];
 
-export declare enum ERROR_CODE {
-    INVALID_INPUT_PARAMETERS = "1000",
-    UNKNOWN_PROVIDERS = "1001",
-    CANNOT_FIND_INBOUND_ADDRESS = "1002",
-    NO_INBOUND_ADDRESSES = "1003",
-    CHAIN_HALTED_OR_UNSUPPORTED = "1004",
-    MISSING_INPUT_PARAMETER = "1005",
-    INVALID_TYPE_GENERIC = "1100",
-    INVALID_NUMBER_STRING = "1101",
-    INVALID_NUMBER = "1102",
-    INVALID_BOOLEAN = "1103",
-    INVALID_OBJECT = "1104",
-    INVALID_ARRAY = "1105",
-    SELL_AMOUNT_MUST_BE_POSITIVE_INTEGER = "2000",
-    SELL_BUY_ASSETS_ARE_THE_SAME = "2001",
-    MISSING_SOURCE_ADDRESS_FOR_SYNTH = "2002",
-    AFF_ADDRESS_AND_BPS_OR_NEITHER = "2003",
-    AFF_ADDRESS_TOO_LONG = "2004",
-    AFF_BPS_INTEGER_0_100 = "2005",
-    SOURCE_ADDRESS_INVALID_FOR_SELL_CHAIN = "2006",
-    DESTINATION_ADDRESS_INVALID_FOR_BUY_CHAIN = "2007",
-    PREFERRED_PROFVIDER_NOT_SUPPORTED = "2008",
-    DESTINATION_ADDRESS_SMART_CONTRACT = "2009",
-    BUY_AMOUNT_MUST_BE_POSITIVE_INTEGER = "2010",
-    SOURCE_ADDRESS_SMART_CONTRACT = "2011",
-    INVALID_PROVIDER = "2100",
-    MISSING_CROSS_CHAIN_PROVIDER = "2101",
-    MISSING_AVAX_PROVIDER = "2102",
-    MISSING_BSC_PROVIDER = "2103",
-    MISSING_ETH_PROVIDER = "2104",
-    INVALID_PROVIDER_FOR_SWAP_OUT = "2105",
-    MISSING_ARB_PROVIDER = "2106",
-    INVALID_CHAIN = "2200",
-    INVALID_ASSET = "2201",
-    INVALID_ASSET_IDENTIFIER = "2202",
-    UNSUPPORTED_CHAIN = "2204",
-    UNSUPPORTED_ASSET = "2203",
-    UNSUPPORTED_ASSET_FOR_SWAPOUT = "2205",
-    INVALID_SOURCE_ADDRESS = "2300",
-    INVALID_DESTINATION_ADDRESS = "2301",
-    THORNODE_QUOTE_GENERIC_ERROR = "3000",
-    NOT_ENOUGH_SYNTH_BALANCE = "3001",
-    SYNTH_MINTING_CAP_REACHED = "3002",
-    INVALID_QUOTE_MODE = "4000",
-    NO_QUOTES = "4001",
-    SERVICE_UNAVAILABLE_GENERIC = "5000",
-    MISSING_GAS_DATA_GENERIC = "5100",
-    MISSING_TOKEN_INFO_GENERIC = "5200",
-    CANT_FIND_TOKEN_LIST = "5201",
-    NO_PRICE = "5202",
-    PRICE_IS_STALE = "5203",
-    ADDRESS_NOT_WHITELISTED = "6000",
-    ADDRESS_ALREADY_CLAIMED = "6001",
-    TEMPORARY_ERROR = "9999"
-}
-
-export declare enum ERROR_MODULE {
-    HEALTH_CONTROLLER = "1000",
-    LIQUIDITY_CONTROLLER = "1001",
-    PROVIDER_CONTROLLER = "1002",
-    QUOTE_CONTROLLER = "1003",
-    SWAP_CONTROLLER = "1004",
-    UTIL_CONTROLLER = "1005",
-    AIRDROP_CONTROLLER = "1006",
-    PROVIDER = "2000",
-    ASSET = "2001",
-    TOKEN_LIST = "2002",
-    QUOTE = "2100",
-    QUOTE_TXN_DETAILS = "2101",
-    THORCHAIN_PROVIDER = "3000",
-    UNISWAPV2_ETH_PROVIDER = "3001",
-    UNISWAPV3_ETH_PROVIDER = "3002",
-    SUSHISWAP_ETH_PROVIDER = "3003",
-    PANCAKESWAP_BSC_PROVIDER = "3004",
-    PANCAKESWAP_ETH_PROVIDER = "3005",
-    ONEINCH_ETH_PROVIDER = "3006",
-    ONEINCH_BSC_PROVIDER = "3007",
-    ONEINCH_AVAX_PROVIDER = "3008",
-    ZEROX_ETH_PROVIDER = "3009",
-    WOOFI_AVAX_PROVIDER = "3010",
-    PANGOLIN_AVAX_PROVIDER = "3011",
-    TRADERJOE_AVAX_PROVIDER = "3012",
-    KYBER_ETH_PROVIDER = "3013",
-    KYBER_AVAX_PROVIDER = "3014",
-    WOOFI_BSC_PROVIDER = "3015",
-    STARGATE_PROVIDER = "3016",
-    PROVIDER_UTIL = "4000",
-    TXN_DETAILS = "5000",
-    AIRDROP_UTIL = "6000"
-}
-
-export declare enum ERROR_TYPE {
-    VALIDATION_ERROR = "VALIDATION_ERROR",
-    REQUEST_PARAMETER_ERROR = "REQUEST_PARAMETER_ERROR",
-    RESPONSE_PARSING_ERROR = "RESPONSE_PARSING_ERROR",
-    UNSUPPORTED = "UNSUPPORTED",
-    NOT_IMPLEMENTED = "NOT_IMPLEMENTED",
-    INCOMPATIBLE_ASSETS_OPERATIONS = "INCOMPATIBLE_ASSETS_OPERATIONS",
-    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
-    DOWN_FOR_MAINTENANCE = "DOWN_FOR_MAINTENANCE",
-    MISSING_INBOUND_INFO = "MISSING_INBOUND_INFO",
-    QUOTE_FETCHING_ERROR = "QUOTE_FETCHING_ERROR",
-    AIRDROP_ERROR = "AIRDROP_ERROR",
-    UNHANDLED_ERROR = "UNHANDLED_ERROR"
-}
-
-export declare enum ErrorCode {
-    NoError = 36864
-}
-
-export declare type ErrorInfo = {
-    status: number;
-    revision: string;
-    type?: ERROR_TYPE;
-    module: ERROR_MODULE;
-    code: ERROR_CODE;
-    message?: string | undefined;
-    stack?: string;
-    identifier?: string;
-    options?: ApiErrorOptions;
-    displayMessageParams?: string[];
-};
-
 export declare type EVMChain = Chain.Ethereum | Chain.Avalanche | Chain.BinanceSmartChain | Chain.Arbitrum | Chain.Optimism | Chain.Polygon;
 
-export declare const EVMChainList: EVMChain[];
+/**
+ * @deprecated
+ * Use `EVMChains` instead
+ */
+export declare const EVMChainList: readonly [Chain.Ethereum, Chain.Avalanche, Chain.BinanceSmartChain, Chain.Arbitrum, Chain.Optimism, Chain.Polygon];
+
+export declare const EVMChains: readonly [Chain.Ethereum, Chain.Avalanche, Chain.BinanceSmartChain, Chain.Arbitrum, Chain.Optimism, Chain.Polygon];
 
 export declare type EVMTxBaseParams<T = bigint> = {
     to?: string;
@@ -432,9 +331,9 @@ export declare type EVMTxBaseParams<T = bigint> = {
     chainId?: T;
 };
 
-export declare type EVMWalletOptions = WalletOption.BRAVE | WalletOption.METAMASK | WalletOption.TRUSTWALLET_WEB | WalletOption.COINBASE_WEB;
+export declare type EVMWalletOptions = WalletOption.BRAVE | WalletOption.OKX_MOBILE | WalletOption.METAMASK | WalletOption.TRUSTWALLET_WEB | WalletOption.COINBASE_WEB;
 
-export declare type ExtendParams<WalletConnectMethodNames = ''> = {
+export declare type ExtendParams<WalletConnectMethodNames = ""> = {
     excludedChains?: Chain[];
     config?: ConnectConfig;
     rpcUrls?: {
@@ -453,8 +352,6 @@ export declare enum FeeOption {
     Fastest = "fastest"
 }
 
-export declare type FixedNumberish = string | number | FixedNumber;
-
 export declare type GetAddressAndPubKeyResponse = {
     bech32_address: string;
     compressed_pk: any;
@@ -462,6 +359,12 @@ export declare type GetAddressAndPubKeyResponse = {
     return_code: number;
 };
 
+export declare enum LedgerErrorCode {
+    NoError = 36864,
+    LockedDevice = 21781,
+    TC_NotFound = 65535
+}
+
 export declare enum MemoType {
     BOND = "BOND",
     DEPOSIT = "+",
@@ -501,14 +404,17 @@ export declare enum RPCUrl {
     BinanceSmartChain = "https://bsc-dataseed.binance.org",
     Bitcoin = "https://node-router.thorswap.net/bitcoin",
     BitcoinCash = "https://node-router.thorswap.net/bitcoin-cash",
+    Chainflip = "wss://mainnet-archive.chainflip.io",
     Cosmos = "https://node-router.thorswap.net/cosmos/rpc",
-    Kujira = "https://rpc-kujira.synergynodes.com/",
+    Dash = "https://node-router.thorswap.net/dash",
     Dogecoin = "https://node-router.thorswap.net/dogecoin",
     Ethereum = "https://node-router.thorswap.net/ethereum",
+    Kujira = "https://rpc-kujira.synergynodes.com/",
     Litecoin = "https://node-router.thorswap.net/litecoin",
     Maya = "https://tendermint.mayachain.info",
     MayaStagenet = "https://stagenet.tendermint.mayachain.info",
     Optimism = "https://mainnet.optimism.io",
+    Polkadot = "wss://rpc.polkadot.io",
     Polygon = "https://polygon-rpc.com",
     THORChain = "https://rpc.thorswap.net",
     THORChainStagenet = "https://stagenet-rpc.ninerealms.com"
@@ -523,6 +429,10 @@ export declare type Signature = {
     signature: string;
 };
 
+export declare type SubstrateChain = Chain.Polkadot | Chain.Chainflip;
+
+export declare const SubstrateChains: Chain[];
+
 export declare const SWAP_IN: QuoteMode[];
 
 export declare const SWAP_OUT: QuoteMode[];
@@ -735,22 +645,38 @@ export declare const TCEthereumVaultAbi: ({
     anonymous?: undefined;
 })[];
 
-export declare type UTXOChain = Chain.Bitcoin | Chain.BitcoinCash | Chain.Dogecoin | Chain.Litecoin;
+/**
+ * @deprecated
+ * Use `TCSupportedChains` instead
+ */
+export declare const TCSupportedChainList: readonly [Chain.Avalanche, Chain.Binance, Chain.BinanceSmartChain, Chain.Bitcoin, Chain.BitcoinCash, Chain.Cosmos, Chain.Dogecoin, Chain.Ethereum, Chain.Litecoin, Chain.THORChain];
+
+export declare const TCSupportedChains: readonly [Chain.Avalanche, Chain.Binance, Chain.BinanceSmartChain, Chain.Bitcoin, Chain.BitcoinCash, Chain.Cosmos, Chain.Dogecoin, Chain.Ethereum, Chain.Litecoin, Chain.THORChain];
+
+export declare type UTXOChain = Chain.Bitcoin | Chain.BitcoinCash | Chain.Dash | Chain.Dogecoin | Chain.Litecoin;
+
+/**
+ * @deprecated
+ * Use `UTXOChains` instead
+ */
+export declare const UTXOChainList: readonly [Chain.Bitcoin, Chain.BitcoinCash, Chain.Dash, Chain.Dogecoin, Chain.Litecoin];
 
-export declare const UTXOChainList: Chain[];
+export declare const UTXOChains: readonly [Chain.Bitcoin, Chain.BitcoinCash, Chain.Dash, Chain.Dogecoin, Chain.Litecoin];
 
 export declare enum WalletOption {
-    'KEYSTORE' = "KEYSTORE",
-    'XDEFI' = "XDEFI",
-    'METAMASK' = "METAMASK",
-    'COINBASE_WEB' = "COINBASE_WEB",
-    'TREZOR' = "TREZOR",
-    'TRUSTWALLET_WEB' = "TRUSTWALLET_WEB",
-    'LEDGER' = "LEDGER",
-    'KEPLR' = "KEPLR",
-    'OKX' = "OKX",
-    'BRAVE' = "BRAVE",
-    'WALLETCONNECT' = "WALLETCONNECT"
+    KEYSTORE = "KEYSTORE",
+    KEEPKEY = "KEEPKEY",
+    XDEFI = "XDEFI",
+    METAMASK = "METAMASK",
+    COINBASE_WEB = "COINBASE_WEB",
+    TREZOR = "TREZOR",
+    TRUSTWALLET_WEB = "TRUSTWALLET_WEB",
+    LEDGER = "LEDGER",
+    KEPLR = "KEPLR",
+    OKX = "OKX",
+    OKX_MOBILE = "OKX_MOBILE",
+    BRAVE = "BRAVE",
+    WALLETCONNECT = "WALLETCONNECT"
 }
 
 export declare type WalletTxParams = {