@swapkit/types 1.0.0-rc.36 → 1.0.0-rc.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,38 +1,15 @@
1
1
  /// <reference types="node" />
2
2
 
3
- export declare type AddChainWalletParams = {
4
- chain: Chain;
5
- wallet: ChainWallet;
6
- walletMethods: any;
3
+ export declare type AddChainWalletParams<T extends Chain> = {
4
+ address: string;
5
+ balance: any[];
6
+ walletType: WalletOption;
7
+ chain: T;
8
+ [key: string]: any;
7
9
  };
8
10
 
9
11
  export declare const AGG_SWAP: QuoteMode[];
10
12
 
11
- export declare class ApiError extends Error {
12
- readonly status: number;
13
- readonly revision: string;
14
- readonly type?: ERROR_TYPE;
15
- readonly module: ERROR_MODULE;
16
- readonly code: ERROR_CODE;
17
- readonly message: string;
18
- readonly display: string;
19
- readonly stack?: string;
20
- readonly options: ApiErrorOptions;
21
- readonly displayMessageParams?: string[];
22
- constructor({ status, revision, module, code, message, type, options: { shouldLog, shouldThrow, shouldTrace }, displayMessageParams, }: ErrorInfo);
23
- static fromErrorInfo(errorInfo: ErrorInfo): ApiError;
24
- toErrorInfo(): ErrorInfo;
25
- get identifier(): string;
26
- get displayMessage(): string;
27
- handle(): ErrorInfo;
28
- }
29
-
30
- export declare type ApiErrorOptions = {
31
- shouldLog?: boolean;
32
- shouldTrace?: boolean;
33
- shouldThrow?: boolean;
34
- };
35
-
36
13
  declare type ApisType = {
37
14
  [key in UTXOChain]?: string | any;
38
15
  } & {
@@ -77,7 +54,8 @@ export declare enum BaseDecimal {
77
54
  MATIC = 18,
78
55
  MAYA = 10,
79
56
  OP = 18,
80
- THOR = 8
57
+ THOR = 8,
58
+ ZEC = 8
81
59
  }
82
60
 
83
61
  export declare enum Chain {
@@ -88,6 +66,7 @@ export declare enum Chain {
88
66
  Bitcoin = "BTC",
89
67
  BitcoinCash = "BCH",
90
68
  Cosmos = "GAIA",
69
+ Dash = "DASH",
91
70
  Dogecoin = "DOGE",
92
71
  Ethereum = "ETH",
93
72
  Kujira = "KUJI",
@@ -112,6 +91,7 @@ export declare enum ChainId {
112
91
  BitcoinCash = "bitcoincash",
113
92
  Chainflip = "chainflip",
114
93
  Cosmos = "cosmoshub-4",
94
+ Dash = "dash",
115
95
  Dogecoin = "dogecoin",
116
96
  Kujira = "kaiyo-1",
117
97
  Ethereum = "1",
@@ -138,6 +118,7 @@ export declare const ChainToChainId: {
138
118
  BTC: ChainId;
139
119
  BCH: ChainId;
140
120
  GAIA: ChainId;
121
+ DASH: ChainId;
141
122
  DOGE: ChainId;
142
123
  ETH: ChainId;
143
124
  KUJI: ChainId;
@@ -160,6 +141,7 @@ export declare const ChainToHexChainId: {
160
141
  BTC: ChainId;
161
142
  BCH: ChainId;
162
143
  GAIA: ChainId;
144
+ DASH: ChainId;
163
145
  DOGE: ChainId;
164
146
  ETH: ChainId;
165
147
  KUJI: ChainId;
@@ -180,6 +162,7 @@ export declare const ChainToRPC: {
180
162
  BTC: RPCUrl;
181
163
  BCH: RPCUrl;
182
164
  GAIA: RPCUrl;
165
+ DASH: RPCUrl;
183
166
  DOGE: RPCUrl;
184
167
  ETH: RPCUrl;
185
168
  KUJI: RPCUrl;
@@ -192,12 +175,6 @@ export declare const ChainToRPC: {
192
175
  THOR: RPCUrl;
193
176
  };
194
177
 
195
- declare type ChainWallet = {
196
- address: string;
197
- balance: any[];
198
- walletType: WalletOption;
199
- };
200
-
201
178
  export declare type ConnectConfig = {
202
179
  stagenet?: boolean;
203
180
  /**
@@ -245,10 +222,10 @@ export declare type ConnectConfig = {
245
222
  };
246
223
  };
247
224
 
248
- declare type ConnectMethodNames = 'connectEVMWallet' | 'connectKeplr' | 'connectKeystore' | 'connectKeepkey' | 'connectLedger' | 'connectOkx' | 'connectTrezor' | 'connectWalletconnect' | 'connectXDEFI';
225
+ declare type ConnectMethodNames = "connectEVMWallet" | "connectKeplr" | "connectKeystore" | "connectKeepkey" | "connectLedger" | "connectOkx" | "connectTrezor" | "connectWalletconnect" | "connectXDEFI";
249
226
 
250
227
  export declare type ConnectWalletParams = {
251
- addChain: (params: AddChainWalletParams) => void;
228
+ addChain: <T extends Chain>(params: AddChainWalletParams<T>) => void;
252
229
  config: ConnectConfig;
253
230
  rpcUrls: {
254
231
  [chain in Chain]?: string;
@@ -267,7 +244,13 @@ export declare enum ContractAddress {
267
244
 
268
245
  export declare type CosmosChain = Chain.Cosmos | Chain.THORChain | Chain.Binance | Chain.Maya | Chain.Kujira;
269
246
 
270
- export declare const CosmosChainList: CosmosChain[];
247
+ /**
248
+ * @deprecated
249
+ * Use `CosmosChains` instead
250
+ */
251
+ export declare const CosmosChainList: readonly [Chain.Cosmos, Chain.THORChain, Chain.Binance];
252
+
253
+ export declare const CosmosChains: readonly [Chain.Cosmos, Chain.THORChain, Chain.Binance];
271
254
 
272
255
  export declare enum DerivationPath {
273
256
  ARB = "m/44'/60'/0'/0",
@@ -276,6 +259,7 @@ export declare enum DerivationPath {
276
259
  BNB = "m/44'/714'/0'/0",
277
260
  BSC = "m/44'/60'/0'/0",
278
261
  BTC = "m/84'/0'/0'/0",
262
+ DASH = "m/44'/5'/0'/0",
279
263
  DOGE = "m/44'/3'/0'/0",
280
264
  DOT = "////",
281
265
  ETH = "m/44'/60'/0'/0",
@@ -327,129 +311,15 @@ export declare const erc20ABI: ({
327
311
  anonymous?: undefined;
328
312
  })[];
329
313
 
330
- export declare enum ERROR_CODE {
331
- INVALID_INPUT_PARAMETERS = "1000",
332
- UNKNOWN_PROVIDERS = "1001",
333
- CANNOT_FIND_INBOUND_ADDRESS = "1002",
334
- NO_INBOUND_ADDRESSES = "1003",
335
- CHAIN_HALTED_OR_UNSUPPORTED = "1004",
336
- MISSING_INPUT_PARAMETER = "1005",
337
- INVALID_TYPE_GENERIC = "1100",
338
- INVALID_NUMBER_STRING = "1101",
339
- INVALID_NUMBER = "1102",
340
- INVALID_BOOLEAN = "1103",
341
- INVALID_OBJECT = "1104",
342
- INVALID_ARRAY = "1105",
343
- SELL_AMOUNT_MUST_BE_POSITIVE_INTEGER = "2000",
344
- SELL_BUY_ASSETS_ARE_THE_SAME = "2001",
345
- MISSING_SOURCE_ADDRESS_FOR_SYNTH = "2002",
346
- AFF_ADDRESS_AND_BPS_OR_NEITHER = "2003",
347
- AFF_ADDRESS_TOO_LONG = "2004",
348
- AFF_BPS_INTEGER_MAX_500 = "2005",
349
- SOURCE_ADDRESS_INVALID_FOR_SELL_CHAIN = "2006",
350
- DESTINATION_ADDRESS_INVALID_FOR_BUY_CHAIN = "2007",
351
- PREFERRED_PROVIDER_NOT_SUPPORTED = "2008",
352
- DESTINATION_ADDRESS_SMART_CONTRACT = "2009",
353
- BUY_AMOUNT_MUST_BE_POSITIVE_INTEGER = "2010",
354
- SOURCE_ADDRESS_SMART_CONTRACT = "2011",
355
- SWAP_AMOUNT_TOO_LOW = "2012",
356
- INVALID_PROVIDER = "2100",
357
- MISSING_CROSS_CHAIN_PROVIDER = "2101",
358
- MISSING_AVAX_PROVIDER = "2102",
359
- MISSING_BSC_PROVIDER = "2103",
360
- MISSING_ETH_PROVIDER = "2104",
361
- INVALID_PROVIDER_FOR_SWAP_OUT = "2105",
362
- MISSING_ARB_PROVIDER = "2106",
363
- INVALID_CHAIN = "2200",
364
- INVALID_ASSET = "2201",
365
- INVALID_ASSET_IDENTIFIER = "2202",
366
- UNSUPPORTED_CHAIN = "2204",
367
- UNSUPPORTED_ASSET = "2203",
368
- UNSUPPORTED_ASSET_FOR_SWAPOUT = "2205",
369
- INVALID_SOURCE_ADDRESS = "2300",
370
- INVALID_DESTINATION_ADDRESS = "2301",
371
- THORNODE_QUOTE_GENERIC_ERROR = "3000",
372
- NOT_ENOUGH_SYNTH_BALANCE = "3001",
373
- SYNTH_MINTING_CAP_REACHED = "3002",
374
- INVALID_QUOTE_MODE = "4000",
375
- NO_QUOTES = "4001",
376
- SERVICE_UNAVAILABLE_GENERIC = "5000",
377
- MISSING_GAS_DATA_GENERIC = "5100",
378
- MISSING_TOKEN_INFO_GENERIC = "5200",
379
- CANT_FIND_TOKEN_LIST = "5201",
380
- NO_PRICE = "5202",
381
- PRICE_IS_STALE = "5203",
382
- ADDRESS_NOT_WHITELISTED = "6000",
383
- ADDRESS_ALREADY_CLAIMED = "6001",
384
- TEMPORARY_ERROR = "9999"
385
- }
386
-
387
- export declare enum ERROR_MODULE {
388
- HEALTH_CONTROLLER = "1000",
389
- LIQUIDITY_CONTROLLER = "1001",
390
- PROVIDER_CONTROLLER = "1002",
391
- QUOTE_CONTROLLER = "1003",
392
- SWAP_CONTROLLER = "1004",
393
- UTIL_CONTROLLER = "1005",
394
- AIRDROP_CONTROLLER = "1006",
395
- PROVIDER = "2000",
396
- ASSET = "2001",
397
- TOKEN_LIST = "2002",
398
- QUOTE = "2100",
399
- QUOTE_TXN_DETAILS = "2101",
400
- THORCHAIN_PROVIDER = "3000",
401
- UNISWAPV2_ETH_PROVIDER = "3001",
402
- UNISWAPV3_ETH_PROVIDER = "3002",
403
- SUSHISWAP_ETH_PROVIDER = "3003",
404
- PANCAKESWAP_BSC_PROVIDER = "3004",
405
- PANCAKESWAP_ETH_PROVIDER = "3005",
406
- ONEINCH_ETH_PROVIDER = "3006",
407
- ONEINCH_BSC_PROVIDER = "3007",
408
- ONEINCH_AVAX_PROVIDER = "3008",
409
- ZEROX_ETH_PROVIDER = "3009",
410
- WOOFI_AVAX_PROVIDER = "3010",
411
- PANGOLIN_AVAX_PROVIDER = "3011",
412
- TRADERJOE_AVAX_PROVIDER = "3012",
413
- KYBER_ETH_PROVIDER = "3013",
414
- KYBER_AVAX_PROVIDER = "3014",
415
- WOOFI_BSC_PROVIDER = "3015",
416
- STARGATE_PROVIDER = "3016",
417
- PROVIDER_UTIL = "4000",
418
- TXN_DETAILS = "5000",
419
- AIRDROP_UTIL = "6000"
420
- }
421
-
422
- export declare enum ERROR_TYPE {
423
- VALIDATION_ERROR = "VALIDATION_ERROR",
424
- REQUEST_PARAMETER_ERROR = "REQUEST_PARAMETER_ERROR",
425
- RESPONSE_PARSING_ERROR = "RESPONSE_PARSING_ERROR",
426
- UNSUPPORTED = "UNSUPPORTED",
427
- NOT_IMPLEMENTED = "NOT_IMPLEMENTED",
428
- INCOMPATIBLE_ASSETS_OPERATIONS = "INCOMPATIBLE_ASSETS_OPERATIONS",
429
- SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
430
- DOWN_FOR_MAINTENANCE = "DOWN_FOR_MAINTENANCE",
431
- MISSING_INBOUND_INFO = "MISSING_INBOUND_INFO",
432
- QUOTE_FETCHING_ERROR = "QUOTE_FETCHING_ERROR",
433
- AIRDROP_ERROR = "AIRDROP_ERROR",
434
- UNHANDLED_ERROR = "UNHANDLED_ERROR"
435
- }
436
-
437
- export declare type ErrorInfo = {
438
- status: number;
439
- revision: string;
440
- type?: ERROR_TYPE;
441
- module: ERROR_MODULE;
442
- code: ERROR_CODE;
443
- message?: string | undefined;
444
- stack?: string;
445
- identifier?: string;
446
- options?: ApiErrorOptions;
447
- displayMessageParams?: string[];
448
- };
449
-
450
314
  export declare type EVMChain = Chain.Ethereum | Chain.Avalanche | Chain.BinanceSmartChain | Chain.Arbitrum | Chain.Optimism | Chain.Polygon;
451
315
 
452
- export declare const EVMChainList: EVMChain[];
316
+ /**
317
+ * @deprecated
318
+ * Use `EVMChains` instead
319
+ */
320
+ export declare const EVMChainList: readonly [Chain.Ethereum, Chain.Avalanche, Chain.BinanceSmartChain, Chain.Arbitrum, Chain.Optimism, Chain.Polygon];
321
+
322
+ export declare const EVMChains: readonly [Chain.Ethereum, Chain.Avalanche, Chain.BinanceSmartChain, Chain.Arbitrum, Chain.Optimism, Chain.Polygon];
453
323
 
454
324
  export declare type EVMTxBaseParams<T = bigint> = {
455
325
  to?: string;
@@ -463,7 +333,7 @@ export declare type EVMTxBaseParams<T = bigint> = {
463
333
 
464
334
  export declare type EVMWalletOptions = WalletOption.BRAVE | WalletOption.OKX_MOBILE | WalletOption.METAMASK | WalletOption.TRUSTWALLET_WEB | WalletOption.COINBASE_WEB;
465
335
 
466
- export declare type ExtendParams<WalletConnectMethodNames = ''> = {
336
+ export declare type ExtendParams<WalletConnectMethodNames = ""> = {
467
337
  excludedChains?: Chain[];
468
338
  config?: ConnectConfig;
469
339
  rpcUrls?: {
@@ -536,9 +406,10 @@ export declare enum RPCUrl {
536
406
  BitcoinCash = "https://node-router.thorswap.net/bitcoin-cash",
537
407
  Chainflip = "wss://mainnet-archive.chainflip.io",
538
408
  Cosmos = "https://node-router.thorswap.net/cosmos/rpc",
539
- Kujira = "https://rpc-kujira.synergynodes.com/",
409
+ Dash = "https://node-router.thorswap.net/dash",
540
410
  Dogecoin = "https://node-router.thorswap.net/dogecoin",
541
411
  Ethereum = "https://node-router.thorswap.net/ethereum",
412
+ Kujira = "https://rpc-kujira.synergynodes.com/",
542
413
  Litecoin = "https://node-router.thorswap.net/litecoin",
543
414
  Maya = "https://tendermint.mayachain.info",
544
415
  MayaStagenet = "https://stagenet.tendermint.mayachain.info",
@@ -774,26 +645,38 @@ export declare const TCEthereumVaultAbi: ({
774
645
  anonymous?: undefined;
775
646
  })[];
776
647
 
777
- export declare const TCSupportedChainList: Chain[];
648
+ /**
649
+ * @deprecated
650
+ * Use `TCSupportedChains` instead
651
+ */
652
+ 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];
653
+
654
+ 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];
655
+
656
+ export declare type UTXOChain = Chain.Bitcoin | Chain.BitcoinCash | Chain.Dash | Chain.Dogecoin | Chain.Litecoin;
778
657
 
779
- export declare type UTXOChain = Chain.Bitcoin | Chain.BitcoinCash | Chain.Dogecoin | Chain.Litecoin;
658
+ /**
659
+ * @deprecated
660
+ * Use `UTXOChains` instead
661
+ */
662
+ export declare const UTXOChainList: readonly [Chain.Bitcoin, Chain.BitcoinCash, Chain.Dash, Chain.Dogecoin, Chain.Litecoin];
780
663
 
781
- export declare const UTXOChainList: UTXOChain[];
664
+ export declare const UTXOChains: readonly [Chain.Bitcoin, Chain.BitcoinCash, Chain.Dash, Chain.Dogecoin, Chain.Litecoin];
782
665
 
783
666
  export declare enum WalletOption {
784
- 'KEYSTORE' = "KEYSTORE",
785
- 'KEEPKEY' = "KEEPKEY",
786
- 'XDEFI' = "XDEFI",
787
- 'METAMASK' = "METAMASK",
788
- 'COINBASE_WEB' = "COINBASE_WEB",
789
- 'TREZOR' = "TREZOR",
790
- 'TRUSTWALLET_WEB' = "TRUSTWALLET_WEB",
791
- 'LEDGER' = "LEDGER",
792
- 'KEPLR' = "KEPLR",
793
- 'OKX' = "OKX",
794
- 'OKX_MOBILE' = "OKX_MOBILE",
795
- 'BRAVE' = "BRAVE",
796
- 'WALLETCONNECT' = "WALLETCONNECT"
667
+ KEYSTORE = "KEYSTORE",
668
+ KEEPKEY = "KEEPKEY",
669
+ XDEFI = "XDEFI",
670
+ METAMASK = "METAMASK",
671
+ COINBASE_WEB = "COINBASE_WEB",
672
+ TREZOR = "TREZOR",
673
+ TRUSTWALLET_WEB = "TRUSTWALLET_WEB",
674
+ LEDGER = "LEDGER",
675
+ KEPLR = "KEPLR",
676
+ OKX = "OKX",
677
+ OKX_MOBILE = "OKX_MOBILE",
678
+ BRAVE = "BRAVE",
679
+ WALLETCONNECT = "WALLETCONNECT"
797
680
  }
798
681
 
799
682
  export declare type WalletTxParams = {