@sodax/types 2.0.0-rc.1 → 2.0.0-rc.3

package/README.md

@@ -1,54 +1,68 @@
-# @sodax/wallet-types
+# @sodax/types
 
-Wallet connectivity type definitions for the SODAX multi-chain ecosystem.
+Shared SODAX type definitions, constants, and configuration for SDK packages and applications.
 
-Provides `WalletProvider` interfaces and chain-specific transaction types for 9 blockchain families. Self-contained with **zero external dependencies**.
+This package includes chain and token metadata, wallet provider interfaces, transaction and receipt types, backend API contracts, swap and money market configuration, DEX configuration, and common utilities.
 
 ## Install
 
 ```bash
-pnpm add @sodax/wallet-types
+pnpm add @sodax/types
 ```
 
 ## Usage
 
-Import everything from the root:
+Import shared types, constants, configuration, and helpers from the root package:
 
 ```typescript
-import type { WalletAddressProvider, IBitcoinWalletProvider } from '@sodax/wallet-types';
+import {
+  ChainKeys,
+  CONFIG_VERSION,
+  getEvmChainKeyByChainId,
+  sodaxConfig,
+  supportedTokensByChain,
+} from '@sodax/types';
+
+import type {
+  Address,
+  DeepPartial,
+  EvmRawTransaction,
+  IBitcoinWalletProvider,
+  IEvmWalletProvider,
+  IWalletProvider,
+  SpokeChainKey,
+  WalletAddressProvider,
+} from '@sodax/types';
 ```
 
-Or import only the chain you need via sub-package exports:
+DEX types and constants are also available from the dedicated DEX subpath export:
 
 ```typescript
-import type { IEvmWalletProvider, EvmRawTransaction } from '@sodax/wallet-types/evm';
-import type { ISolanaWalletProvider } from '@sodax/wallet-types/solana';
-import type { IBitcoinWalletProvider, UTXO } from '@sodax/wallet-types/bitcoin';
-import type { IIconWalletProvider } from '@sodax/wallet-types/icon';
-import type { INearWalletProvider } from '@sodax/wallet-types/near';
-import type { IStellarWalletProvider } from '@sodax/wallet-types/stellar';
-import type { ISuiWalletProvider } from '@sodax/wallet-types/sui';
-import type { IInjectiveWalletProvider } from '@sodax/wallet-types/injective';
-import type { IStacksWalletProvider } from '@sodax/wallet-types/stacks';
+import { concentratedLiquidityConfig, dexConfig } from '@sodax/types/dex';
+
+import type { ConcentratedLiquidityConfig, DexConfig, PoolKey } from '@sodax/types/dex';
 ```
 
-## Supported Chains
+The package currently exposes only the root export (`@sodax/types`) and the DEX export (`@sodax/types/dex`). Chain-specific types such as `IEvmWalletProvider`, `BitcoinRawTransaction`, and `SolanaRawTransactionReceipt` are available from the root package.
+
+## Export Overview
 
-| Chain | Sub-import | Wallet Provider Interface |
-| --- | --- | --- |
-| EVM (Sonic, Ethereum, Arbitrum, …) | `@sodax/wallet-types/evm` | `IEvmWalletProvider` |
-| Bitcoin | `@sodax/wallet-types/bitcoin` | `IBitcoinWalletProvider` |
-| Solana | `@sodax/wallet-types/solana` | `ISolanaWalletProvider` |
-| Stellar | `@sodax/wallet-types/stellar` | `IStellarWalletProvider` |
-| Sui | `@sodax/wallet-types/sui` | `ISuiWalletProvider` |
-| ICON | `@sodax/wallet-types/icon` | `IIconWalletProvider` |
-| Injective | `@sodax/wallet-types/injective` | `IInjectiveWalletProvider` |
-| NEAR | `@sodax/wallet-types/near` | `INearWalletProvider` |
-| Stacks | `@sodax/wallet-types/stacks` | `IStacksWalletProvider` |
+| Area | Examples |
+| --- | --- |
+| 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` [^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` [^cfg], `bridgeConfig`, `swapsConfig`, `moneyMarketConfig`, `dexConfig`, `concentratedLiquidityConfig` |
+| Utilities | `DeepPartial`, `getChainType`, `getEvmChainKeyByChainId`, chain guard helpers, bnUSD token helpers |
 
