@sodax/types 2.0.0-rc.8 → 2.0.0

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.
Files changed (50) hide show
  1. package/dist/backend/backendApiV1.d.ts +28 -0
  2. package/dist/backend/backendApiV2.d.ts +678 -0
  3. package/dist/backend/backendApiV2.js +38 -0
  4. package/dist/backend/index.d.ts +2 -1
  5. package/dist/backend/index.js +2 -1
  6. package/dist/bitcoin/bitcoin.d.ts +18 -0
  7. package/dist/bitcoin/bitcoin.js +13 -0
  8. package/dist/chains/chain-keys.d.ts +3 -2
  9. package/dist/chains/chain-keys.js +1 -0
  10. package/dist/chains/chains.d.ts +475 -16
  11. package/dist/chains/chains.js +76 -4
  12. package/dist/chains/tokens.d.ts +676 -12
  13. package/dist/chains/tokens.js +317 -5
  14. package/dist/common/common.d.ts +15 -7
  15. package/dist/common/constants.d.ts +19 -1
  16. package/dist/dex/dex.d.ts +4 -1
  17. package/dist/hooks/hooks.d.ts +42 -0
  18. package/dist/hooks/hooks.js +44 -0
  19. package/dist/hooks/index.d.ts +1 -0
  20. package/dist/hooks/index.js +1 -0
  21. package/dist/index.d.ts +3 -1
  22. package/dist/index.js +3 -1
  23. package/dist/injective/injective.d.ts +4 -0
  24. package/dist/leverageYield/index.d.ts +1 -0
  25. package/dist/leverageYield/index.js +1 -0
  26. package/dist/leverageYield/leverageYield.d.ts +152 -0
  27. package/dist/leverageYield/leverageYield.js +51 -0
  28. package/dist/moneyMarket/moneyMarket.d.ts +304 -6
  29. package/dist/moneyMarket/moneyMarket.js +15 -0
  30. package/dist/near/near.d.ts +5 -1
  31. package/dist/shared/analytics.d.ts +119 -0
  32. package/dist/shared/analytics.js +1 -0
  33. package/dist/shared/features.d.ts +9 -0
  34. package/dist/shared/features.js +1 -0
  35. package/dist/shared/index.d.ts +3 -0
  36. package/dist/shared/index.js +3 -0
  37. package/dist/shared/logger.d.ts +27 -0
  38. package/dist/shared/logger.js +1 -0
  39. package/dist/shared/shared.d.ts +21 -0
  40. package/dist/sodax-config/sodax-config.d.ts +848 -74
  41. package/dist/sodax-config/sodax-config.js +3 -4
  42. package/dist/solana/solana.d.ts +2 -0
  43. package/dist/stacks/stacks.d.ts +2 -0
  44. package/dist/stellar/stellar.d.ts +4 -0
  45. package/dist/sui/sui.d.ts +3 -2
  46. package/dist/swap/swap.d.ts +500 -92
  47. package/dist/swap/swap.js +79 -12
  48. package/package.json +2 -2
  49. package/dist/backend/backendApi.d.ts +0 -74
  50. /package/dist/backend/{backendApi.js → backendApiV1.js} +0 -0
package/dist/swap/swap.js CHANGED
@@ -1,4 +1,4 @@
1
- import { SodaTokens } from '../chains/tokens.js';
1
+ import { SodaTokens, LsodaTokens } from '../chains/tokens.js';
2
2
  import { spokeChainConfig, ChainKeys } from '../chains/chains.js';
