@bolt-liquidity-hq/sui-client 0.1.0-beta.12 → 0.1.0-beta.13

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ChainConfig, ClientConfig, BaseClient, OracleConfig, OracleAssetPair, InvertiblePrice, Price, RouterConfig, Address, BaseLiquidityDetails, Coin, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
+import { ChainConfig, ClientConfig, Pool, BaseClient, OracleConfig, OracleAssetPair, InvertiblePrice, Price, RouterConfig, Address, BaseLiquidityDetails, Coin, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
 import { SuiClient, SuiTransactionBlockResponse } from '@mysten/sui/client';
 import { Signer } from '@mysten/sui/cryptography';
 import * as _mysten_bcs from '@mysten/bcs';
@@ -27,75 +27,108 @@ type SuiClientConfig = ClientConfig<SuiChainConfig> & {
 };
 
 declare const OracleConfigStruct: _mysten_bcs.BcsStruct<{
-    admin: _mysten_bcs.BcsType<string, string, "address">;
     price_threshold_ratio: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
     default_price_expiry_seconds: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
 }, string>;
 type OracleConfigStructOutput = BcsParsed<typeof OracleConfigStruct>;
 declare const AssetPairStruct: _mysten_bcs.BcsStruct<{
-    base_symbol: _mysten_bcs.BcsType<string, string, "string">;
-    quote_symbol: _mysten_bcs.BcsType<string, string, "string">;
+    base_name: _mysten_bcs.BcsType<string, string, "string">;
+    quote_name: _mysten_bcs.BcsType<string, string, "string">;
     base_precision: _mysten_bcs.BcsType<number, number, "u8">;
     quote_precision: _mysten_bcs.BcsType<number, number, "u8">;
 }, string>;
 type AssetPairStructOutput = BcsParsed<typeof AssetPairStruct>;
-declare const AssetPairsResponseStruct: _mysten_bcs.BcsStruct<{
-    asset_pairs: _mysten_bcs.BcsType<{
-        base_symbol: string;
-        quote_symbol: string;
-        base_precision: number;
-        quote_precision: number;
-    }[], Iterable<{
-        base_symbol: string;
-        quote_symbol: string;
-        base_precision: number;
-        quote_precision: number;
-    }> & {
-        length: number;
+declare const TypeNameStruct: _mysten_bcs.BcsStruct<{
+    name: _mysten_bcs.BcsType<string, string, "string">;
+}, string>;
+type TypeNameStructOutput = BcsParsed<typeof TypeNameStruct>;
+declare const RawPairStruct: _mysten_bcs.BcsStruct<{
+    base: _mysten_bcs.BcsStruct<{
+        name: _mysten_bcs.BcsType<string, string, "string">;
+    }, string>;
+    quote: _mysten_bcs.BcsStruct<{
+        name: _mysten_bcs.BcsType<string, string, "string">;
     }, string>;
 }, string>;
-type AssetPairsResponseStructOutput = BcsParsed<typeof AssetPairsResponseStruct>;
-declare const AssetPairsResponsePaginatedStruct: _mysten_bcs.BcsStruct<{
-    total_count: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
-    has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
-    next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
-    asset_pairs: _mysten_bcs.BcsType<{
-        base_symbol: string;
-        quote_symbol: string;
+type RawPairStructOutput = BcsParsed<typeof RawPairStruct>;
+declare const AssetPairResponseStruct: _mysten_bcs.BcsStruct<{
+    pair: _mysten_bcs.BcsStruct<{
+        base: _mysten_bcs.BcsStruct<{
+            name: _mysten_bcs.BcsType<string, string, "string">;
+        }, string>;
+        quote: _mysten_bcs.BcsStruct<{
+            name: _mysten_bcs.BcsType<string, string, "string">;
+        }, string>;
+    }, string>;
+    info: _mysten_bcs.BcsStruct<{
+        base_name: _mysten_bcs.BcsType<string, string, "string">;
+        quote_name: _mysten_bcs.BcsType<string, string, "string">;
+        base_precision: _mysten_bcs.BcsType<number, number, "u8">;
+        quote_precision: _mysten_bcs.BcsType<number, number, "u8">;
+    }, string>;
+}, string>;
+type AssetPairResponseStructOutput = BcsParsed<typeof AssetPairResponseStruct>;
+declare const AssetPairsResponseStruct: _mysten_bcs.BcsType<{
+    pair: {
+        base: {
+            name: string;
+        };
+        quote: {
+            name: string;
+        };
+    };
+    info: {
+        base_name: string;
+        quote_name: string;
         base_precision: number;
         quote_precision: number;
-    }[], Iterable<{
-        base_symbol: string;
-        quote_symbol: string;
+    };
+}[], Iterable<{
+    pair: {
+        base: {
+            name: string;
+        };
+        quote: {
+            name: string;
+        };
+    };
+    info: {
+        base_name: string;
+        quote_name: string;
         base_precision: number;
         quote_precision: number;
-    }> & {
-        length: number;
-    }, string>;
+    };
+}> & {
+    length: number;
+}, `vector<${string}>`>;
+type AssetPairsResponseStructOutput = BcsParsed<typeof AssetPairsResponseStruct>;
+declare const RawPriceStruct: _mysten_bcs.BcsStruct<{
+    price: _mysten_bcs.BcsType<string, string | number | bigint, "u128">;
+    expiry: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
 }, string>;
-type AssetPairsResponsePaginatedStructOutput = BcsParsed<typeof AssetPairsResponsePaginatedStruct>;
+type RawPriceStructOutput = BcsParsed<typeof RawPriceStruct>;
 declare const PriceDataStruct: _mysten_bcs.BcsStruct<{
-    base_symbol: _mysten_bcs.BcsType<string, string, "string">;
-    quote_symbol: _mysten_bcs.BcsType<string, string, "string">;
-    price: _mysten_bcs.BcsType<string, string | number | bigint, "u128">;
-    expiry_time_ms: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    price: _mysten_bcs.BcsStruct<{
+        price: _mysten_bcs.BcsType<string, string | number | bigint, "u128">;
+        expiry: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    }, string>;
     last_updated_ms: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
     updater: _mysten_bcs.BcsType<string, string, "address">;
 }, string>;
 type PriceDataStructOutput = BcsParsed<typeof PriceDataStruct>;
 declare const PriceResponseStruct: _mysten_bcs.BcsStruct<{
     pair_data: _mysten_bcs.BcsType<{
-        base_symbol: string;
-        quote_symbol: string;
-        price: string;
-        expiry_time_ms: string;
+        price: {
+            price: string;
+            expiry: string;
+        };
         last_updated_ms: string;
         updater: string;
     } | null, {
-        base_symbol: string;
-        quote_symbol: string;
-        price: string | number | bigint;
-        expiry_time_ms: string | number | bigint;
+        price: {
+            price: string | number | bigint;
+            expiry: string | number | bigint;
+        };
         last_updated_ms: string | number | bigint;
         updater: string;
     } | null | undefined, `Option<${string}>`>;
@@ -106,17 +139,17 @@ declare const PricesResponsePaginatedStruct: _mysten_bcs.BcsStruct<{
     has_next_page: _mysten_bcs.BcsType<boolean, boolean, "bool">;
     next_cursor: _mysten_bcs.BcsType<string | null, string | null | undefined, "Option<string>">;
     prices: _mysten_bcs.BcsType<{
-        base_symbol: string;
-        quote_symbol: string;
-        price: string;
-        expiry_time_ms: string;
+        price: {
+            price: string;
+            expiry: string;
+        };
         last_updated_ms: string;
         updater: string;
     }[], Iterable<{
-        base_symbol: string;
-        quote_symbol: string;
-        price: string | number | bigint;
-        expiry_time_ms: string | number | bigint;
+        price: {
+            price: string | number | bigint;
+            expiry: string | number | bigint;
+        };
         last_updated_ms: string | number | bigint;
         updater: string;
     }> & {
@@ -225,10 +258,32 @@ declare const BaseLiquidityResponseStruct: _mysten_bcs.BcsStruct<{
 }, string>;
 type BaseLiquidityResponseStructOutput = BcsParsed<typeof BaseLiquidityResponseStruct>;
 
-declare const GetPoolInfoResponseStruct: readonly [_mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u128">, _mysten_bcs.BcsType<string, string, "address">, _mysten_bcs.BcsType<boolean, boolean, "bool">];
-type GetPoolInfoResponseStructOutput = BcsParsedMultiple<typeof GetPoolInfoResponseStruct>;
-declare const GetFeesResponseStruct: readonly [_mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u64">, _mysten_bcs.BcsType<string, string | number | bigint, "u64">];
-type GetFeesResponseStructOutput = BcsParsedMultiple<typeof GetFeesResponseStruct>;
+declare const PoolInfoStruct: _mysten_bcs.BcsStruct<{
+    base_liquidity: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    total_lp_shares: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    admin: _mysten_bcs.BcsType<string, string, "address">;
+    is_paused: _mysten_bcs.BcsType<boolean, boolean, "bool">;
+}, string>;
+type PoolInfoStructOutput = BcsParsed<typeof PoolInfoStruct>;
+declare const PoolFeesInfoStruct: _mysten_bcs.BcsStruct<{
+    swap_fee_pct: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    lp_withdrawal_fee_pct: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    lp_fee_pct: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+}, string>;
+type PoolFeesInfoStructOutput = BcsParsed<typeof PoolFeesInfoStruct>;
+declare const ProtocolFeesInfoStruct: _mysten_bcs.BcsStruct<{
+    bolt_fee_addr: _mysten_bcs.BcsType<string, string, "address">;
+    swap_fee_pct: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+    lp_withdrawal_fee_pct: _mysten_bcs.BcsType<string, string | number | bigint, "u64">;
+}, string>;
+type ProtocolFeesInfoStructOutput = BcsParsed<typeof ProtocolFeesInfoStruct>;
+
+declare class RouterClient {
+    pools: Pool[];
+    constructor(pools: Pool[]);
+    getPool(denomIn: string, denomOut: string): Pool | undefined;
+    getPools(): Pool[];
+}
 
 /**
  * Client implementation for interacting with the Bolt Liquidity Outpost on Sui blockchain.
@@ -273,19 +328,30 @@ declare class BoltSuiClient extends BaseClient<Signer, SuiTransactionBlockRespon
     poolGlobalConfigId: string;
     /**
      * Cached instance of the Signer for transaction execution
-     * @private
      */
     signer?: Signer;
     /**
      * Instance of the Sui client to interact with the blockchain
      */
     suiClient: SuiClient;
+    /**
+     * URL for fetching testnet configuration dynamically.
+     * Used to load package IDs, oracle addresses, and asset configurations for testnet environments.
+     * @private
+     */
+    private configFileUrl?;
+    /**
+     * Router client instance for managing pool configurations and routing calculations.
+     * Handles pool discovery and optimal path finding for swaps.
+     */
+    routerClient: RouterClient;
     /**
      * Creates a new instance of the BoltSuiClient.
      *
      * The client automatically configures itself based on the specified environment,
      * loading the appropriate contract addresses, chain configuration, native token denomination,
-     * and assets from configuration files.
+     * and assets from configuration files. For testnet environments, the client can dynamically
+     * fetch configuration from a remote URL.
      *
      * @param config - (Optional) Configuration for the client
      * @param config.environment - (Optional) The deployment environment ('mainnet' or 'testnet'). Defaults to 'mainnet'
@@ -311,7 +377,7 @@ declare class BoltSuiClient extends BaseClient<Signer, SuiTransactionBlockRespon
      * // Use default configuration (Sui mainnet)
      * const client = new BoltSuiClient();
      *
-     * // Use testnet configuration
+     * // Use testnet configuration (will fetch config dynamically)
      * const testnetClient = new BoltSuiClient({
      *   environment: 'testnet'
      * });
@@ -391,15 +457,34 @@ declare class BoltSuiClient extends BaseClient<Signer, SuiTransactionBlockRespon
     getAllBaseAssetsLiquidity(): Promise<Record<Address, BaseLiquidityDetails>>;
     /** @inheritdoc */
     getAllQuotesByUser(address: Address): Promise<Record<Address, Coin[]>>;
-    /** @inheritdoc */
-    getPoolByBaseAsset(baseDenom: string): Promise<Pool>;
+    /**
+     * @inheritdoc
+     *
+     * @remarks
+     * In the Sui implementation, both `baseDenom` and `quoteDenom` parameters are required.
+     * The Sui architecture uses both asset types to uniquely identify pools for specific
+     * trading pairs.
+     *
+     * @throws Will throw an error if no pool exists for the specified base/quote asset pair
+     */
+    getPoolByDenom(baseDenom: string, quoteDenom: string): Promise<Pool>;
     /** @inheritdoc */
     getAllPools(): Promise<Pool[]>;
+    /** @inheritdoc */
     getPoolConfig(poolContractAddress: string): Promise<PoolConfig>;
     /** @inheritdoc */
     getAssets(): Promise<Asset[]>;
-    /** @inheritdoc */
-    getPoolConfigByBaseAsset(baseDenom: string): Promise<PoolConfig>;
+    /**
+     * @inheritdoc
+     *
+     * @remarks
+     * In the Sui implementation, both `baseDenom` and `quoteDenom` parameters are required.
+     * The Sui architecture uses both asset types to uniquely identify pools for specific
+     * trading pairs.
+     *
+     * @throws Will throw an error if no pool exists for the specified base/quote asset pair
+     */
+    getPoolConfigByDenom(baseDenom: string, quoteDenom: string): Promise<PoolConfig>;
     /**
      * @inheritdoc
      *
@@ -458,6 +543,27 @@ declare class BoltSuiClient extends BaseClient<Signer, SuiTransactionBlockRespon
      * - Sui's gas model includes computation, storage, and storage rebates
      */
     estimateSwapGasFees(params: SwapParams, signer?: Signer, gasAdjustment?: number): Promise<Coin | undefined>;
+    /**
+     * Loads configuration from a remote URL for testnet environments.
+     *
+     * This method fetches and applies dynamic configuration including:
+     * - Package ID for Bolt contracts
+     * - Oracle contract address
+     * - Pool global configuration ID
+     * - Asset mappings and metadata
+     * - Pool configurations
+     *
+     * The method is called automatically before API operations when a config URL is set.
+     * After successful loading, the config URL is cleared to prevent redundant fetches.
+     *
+     * @private
+     * @remarks
+     * - Only executes if `configFileUrl` is set (typically for testnet)
+     * - Updates testnet-specific asset denoms with their actual deployed addresses
+     * - Populates the router client's pool configurations
+     * - Normalizes struct tags for consistency
+     */
+    private loadConfigFromUrl;
 }
 
-export { AssetPairStruct, type AssetPairStructOutput, AssetPairsResponsePaginatedStruct, type AssetPairsResponsePaginatedStructOutput, AssetPairsResponseStruct, type AssetPairsResponseStructOutput, BaseLiquidityInfoStruct, type BaseLiquidityInfoStructOutput, BaseLiquidityResponseStruct, type BaseLiquidityResponseStructOutput, BcsAddressType, type BcsParsed, type BcsParsedMultiple, BoltSuiClient, GetFeesResponseStruct, type GetFeesResponseStructOutput, GetPoolInfoResponseStruct, type GetPoolInfoResponseStructOutput, MarketResponseStruct, type MarketResponseStructOutput, MarketStruct, type MarketStructOutput, MarketsResponsePaginatedStruct, type MarketsResponsePaginatedStructOutput, MarketsResponseStruct, type MarketsResponseStructOutput, OracleConfigStruct, type OracleConfigStructOutput, PaginationStruct, PriceDataStruct, type PriceDataStructOutput, PriceResponseStruct, type PriceResponseStructOutput, PricesResponsePaginatedStruct, type PricesResponsePaginatedStructOutput, RouterConfigStruct, type RouterConfigStructOutput, type SuiChainConfig, type SuiClientConfig };
+export { AssetPairResponseStruct, type AssetPairResponseStructOutput, AssetPairStruct, type AssetPairStructOutput, AssetPairsResponseStruct, type AssetPairsResponseStructOutput, BaseLiquidityInfoStruct, type BaseLiquidityInfoStructOutput, BaseLiquidityResponseStruct, type BaseLiquidityResponseStructOutput, BcsAddressType, type BcsParsed, type BcsParsedMultiple, BoltSuiClient, MarketResponseStruct, type MarketResponseStructOutput, MarketStruct, type MarketStructOutput, MarketsResponsePaginatedStruct, type MarketsResponsePaginatedStructOutput, MarketsResponseStruct, type MarketsResponseStructOutput, OracleConfigStruct, type OracleConfigStructOutput, PaginationStruct, PoolFeesInfoStruct, type PoolFeesInfoStructOutput, PoolInfoStruct, type PoolInfoStructOutput, PriceDataStruct, type PriceDataStructOutput, PriceResponseStruct, type PriceResponseStructOutput, PricesResponsePaginatedStruct, type PricesResponsePaginatedStructOutput, ProtocolFeesInfoStruct, type ProtocolFeesInfoStructOutput, RawPairStruct, type RawPairStructOutput, RawPriceStruct, type RawPriceStructOutput, RouterConfigStruct, type RouterConfigStructOutput, type SuiChainConfig, type SuiClientConfig, TypeNameStruct, type TypeNameStructOutput };