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

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/backend/backendApi.d.ts

@@ -72,4 +72,3 @@ export interface SubmitSwapTxStatusResponse {
     success: boolean;
     data: SubmitSwapTxStatusData;
 }
-//# sourceMappingURL=backendApi.d.ts.map

package/dist/backend/backendApi.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=backendApi.js.map

package/dist/backend/index.d.ts

@@ -1,2 +1 @@
 export * from './backendApi.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/backend/index.js

@@ -1,2 +1 @@
 export * from './backendApi.js';
-//# sourceMappingURL=index.js.map

package/dist/bitcoin/bitcoin.d.ts

@@ -106,4 +106,3 @@ export interface UTXO {
     };
 }
 export {};
-//# sourceMappingURL=bitcoin.d.ts.map

package/dist/bitcoin/bitcoin.js

@@ -20,4 +20,3 @@ export function detectBitcoinAddressType(address) {
 export const BTC_WALLET_ADDRESS_TYPES = ['taproot', 'segwit'];
 /** Address types that Sodax supports for transactions. */
 const BTC_ADDRESS_TYPES = ['P2PKH', 'P2SH', 'P2WPKH', 'P2TR'];
-//# sourceMappingURL=bitcoin.js.map

package/dist/bitcoin/index.d.ts

@@ -1,2 +1 @@
 export * from './bitcoin.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/bitcoin/index.js

@@ -1,2 +1 @@
 export * from './bitcoin.js';
-//# sourceMappingURL=index.js.map

package/dist/chains/chain-keys.d.ts

@@ -28,4 +28,3 @@ export type ChainKey = (typeof ChainKeys)[keyof typeof ChainKeys];
 export declare const CHAIN_KEYS: ("0xa86a.avax" | "0xa4b1.arbitrum" | "0x2105.base" | "0x38.bsc" | "injective-1" | "sonic" | "0x1.icon" | "sui" | "0xa.optimism" | "0x89.polygon" | "solana" | "stellar" | "hyper" | "lightlink" | "near" | "ethereum" | "bitcoin" | "redbelly" | "0x2019.kaia" | "stacks")[];
 export declare const spokeChainKeysSet: Set<"0xa86a.avax" | "0xa4b1.arbitrum" | "0x2105.base" | "0x38.bsc" | "injective-1" | "sonic" | "0x1.icon" | "sui" | "0xa.optimism" | "0x89.polygon" | "solana" | "stellar" | "hyper" | "lightlink" | "near" | "ethereum" | "bitcoin" | "redbelly" | "0x2019.kaia" | "stacks">;
 export type ChainType = (typeof ChainTypeArr)[number];
-//# sourceMappingURL=chain-keys.d.ts.map

package/dist/chains/chain-keys.js

@@ -36,4 +36,3 @@ export const ChainKeys = {
 };
 export const CHAIN_KEYS = Object.values(ChainKeys);
 export const spokeChainKeysSet = new Set(CHAIN_KEYS);
-//# sourceMappingURL=chain-keys.js.map

package/dist/chains/chains.d.ts

@@ -562,6 +562,15 @@ export declare const spokeChainConfig: {
                 readonly hubAsset: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
                 readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
             };
+            readonly sodaWBTC: {
+                readonly symbol: "sodaWBTC";
+                readonly name: "Soda Wrapped BTC";
+                readonly decimals: 18;
+                readonly address: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+                readonly chainKey: "sonic";
+                readonly hubAsset: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+                readonly vault: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+            };
             readonly sodaSOL: {
                 readonly symbol: "sodaSOL";
                 readonly name: "Soda SOL";
@@ -709,7 +718,7 @@ export declare const spokeChainConfig: {
             readonly sodaNEAR: {
                 readonly symbol: "sodaNEAR";
                 readonly name: "SODA NEAR";
-                readonly decimals: 24;
+                readonly decimals: 18;
                 readonly address: "0xf4ba497c9b805e4bd88a8a9e6a7b8f74984c3e39";
                 readonly chainKey: "sonic";
                 readonly hubAsset: "0xf4ba497c9b805e4bd88a8a9e6a7b8f74984c3e39";
@@ -1114,13 +1123,85 @@ export declare const spokeChainConfig: {
                 readonly hubAsset: "0x0076b67235bfc69b649d29dd7cb66e5b92b618aa";
                 readonly vault: "0x0076b67235bfc69b649d29dd7cb66e5b92b618aa";
             };
+            readonly CRCLx: {
+                readonly symbol: "CRCLx";
+                readonly name: "Circle xStock";
+                readonly decimals: 8;
+                readonly address: "XsueG8BtpquVJX9LVLLEGuViXUungE6WmK5YZ3p3bd1";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0x64659130a3373b3527146b38fc1fccf017bc0c61";
+                readonly vault: "0x64659130a3373b3527146b38fc1fccf017bc0c61";
+            };
+            readonly TSLAx: {
+                readonly symbol: "TSLAx";
+                readonly name: "Tesla xStock";
+                readonly decimals: 8;
+                readonly address: "XsDoVfqeBukxuZHWhdvWHBhgEHjGNst4MLodqsJHzoB";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0x3cc867f6f4d1817b6230b781125301363fce370c";
+                readonly vault: "0x3cc867f6f4d1817b6230b781125301363fce370c";
+            };
+            readonly SPYx: {
+                readonly symbol: "SPYx";
+                readonly name: "SP500 xStock";
+                readonly decimals: 8;
+                readonly address: "XsoCS1TfEyfFhfvj8EtZ528L3CaKBDBRqRapnBbDF2W";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0xea66dbe82ebcb6c3a55b2db3d722b676be63a26e";
+                readonly vault: "0xea66dbe82ebcb6c3a55b2db3d722b676be63a26e";
+            };
+            readonly NVDAx: {
+                readonly symbol: "NVDAx";
+                readonly name: "NVIDIA xStock";
+                readonly decimals: 8;
+                readonly address: "Xsc9qvGR1efVDFGLrVsmkzv3qi45LTBjeUKSPmx9qEh";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0x48303c90f4136bc3101b308c8b50c55745aaf317";
+                readonly vault: "0x48303c90f4136bc3101b308c8b50c55745aaf317";
+            };
+            readonly QQQx: {
+                readonly symbol: "QQQx";
+                readonly name: "Nasdaq xStock";
+                readonly decimals: 8;
+                readonly address: "Xs8S1uUs1zvS2p7iwtsG3b6fkhpvmwz4GYU3gWAmWHZ";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0x4448b894740198ab76c83c8850d73f7dc8e4b9b3";
+                readonly vault: "0x4448b894740198ab76c83c8850d73f7dc8e4b9b3";
+            };
+            readonly MSTRx: {
+                readonly symbol: "MSTRx";
+                readonly name: "MicroStrategy xStock";
+                readonly decimals: 8;
+                readonly address: "XsP7xzNPvEHS1m6qfanPUGjNmdnmsLKEoNAnHjdxxyZ";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0xc46c34961802355c5223a115568fdf18a51ad6f6";
+                readonly vault: "0xc46c34961802355c5223a115568fdf18a51ad6f6";
+            };
+            readonly COINx: {
+                readonly symbol: "COINx";
+                readonly name: "Coinbase xStock";
+                readonly decimals: 8;
+                readonly address: "Xs7ZdzSHLU9ftNJsii5fCeJhoRWSC32SQGzGQtePxNu";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0xf444586e95166da0754052f03f344cf1152abe7d";
+                readonly vault: "0xf444586e95166da0754052f03f344cf1152abe7d";
+            };
+            readonly GOOGLx: {
+                readonly symbol: "GOOGLx";
+                readonly name: "Alphabet xStock";
+                readonly decimals: 8;
+                readonly address: "XsCPL9dNWBMvFtTmwcCA5v3xWPSMEBCszbQdiLLq6aN";
+                readonly chainKey: "solana";
+                readonly hubAsset: "0x024230dd63b27df90d988d6f37a69d4de627ce89";
+                readonly vault: "0x024230dd63b27df90d988d6f37a69d4de627ce89";
+            };
         };
         readonly gasPrice: "500000";
         readonly rpcUrl: "https://api.mainnet-beta.solana.com";
         readonly walletAddress: "";
         readonly pollingConfig: {
             readonly pollingIntervalMs: 750;
-            readonly maxTimeoutMs: 60000;
+            readonly maxTimeoutMs: 15000;
         };
     };
     readonly "0xa86a.avax": {
@@ -1271,6 +1352,7 @@ export declare const spokeChainConfig: {
                 readonly chainKey: "0xa4b1.arbitrum";
                 readonly hubAsset: "0x96Fc8540736f1598b7E235e6dE8814062b3b5d3B";
                 readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
+                readonly access: "withdrawOnly";
             };
             readonly WBTC: {
                 readonly symbol: "WBTC";
@@ -1279,7 +1361,17 @@ export declare const spokeChainConfig: {
                 readonly address: "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f";
                 readonly chainKey: "0xa4b1.arbitrum";
                 readonly hubAsset: "0xfB0ACB1b2720B620935F50a6dd3F7FEA52b2FCBe";
+                readonly vault: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+            };
+            readonly WBTC_LEGACY: {
+                readonly symbol: "WBTC.legacy";
+                readonly name: "Wrapped BTC (Legacy)";
+                readonly decimals: 8;
+                readonly address: "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f";
+                readonly chainKey: "0xa4b1.arbitrum";
+                readonly hubAsset: "0xfB0ACB1b2720B620935F50a6dd3F7FEA52b2FCBe";
                 readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
+                readonly access: "withdrawOnly";
             };
             readonly USDC: {
                 readonly symbol: "USDC";
@@ -1461,6 +1553,7 @@ export declare const spokeChainConfig: {
                 readonly chainKey: "0x2105.base";
                 readonly hubAsset: "0x2803a23a3BA6b09e57D1c71deC0D9eFdBB00A27F";
                 readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
+                readonly access: "withdrawOnly";
             };
             readonly SODA: {
                 readonly symbol: "SODA";
@@ -2844,7 +2937,17 @@ export declare const spokeChainConfig: {
                 readonly address: "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599";
                 readonly chainKey: "ethereum";
                 readonly hubAsset: "0x4ccbe4c2cf2aeed19314790622efd71dc0b67acb";
+                readonly vault: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+            };
+            readonly WBTC_LEGACY: {
+                readonly symbol: "WBTC.legacy";
+                readonly name: "Wrapped Bitcoin (Legacy)";
+                readonly decimals: 8;
+                readonly address: "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599";
+                readonly chainKey: "ethereum";
+                readonly hubAsset: "0x4ccbe4c2cf2aeed19314790622efd71dc0b67acb";
                 readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
+                readonly access: "withdrawOnly";
             };
             readonly sUSDat: {
                 readonly symbol: "sUSDat";
@@ -3235,6 +3338,15 @@ export declare const hubConfig: {
             readonly hubAsset: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
             readonly vault: "0x7A1A5555842Ad2D0eD274d09b5c4406a95799D5d";
         };
+        readonly sodaWBTC: {
+            readonly symbol: "sodaWBTC";
+            readonly name: "Soda Wrapped BTC";
+            readonly decimals: 18;
+            readonly address: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+            readonly chainKey: "sonic";
+            readonly hubAsset: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+            readonly vault: "0x811C3fCc13f9c2a23AE2Ae2DCadacFAC6eb5f0eB";
+        };
         readonly sodaSOL: {
             readonly symbol: "sodaSOL";
             readonly name: "Soda SOL";
@@ -3382,7 +3494,7 @@ export declare const hubConfig: {
         readonly sodaNEAR: {
             readonly symbol: "sodaNEAR";
             readonly name: "SODA NEAR";
-            readonly decimals: 24;
+            readonly decimals: 18;
             readonly address: "0xf4ba497c9b805e4bd88a8a9e6a7b8f74984c3e39";
             readonly chainKey: "sonic";
             readonly hubAsset: "0xf4ba497c9b805e4bd88a8a9e6a7b8f74984c3e39";
@@ -3488,4 +3600,3 @@ export declare const hubConfig: {
 };
 export type IntentRelayChainId = (typeof RelayChainIdMap)[keyof typeof RelayChainIdMap];
 export type IntentRelayChainIdMap = Record<ChainKey, IntentRelayChainId>;
-//# sourceMappingURL=chains.d.ts.map

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]: {
@@ -709,4 +709,3 @@ export const hubConfig = {
     },
     rpcUrl: 'https://rpc.soniclabs.com',
 };
-//# sourceMappingURL=chains.js.map

package/dist/chains/index.d.ts

@@ -1,3 +1,2 @@
 export * from './chains.js';
 export * from './tokens.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/chains/index.js

@@ -1,3 +1,2 @@
 export * from './chains.js';
 export * from './tokens.js';
-//# sourceMappingURL=index.js.map