@sodax/types 2.0.0-rc.2 → 2.0.0-rc.20

package/README.md

@@ -51,13 +51,15 @@ The package currently exposes only the root export (`@sodax/types`) and the DEX
 | --- | --- |
 | Shared primitives | `Address`, `Hex`, `Hash`, `Base64String`, `HttpUrl`, `TxPollingConfig` |
 | Common types and constants | `Result`, `PartnerFee`, `TxReturnType`, `apiConfig`, `solverConfig`, retry and timeout constants |
-| Chains and tokens | `ChainKeys`, `SpokeChainKey`, `ChainType`, `baseChainInfo`, `spokeChainConfig`, `supportedTokensByChain` |
+| Chains and tokens | `ChainKeys`, `SpokeChainKey`, `ChainType`, `baseChainInfo`, `spokeChainConfig` [^cfg], `supportedTokensByChain` |
 | Wallet providers | `WalletAddressProvider`, `ICoreWallet`, `IWalletProvider`, `GetWalletProviderType` |
 | Chain transaction types | `EvmRawTransaction`, `BitcoinRawTransaction`, `SolanaRawTransaction`, `StellarRawTransaction`, `SuiRawTransaction`, `IconRawTransaction`, `InjectiveRawTransaction`, `NearRawTransaction`, `StacksRawTransaction` |
 | Backend API contracts | `IConfigApi`, `GetAllConfigApiResponse`, `SubmitSwapTxRequest`, `SubmitSwapTxResponse`, `SubmitSwapTxStatusResponse` |
-| Product configuration | `sodaxConfig`, `bridgeConfig`, `swapsConfig`, `moneyMarketConfig`, `dexConfig`, `concentratedLiquidityConfig` |
+| Product configuration | `sodaxConfig` [^cfg], `bridgeConfig`, `swapsConfig`, `moneyMarketConfig`, `dexConfig`, `concentratedLiquidityConfig` |
 | Utilities | `DeepPartial`, `getChainType`, `getEvmChainKeyByChainId`, chain guard helpers, bnUSD token helpers |
 
+[^cfg]: `spokeChainConfig` and `sodaxConfig` (and the related `hubConfig`, etc.) are **packaged-default snapshots** frozen at SDK release time. They are safe to import at module scope, but **direct imports do NOT reflect overrides passed to `new Sodax(config)` or dynamic config loaded by `sodax.config.initialize()`** — those flow into the `ConfigService` only. Once a `Sodax` instance exists, prefer the instance-scope readers: `sodax.config.spokeChainConfig`, `sodax.config.getChainConfig(chainKey)`, `sodax.config.sodaxConfig`, `sodax.config.getHubChainConfig()`, etc. Mixing a static import with a custom-configured `Sodax` instance will silently fall back to defaults for any chain you customized.
+
 ## Wallet Providers
 
 All wallet providers extend the base wallet address contract:

package/dist/backend/backendApiV1.d.ts

@@ -0,0 +1,28 @@
+import type { SpokeChainKey, IntentRelayChainIdMap } from '../chains/chains.js';
+import type { XToken } from '../chains/tokens.js';
+import type { Result, SpokeChainConfigMap } from '../common/common.js';
+import type { Address } from '../shared/shared.js';
+export type GetChainsApiResponse = readonly SpokeChainKey[];
+export type GetSwapTokensApiResponse = Record<SpokeChainKey, readonly XToken[]>;
+export type GetSwapTokensByChainIdApiResponse = readonly XToken[];
+export type GetMoneyMarketTokensApiResponse = Record<SpokeChainKey, readonly XToken[]>;
+export type GetMoneyMarketTokensByChainIdApiResponse = readonly XToken[];
+export type GetRelayChainIdMapApiResponse = IntentRelayChainIdMap;
+export type GetSpokeChainConfigApiResponse = SpokeChainConfigMap;
+export type GetMoneyMarketReserveAssetsApiResponse = readonly Address[];
+export type GetAllConfigApiResponse = {
+    version?: number;
+    supportedChains: GetChainsApiResponse;
+    supportedSwapTokens: GetSwapTokensApiResponse;
+    supportedMoneyMarketTokens: GetMoneyMarketTokensApiResponse;
+    supportedMoneyMarketReserveAssets: GetMoneyMarketReserveAssetsApiResponse;
+    relayChainIdMap: GetRelayChainIdMapApiResponse;
+    spokeChainConfig: GetSpokeChainConfigApiResponse;
+};
+export interface IConfigApiV1 {
+    getChains(): Promise<Result<GetChainsApiResponse>>;
+    getSwapTokens(): Promise<Result<GetSwapTokensApiResponse>>;
+    getSwapTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetSwapTokensByChainIdApiResponse>>;
+    getMoneyMarketTokens(): Promise<Result<GetMoneyMarketTokensApiResponse>>;
+    getMoneyMarketTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetMoneyMarketTokensByChainIdApiResponse>>;
+}

package/dist/backend/backendApiV1.js

@@ -0,0 +1 @@
+export {};