@sodax/types 2.0.0-rc.18 → 2.0.0-rc.19

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

@@ -3,6 +3,7 @@ import type { XToken } from '../chains/tokens.js';
 import type { RelayConfig } from '../common/constants.js';
 import type { ConcentratedLiquidityConfig, DexDefaultConfig } from '../dex/dex.js';
 import type { SodaxDefaultConfig } from '../sodax-config/sodax-config.js';
+import type { RawTxReturnType } from '../common/index.js';
 /** Quote direction. Only exact-input quoting is supported. */
 export type QuoteTypeV2 = 'exact_input';
 /**
@@ -254,13 +255,13 @@ export interface AllowanceCheckResponseV2 {
 }
 /** POST /swaps/approve — response body. */
 export interface ApproveResponseV2 {
-    /** Unsigned approval transaction (chain-specific shape). For EVM: `{ from, to, value, data }`. */
-    tx: unknown;
+    /** Unsigned approval transaction — the `RawTxReturnType` variant for the request's `srcChainKey`. */
+    tx: RawTxReturnType;
 }
 /** POST /swaps/intents — response body. */
 export interface CreateIntentResponseV2 {
-    /** Unsigned create-intent transaction (chain-specific shape). For EVM: `{ from, to, value, data }`. */
-    tx: unknown;
+    /** Unsigned create-intent transaction — the `RawTxReturnType` variant for the request's `srcChainKey`. */
+    tx: RawTxReturnType;
     /** Built intent struct (hub representation). */
     intent: IntentResponseV2;
     /** Extra data required when calling `POST /swaps/intents/submit`. */
@@ -301,8 +302,8 @@ export interface CancelIntentRequestV2 {
 }
 /** POST /swaps/intents/cancel — response body. */
 export interface CancelIntentResponseV2 {
-    /** Unsigned cancel transaction (chain-specific shape). For EVM: `{ from, to, value, data }`. */
-    tx: unknown;
+    /** Unsigned cancel-intent transaction — the `RawTxReturnType` variant for the request's `srcChainKey`. */
+    tx: RawTxReturnType;
 }
 /** POST /swaps/intents/hash — request body. */
 export interface IntentHashRequestV2 {

package/dist/backend/backendApiV2.js

@@ -10,15 +10,21 @@
 // - Outbound (response) types are pure JSON: every bigint-derived value (intent
 //   ids, amounts, deadlines, fees, relay chain ids) is a decimal `string`, and
 //   every `Date` is an ISO 8601 `string` (e.g. `abandonedAt`). A response NEVER
-//   contains `bigint` — JSON cannot represent it.
+//   contains `bigint` on the wire — JSON cannot represent it (the one typed
+//   exception is the unsigned `tx`; see below).
 // - Inbound (request) types mirror the server's parsed request DTOs: the Intent
 //   struct (`IntentRequestV2`) carries `bigint` for its numeric fields, matching
 //   the backend `IntentDto`. Other request fields (amounts/deadlines on
 //   `CreateIntentParamsV2`/`QuoteRequestV2`, fees, relay chain ids, etc.) are
 //   decimal `string`, matching their `@IsNumberString` DTO fields.
 // - `Hex` / `Address` / `Hash` / `SpokeChainKey` are plain `string` everywhere.
-// - Chain-specific opaque payloads (unsigned `tx`, gas estimate, raw relay
-//   `result`) are `unknown` because their shape varies by chain family.
+// - The unsigned `tx` is typed as the SDK domain union `RawTxReturnType`. It
+//   travels as pure JSON (bigints stringified; Injective byte arrays as
+//   `{ "0": N, … }` index objects), and the SDK client's response schema
+//   (`@sodax/sdk` `rawTxSchemas`) rebuilds the domain shape (`bigint`,
+//   `Uint8Array`) on parse — the inverse of the backend's `stringifyBigInts`.
+// - The remaining chain-specific opaque payloads (gas estimate, raw relay
+//   `result`) stay `unknown` because their shape varies by chain family.
 //
 // Shapes used in both directions are split into a `*RequestV2` (client → server)
 // and a `*ResponseV2` (server → client) interface. `IntentRequestV2` (bigint

package/dist/backend/index.d.ts

@@ -1,2 +1,2 @@
-export * from './backendApi.js';
+export * from './backendApiV1.js';
 export * from './backendApiV2.js';

package/dist/backend/index.js

@@ -1,2 +1,2 @@
-export * from './backendApi.js';
+export * from './backendApiV1.js';
 export * from './backendApiV2.js';

package/dist/chains/chains.js

@@ -29,7 +29,7 @@ export const RelayChainIdMap = {
     [ChainKeys.STACKS_MAINNET]: 60n,
 };
 export const INTENT_CHAIN_IDS = Object.values(RelayChainIdMap);
-export const IntentRelayChainIdToChainKey = Object.fromEntries(Object.entries(RelayChainIdMap).map(([chainKey, chainId]) => [chainId, chainKey]));
+export const IntentRelayChainIdToChainKey = new Map(Object.entries(RelayChainIdMap).map(([chainKey, chainId]) => [chainId, chainKey]));
 /**
  * Base URL for default chain logos hosted in the `@sodax/assets` package.
  * Each logo is served from `main` via raw.githubusercontent and named by its

package/dist/common/constants.d.ts

@@ -15,11 +15,28 @@ export declare const DEFAULT_BACKEND_API_HEADERS: {
 };
 export declare const DEFAULT_RELAYER_API_ENDPOINT = "https://xcall-relay.nw.iconblockchain.xyz";
 export declare const VAULT_TOKEN_DECIMALS = 18;
-export type ApiConfig = {
+export type BaseApiConfig = {
     baseURL: HttpUrl;
     timeout: number;
     headers: Record<string, string>;
 };
+/** Per-endpoint config for the swaps API. Structurally identical to {@link BaseApiConfig}. */
+export type SwapsApiConfig = BaseApiConfig;
+/**
+ * Nested config that points the base (backend) API and the swaps API at independent endpoints.
+ * At least one slice must be provided — an empty custom config is meaningless (pass a flat
+ * {@link BaseApiConfig} instead). Requiring a slice keeps the two members disjoint from
+ * `BaseApiConfig` (which carries `baseURL`), so {@link ApiConfig} can be discriminated by the
+ * presence of a `baseApiConfig` / `swapsApiConfig` slice.
+ */
+export type CustomApiConfig = {
+    baseApiConfig: BaseApiConfig;
+    swapsApiConfig?: SwapsApiConfig;
+} | {
+    baseApiConfig?: BaseApiConfig;
+    swapsApiConfig: SwapsApiConfig;
+};
+export type ApiConfig = BaseApiConfig | CustomApiConfig;
 export declare const apiConfig: {
     baseURL: "https://api.sodax.com/v1/be";
     timeout: number;

package/dist/index.d.ts

@@ -19,4 +19,4 @@ 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 = 216;
+export declare const CONFIG_VERSION = 217;

package/dist/index.js

@@ -19,4 +19,4 @@ export * from './sui/index.js';
 export * from './swap/index.js';
 export * from './utils/index.js';
 export * from './wallet/index.js';
-export const CONFIG_VERSION = 216; // this value should be incremented (inside release/sdk branch) each time @sodax/types package is updated
+export const CONFIG_VERSION = 217; // this value should be incremented (inside release/sdk branch) each time @sodax/types package is updated

package/dist/shared/features.d.ts

@@ -6,4 +6,4 @@
  * per-feature analytics toggles). It lives in `@sodax/types`, the lowest layer, so every package
  * shares one source of truth instead of redefining the list; `@sodax/sdk` re-exports it.
  */
-export type SodaxFeature = 'swap' | 'moneyMarket' | 'bridge' | 'staking' | 'migration' | 'dex' | 'partner' | 'recovery' | 'leverageYield';
+export type SodaxFeature = 'swap' | 'moneyMarket' | 'bridge' | 'staking' | 'migration' | 'dex' | 'partner' | 'recovery' | 'backend' | 'leverageYield';

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

@@ -42,6 +42,7 @@ export type SodaxOptionalConfig = {
     moneyMarket?: MoneyMarketOptions;
     bridge?: BridgeOptions;
     leverageYield?: LeverageYieldOptions;
+    swapsOptions?: SwapsClientOptions;
 };
 /**
  * Options (always optional) accepted by `new Sodax(...)`. A deep-partial override of the {@link SodaxDefaultConfig} data
@@ -70,8 +71,17 @@ export type SodaxDefaultConfig = {
     relay: RelayConfig;
 };
 /**
- * Sodax default static data object which can always be overriden through Sodax instance (i.e. new Sodax(...config))
+ * Client-side swap behavior options. Like {@link SodaxOptionalConfig.logger}, these are runtime toggles
+ * resolved once at construction — NOT part of the backend-fetched {@link SodaxDefaultConfig} data.
  */
+export type SwapsClientOptions = {
+    /**
+     * Opt-in: route `swap()` through the backend submit-tx 2-step flow (the backend relays +
+     * post-executes server-side). On ANY non-success the SDK falls back to the client-side relay so
+     * the swap still completes. Default `false` (the current fully client-side flow).
+     */
+    useBackendSubmitTx?: boolean;
+};
 export declare const sodaxConfig: {
     chains: {
         readonly sonic: {

package/dist/sodax-config/sodax-config.js

@@ -5,9 +5,7 @@ import { swapsConfig } from '../swap/swap.js';
 import { leverageYieldConfig, } from '../leverageYield/leverageYield.js';
 import { spokeChainConfig, hubConfig, } from '../chains/chains.js';
 export const bridgeConfig = {};
-/**
- * Sodax default static data object which can always be overriden through Sodax instance (i.e. new Sodax(...config))
- */
+// default sodax config object which can always be overriden through Sodax instance (i.e. new Sodax(...config))
 export const sodaxConfig = {
     chains: spokeChainConfig,
     swaps: swapsConfig,

package/dist/solana/solana.d.ts

@@ -100,6 +100,8 @@ export interface ISolanaWalletProvider extends ICoreWallet {
     readonly chainType: 'SOLANA';
     getWalletAddress: () => Promise<string>;
     sendTransaction: (rawTransaction: Uint8Array | Array<number>) => Promise<TransactionSignature>;
+    /** Deserialize, sign, and broadcast an unsigned `SolanaRawTransaction` (e.g. from the Swaps API). */
+    signAndSendTransaction?: (params: SolanaRawTransaction) => Promise<TransactionSignature>;
     waitForConfirmation: (signature: TransactionSignature, commitment: Commitment) => Promise<SolanaRpcResponseAndContext<SolanaSignatureResult>>;
     buildV0Txn: (instructions: SolanaRawTransactionInstruction[]) => Promise<SolanaSerializedTransaction>;
     getWalletBase58PublicKey: () => SolanaBase58PublicKey;

package/dist/stacks/stacks.d.ts

@@ -207,4 +207,6 @@ export interface IStacksWalletProvider extends ICoreWallet {
     getPublicKey: () => Promise<string>;
     getBalance: (address: string) => Promise<bigint>;
     sendTransaction: (txParams: StacksTransactionParams) => Promise<string>;
+    /** Sign and broadcast an unsigned `StacksRawTransaction` (e.g. from the Swaps API). Returns the tx id. */
+    signAndSendTransaction?: (params: StacksRawTransaction) => Promise<string>;
 }

package/dist/stellar/stellar.d.ts

@@ -92,5 +92,9 @@ export interface IStellarWalletProvider extends ICoreWallet {
     readonly chainType: 'STELLAR';
     signTransaction: (tx: XDR) => Promise<XDR>;
     waitForTransactionReceipt: (txHash: string) => Promise<StellarRawTransactionReceipt>;
+    /** Broadcast an already-signed XDR transaction via the Soroban RPC server. Returns the tx hash. */
+    sendTransaction?: (signedTx: XDR) => Promise<string>;
+    /** Sign and broadcast an unsigned `StellarRawTransaction` (e.g. from the Swaps API). Returns the tx hash. */
+    signAndSendTransaction?: (params: StellarRawTransaction) => Promise<string>;
 }
 export {};

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "2.0.0-rc.18",
+  "version": "2.0.0-rc.19",
   "description": "Sodax Common Types",
   "main": "dist/index.js",
   "homepage": "https://github.com/icon-project/sodax-sdks/tree/main/packages/types",

package/dist/backend/backendApi.d.ts

@@ -1,74 +0,0 @@
-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';
-import type { SodaxConfig } from '../sodax-config/sodax-config.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;
-    config: SodaxConfig;
-};
-export interface IConfigApi {
-    getChains(): Promise<Result<GetChainsApiResponse>>;
-    getSwapTokens(): Promise<Result<GetSwapTokensApiResponse>>;
-    getSwapTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetSwapTokensByChainIdApiResponse>>;
-    getMoneyMarketTokens(): Promise<Result<GetMoneyMarketTokensApiResponse>>;
-    getMoneyMarketTokensByChainId(chainId: SpokeChainKey): Promise<Result<GetMoneyMarketTokensByChainIdApiResponse>>;
-}
-export interface SwapIntentData {
-    intentId: string;
-    creator: string;
-    inputToken: string;
-    outputToken: string;
-    inputAmount: string;
-    minOutputAmount: string;
-    deadline: string;
-    allowPartialFill: boolean;
-    srcChain: number;
-    dstChain: number;
-    srcAddress: string;
-    dstAddress: string;
-    solver: string;
-    data: string;
-}
-export interface SubmitSwapTxRequest {
-    txHash: string;
-    srcChainKey: string;
-    walletAddress: string;
-    intent: SwapIntentData;
-    relayData: string;
-}
-export interface SubmitSwapTxResponse {
-    success: boolean;
-    message: string;
-}
-export interface GetSubmitSwapTxStatusParams {
-    txHash: string;
-    srcChainKey?: string;
-}
-export interface SubmitSwapTxStatusResult {
-    dstIntentTxHash: string;
-    packetData?: Record<string, unknown>;
-    intent_hash?: string;
-}
-export type SubmitSwapTxStatus = 'pending' | 'verifying' | 'verified' | 'relaying' | 'relayed' | 'posting_execution' | 'executed' | 'failed';
-export interface SubmitSwapTxStatusData {
-    txHash: string;
-    srcChainKey: string;
-    status: SubmitSwapTxStatus;
-    failedAtStep?: string;
-    failureReason?: string;
-    failedAttempts: number;
-    result?: SubmitSwapTxStatusResult;
-}
-export interface SubmitSwapTxStatusResponse {
-    success: boolean;
-    data: SubmitSwapTxStatusData;
-}