3
3
  export const swapSupportedTokens = {
4
4
  [ChainKeys.SONIC_MAINNET]: [
@@ -8,7 +8,10 @@ export const swapSupportedTokens = {
8
8
  spokeChainConfig[ChainKeys.SONIC_MAINNET].supportedTokens.USDT,
9
9
  spokeChainConfig[ChainKeys.SONIC_MAINNET].supportedTokens.wS,
10
10
  spokeChainConfig[ChainKeys.SONIC_MAINNET].supportedTokens.SODA,
11
- ...Object.values(SodaTokens),
11
+ // spokeChainConfig[ChainKeys.SONIC_MAINNET].supportedTokens.USSD, // NOTE: Not Implemented
12
+ // sodaSUSDS is staging-only; sodaUSDS / sodaUSSD are parked until the solver fills them
13
+ ...Object.values(SodaTokens).filter(t => t !== SodaTokens.sodaSUSDS && t !== SodaTokens.sodaUSDS && t !== SodaTokens.sodaUSSD),
14
+ ...Object.values(LsodaTokens),
12
15
  ],
13
16
  [ChainKeys.AVALANCHE_MAINNET]: [
14
17
  spokeChainConfig[ChainKeys.AVALANCHE_MAINNET].supportedTokens.AVAX,
@@ -27,7 +30,6 @@ export const swapSupportedTokens = {
27
30
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.tBTC,
28
31
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.USDC,
29
32
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.USDT,
30
- spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.SODA,
31
33
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.ARB,
32
34
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.AAVE,
33
35
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.LINK,
@@ -35,21 +37,22 @@ export const swapSupportedTokens = {
35
37
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.CRV,
36
38
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.PENDLE,
37
39
  spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.rETH,
40
+ spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.SODA,
41
+ // spokeChainConfig[ChainKeys.ARBITRUM_MAINNET].supportedTokens.USDS, // NOTE: Not Implemented
38
42
  ],
39
43
  [ChainKeys.BASE_MAINNET]: [
40
44
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.ETH,
41
- spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.bnUSD,
42
45
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.weETH,
43
46
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.USDC,
44
47
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.wstETH,
45
48
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.cbBTC,
46
- spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.SODA,
47
49
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.VIRTUAL,
48
50
  spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.cbETH,
51
+ spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.SODA,
52
+ // spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.USDS, // NOTE: Not Implemented
49
53
  ],
50
54
  [ChainKeys.OPTIMISM_MAINNET]: [
51
55
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.ETH,
52
- spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.bnUSD,
53
56
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.USDC,
54
57
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.wstETH,
55
58
  // spokeChainConfig[OPTIMISM_MAINNET_CHAIN_ID].supportedTokens.weETH, // NOTE: Not Implemented
@@ -57,6 +60,7 @@ export const swapSupportedTokens = {
57
60
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.SODA,
58
61
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.OP,
59
62
  spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.WBTC,
63
+ spokeChainConfig[ChainKeys.OPTIMISM_MAINNET].supportedTokens.bnUSD,
60
64
  ],
61
65
  [ChainKeys.POLYGON_MAINNET]: [
62
66
  spokeChainConfig[ChainKeys.POLYGON_MAINNET].supportedTokens.POL,
@@ -112,7 +116,6 @@ export const swapSupportedTokens = {
112
116
  spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens['SUI.LL'],
113
117
  spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens['S.LL'],
114
118
  spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens['POL.LL'],
115
- spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens['HYPE.LL'],
116
119
  spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens.LL,
117
120
  ],
118
121
  [ChainKeys.SOLANA_MAINNET]: [
@@ -129,6 +132,14 @@ export const swapSupportedTokens = {
129
132
  spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.PYTH,
130
133
  spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.JTO,
131
134
  spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.WBTC,
135
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.CRCLx,
136
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.TSLAx,
137
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.SPYx,
138
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.NVDAx,
139
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.QQQx,
140
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.MSTRx,
141
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.COINx,
142
+ spokeChainConfig[ChainKeys.SOLANA_MAINNET].supportedTokens.GOOGLx,
132
143
  ],
133
144
  [ChainKeys.ICON_MAINNET]: [
134
145
  spokeChainConfig[ChainKeys.ICON_MAINNET].supportedTokens.ICX,
@@ -142,6 +153,9 @@ export const swapSupportedTokens = {
142
153
  spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.bnUSD, // NOTE: Not Implemented
143
154
  spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.USDC,
144
155
  spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.SODA,
156
+ spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.sodaETH,
157
+ spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.sodaBTC,
158
+ spokeChainConfig[ChainKeys.STELLAR_MAINNET].supportedTokens.sodaBNB,
145
159
  ],
146
160
  [ChainKeys.SUI_MAINNET]: [
147
161
  spokeChainConfig[ChainKeys.SUI_MAINNET].supportedTokens.SUI,
@@ -162,7 +176,6 @@ export const swapSupportedTokens = {
162
176
  spokeChainConfig[ChainKeys.INJECTIVE_MAINNET].supportedTokens.INJ,
163
177
  spokeChainConfig[ChainKeys.INJECTIVE_MAINNET].supportedTokens.bnUSD,
164
178
  spokeChainConfig[ChainKeys.INJECTIVE_MAINNET].supportedTokens.USDC,
165
- // spokeChainConfig[ChainKeys.INJECTIVE_MAINNET].supportedTokens.SODA, // NOTE: not in solver wiki
166
179
  ],
167
180
  [ChainKeys.NEAR_MAINNET]: [
168
181
  spokeChainConfig[ChainKeys.NEAR_MAINNET].supportedTokens.NEAR,
@@ -198,6 +211,7 @@ export const swapSupportedTokens = {
198
211
  spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.DAI,
199
212
  spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.cbBTC,
200
213
  spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.rETH,
214
+ // spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.USDS, // NOTE: Not Implemented
201
215
  ],
202
216
  [ChainKeys.REDBELLY_MAINNET]: [
203
217
  spokeChainConfig[ChainKeys.REDBELLY_MAINNET].supportedTokens.RBNT,
@@ -229,12 +243,65 @@ export const swapSupportedTokens = {
229
243
  spokeChainConfig[ChainKeys.STACKS_MAINNET].supportedTokens.sBTC,
230
244
  spokeChainConfig[ChainKeys.STACKS_MAINNET].supportedTokens.USDC,
231
245
  ],
246
+ // Hedera is currently staging-only — see stagingSwapSupportedTokens
247
+ [ChainKeys.HEDERA_MAINNET]: [],
248
+ };
249
+ // Tokens supported ONLY in the staging solver environment.
250
+ // The staging solver supports every production token PLUS these — use
251
+ // `getStagingSolverTokens` for the full staging set. The two lists are disjoint per chain;
252
+ // a token lives in exactly one of them. It is upon the user to provide a token valid for
253
+ // their target environment — validation accepts either (see `isSwapSupportedToken`).
254
+ // Derived from the production solver oracle (tokens absent there).
255
+ export const stagingSwapSupportedTokens = {
256
+ [ChainKeys.SONIC_MAINNET]: [SodaTokens.sodaSUSDS],
257
+ [ChainKeys.AVALANCHE_MAINNET]: [],
258
+ [ChainKeys.ARBITRUM_MAINNET]: [],
259
+ [ChainKeys.BASE_MAINNET]: [
260
+ spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.bnUSD,
261
+ spokeChainConfig[ChainKeys.BASE_MAINNET].supportedTokens.AERO,
262
+ ],
263
+ [ChainKeys.OPTIMISM_MAINNET]: [],
264
+ [ChainKeys.POLYGON_MAINNET]: [
265
+ spokeChainConfig[ChainKeys.POLYGON_MAINNET].supportedTokens.USDT,
266
+ spokeChainConfig[ChainKeys.POLYGON_MAINNET].supportedTokens.wstETH,
267
+ ],
268
+ [ChainKeys.BSC_MAINNET]: [],
269
+ [ChainKeys.HYPEREVM_MAINNET]: [],
270
+ [ChainKeys.LIGHTLINK_MAINNET]: [
271
+ spokeChainConfig[ChainKeys.LIGHTLINK_MAINNET].supportedTokens['HYPE.LL'],
272
+ ],
273
+ [ChainKeys.SOLANA_MAINNET]: [],
274
+ [ChainKeys.ICON_MAINNET]: [],
275
+ [ChainKeys.STELLAR_MAINNET]: [],
276
+ [ChainKeys.SUI_MAINNET]: [spokeChainConfig[ChainKeys.SUI_MAINNET].supportedTokens.USDT],
277
+ [ChainKeys.INJECTIVE_MAINNET]: [],
278
+ [ChainKeys.NEAR_MAINNET]: [],
279
+ [ChainKeys.BITCOIN_MAINNET]: [],
280
+ [ChainKeys.ETHEREUM_MAINNET]: [
281
+ spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.wstETH,
282
+ spokeChainConfig[ChainKeys.ETHEREUM_MAINNET].supportedTokens.weETH,
283
+ ],
284
+ [ChainKeys.REDBELLY_MAINNET]: [],
285
+ [ChainKeys.KAIA_MAINNET]: [],
286
+ [ChainKeys.STACKS_MAINNET]: [],
287
+ [ChainKeys.HEDERA_MAINNET]: [
288
+ spokeChainConfig[ChainKeys.HEDERA_MAINNET].supportedTokens.HBAR,
289
+ spokeChainConfig[ChainKeys.HEDERA_MAINNET].supportedTokens.bnUSD,
290
+ spokeChainConfig[ChainKeys.HEDERA_MAINNET].supportedTokens.USDC,
291
+ spokeChainConfig[ChainKeys.HEDERA_MAINNET].supportedTokens.SODA,
292
+ ],
232
293
  };
233
294
  export const swapsConfig = {
234
- partnerFee: undefined,
235
295
  supportedTokens: swapSupportedTokens,
236
296
  };
237
- // get supported spoke chain tokens for solver
297
+ // get production supported spoke chain tokens for solver
238
298
  export const getSupportedSolverTokens = (chainId) => swapSupportedTokens[chainId];
239
- // check if token address for given spoke chain id is supported
240
- export const isSwapSupportedToken = (chainId, token) => swapSupportedTokens[chainId].some(t => t.address.toLowerCase() === token.toLowerCase());
299
+ // get supported spoke chain tokens for the staging solver — staging supports every
300
+ // production token plus the staging-only ones
301
+ export const getStagingSolverTokens = (chainId) => [
302
+ ...swapSupportedTokens[chainId],
303
+ ...stagingSwapSupportedTokens[chainId],
304
+ ];
305
+ // check if token address for given spoke chain id is supported in either the production or
306
+ // staging solver environment — the caller is responsible for targeting the correct environment.
307
+ export const isSwapSupportedToken = (chainId, token) => [...swapSupportedTokens[chainId], ...stagingSwapSupportedTokens[chainId]].some(t => t.address.toLowerCase() === token.toLowerCase());
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
7
- "version": "2.0.0-rc.8",
7
+ "version": "2.0.0",
8
8
  "description": "Sodax Common Types",
9
9
  "main": "dist/index.js",
10
10
  "homepage": "https://github.com/icon-project/sodax-sdks/tree/main/packages/types",
@@ -50,7 +50,7 @@
50
50
  "knip": "5.30.5",
51
51
  "madge": "8.0.0",
52
52
  "typescript": "5.5.4",
53
- "vitest": "3.2.4"
53
+ "vitest": "3.2.6"
54
54
  },
55
55
  "keywords": [
56
56
  "sodax",
@@ -1,74 +0,0 @@
1
- import type { SpokeChainKey, IntentRelayChainIdMap } from '../chains/chains.js';
2
- import type { XToken } from '../chains/tokens.js';
3
- import type { Result, SpokeChainConfigMap } from '../common/common.js';
4
- import type { Address } from '../shared/shared.js';
5
- import type { SodaxConfig } from '../sodax-config/sodax-config.js';
6
- export type GetChainsApiResponse = readonly SpokeChainKey[];
7
- export type GetSwapTokensApiResponse = Record<SpokeChainKey, readonly XToken[]>;
8
- export type GetSwapTokensByChainIdApiResponse = readonly XToken[];
9
- export type GetMoneyMarketTokensApiResponse = Record<SpokeChainKey, readonly XToken[]>;
10
- export type GetMoneyMarketTokensByChainIdApiResponse = readonly XToken[];
11
- export type GetRelayChainIdMapApiResponse = IntentRelayChainIdMap;
12
- export type GetSpokeChainConfigApiResponse = SpokeChainConfigMap;
13
- export type GetMoneyMarketReserveAssetsApiResponse = readonly Address[];
14
- export type GetAllConfigApiResponse = {
15
- version?: number;
16
- config: SodaxConfig;
17
- };
18
- export interface IConfigApi {
19
- getChains(): Promise<Result<GetChainsApiResponse>>;
20
- getSwapTokens(): Promise<Result<GetSwapTokensApiResponse>>;
21
- getSwapTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetSwapTokensByChainIdApiResponse>>;
22
- getMoneyMarketTokens(): Promise<Result<GetMoneyMarketTokensApiResponse>>;
23
- getMoneyMarketTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetMoneyMarketTokensByChainIdApiResponse>>;
24
- }
25
- export interface SwapIntentData {
26
- intentId: string;
27
- creator: string;
28
- inputToken: string;
29
- outputToken: string;
30
- inputAmount: string;
31
- minOutputAmount: string;
32
- deadline: string;
33
- allowPartialFill: boolean;
34
- srcChain: number;
35
- dstChain: number;
36
- srcAddress: string;
37
- dstAddress: string;
38
- solver: string;
39
- data: string;
40
- }
41
- export interface SubmitSwapTxRequest {
42
- txHash: string;
43
- srcChainKey: string;
44
- walletAddress: string;
45
- intent: SwapIntentData;
46
- relayData: string;
47
- }
48
- export interface SubmitSwapTxResponse {
49
- success: boolean;
50
- message: string;
51
- }
52
- export interface GetSubmitSwapTxStatusParams {
53
- txHash: string;
54
- srcChainKey?: string;
55
- }
56
- export interface SubmitSwapTxStatusResult {
57
- dstIntentTxHash: string;
58
- packetData?: Record<string, unknown>;
59
- intent_hash?: string;
60
- }
61
- export type SubmitSwapTxStatus = 'pending' | 'verifying' | 'verified' | 'relaying' | 'relayed' | 'posting_execution' | 'executed' | 'failed';
62
- export interface SubmitSwapTxStatusData {
63
- txHash: string;
64
- srcChainKey: string;
65
- status: SubmitSwapTxStatus;
66
- failedAtStep?: string;
67
- failureReason?: string;
68
- failedAttempts: number;
69
- result?: SubmitSwapTxStatusResult;
70
- }
71
- export interface SubmitSwapTxStatusResponse {
72
- success: boolean;
73
- data: SubmitSwapTxStatusData;
74
- }
File without changes