-## Base Interface
+[^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.
 
-All wallet providers extend `WalletAddressProvider`:
+## Wallet Providers
+
+All wallet providers extend the base wallet address contract:
 
 ```typescript
 interface WalletAddressProvider {
@@ -57,4 +71,28 @@ interface WalletAddressProvider {
 }
 ```
 
-Each chain-specific provider adds its own signing, transaction, and query methods.
+`ICoreWallet` extends `WalletAddressProvider`, and each chain-specific provider adds its own signing, transaction, and query methods. The root export includes provider interfaces for all supported chain families:
+
+| Chain family | Provider interface |
+| --- | --- |
+| EVM | `IEvmWalletProvider` |
+| Bitcoin | `IBitcoinWalletProvider` |
+| Solana | `ISolanaWalletProvider` |
+| Stellar | `IStellarWalletProvider` |
+| Sui | `ISuiWalletProvider` |
+| ICON | `IIconWalletProvider` |
+| Injective | `IInjectiveWalletProvider` |
+| NEAR | `INearWalletProvider` |
+| Stacks | `IStacksWalletProvider` |
+
+Use `IWalletProvider` for the union of all chain-specific wallet providers, or `GetWalletProviderType<C>` to map a `SpokeChainKey` or `ChainType` to the matching provider interface.
+
+```typescript
+import type { GetWalletProviderType, IEvmWalletProvider, IWalletProvider, SpokeChainKey } from '@sodax/types';
+
+type ProviderForChain<C extends SpokeChainKey> = GetWalletProviderType<C>;
+
+function isEvmProvider(provider: IWalletProvider): provider is IEvmWalletProvider {
+  return provider.chainType === 'EVM';
+}
+```

package/dist/chains/chains.d.ts

@@ -1120,7 +1120,7 @@ export declare const spokeChainConfig: {
         readonly walletAddress: "";
         readonly pollingConfig: {
             readonly pollingIntervalMs: 750;
-            readonly maxTimeoutMs: 60000;
+            readonly maxTimeoutMs: 15000;
         };
     };
     readonly "0xa86a.avax": {

package/dist/chains/chains.js

@@ -363,7 +363,7 @@ export const spokeChainConfig = {
         walletAddress: '',
         pollingConfig: {
             pollingIntervalMs: 750,
-            maxTimeoutMs: 60_000, // aligns with blockhash expiry timeout.
+            maxTimeoutMs: 15_000, // aligns with blockhash expiry timeout.
         },
     },
     [ChainKeys.AVALANCHE_MAINNET]: {

package/dist/index.d.ts

@@ -17,5 +17,5 @@ export * from './sui/index.js';
 export * from './swap/index.js';
 export * from './utils/index.js';
 export * from './wallet/index.js';
-export declare const CONFIG_VERSION = 200;
+export declare const CONFIG_VERSION = 201;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -17,5 +17,5 @@ export * from './sui/index.js';
 export * from './swap/index.js';
 export * from './utils/index.js';
 export * from './wallet/index.js';
-export const CONFIG_VERSION = 200; // this value should be incremented (inside release/sdk branch) each time @sodax/types package is updated
+export const CONFIG_VERSION = 201; // this value should be incremented (inside release/sdk branch) each time @sodax/types package is updated
 //# sourceMappingURL=index.js.map

package/dist/sodax-config/sodax-config.d.ts

@@ -661,7 +661,7 @@ export declare const sodaxConfig: {
             readonly walletAddress: "";
             readonly pollingConfig: {
                 readonly pollingIntervalMs: 750;
-                readonly maxTimeoutMs: 60000;
+                readonly maxTimeoutMs: 15000;
             };
         };
         readonly "0xa86a.avax": {

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.3",
   "description": "Sodax Common Types",
   "main": "dist/index.js",
   "homepage": "https://github.com/icon-project/sodax-sdks/tree/main/packages/types",
@@ -15,6 +15,9 @@
     "type": "git",
     "url": "https://github.com/icon-project/sodax-sdks"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "files": [
     "dist"
   ],