@bolt-liquidity-hq/cosmwasm-client 0.1.0-beta.2 → 0.1.0-beta.4

package/dist/index.d.cts

@@ -17,7 +17,7 @@ import { OfflineSigner } from '@cosmjs/proto-signing';
  * import { BoltSdkErrorCode, BoltSdkError } from '@bolt-liquidity-hq/cosmwasm-client';
  *
  * try {
- *   await client.swapExactIn(signer, params);
+ *   await client.swap(signer, params);
  * } catch (error) {
  *   if (error instanceof BoltSdkError) {
  *     switch (error.code) {
@@ -270,76 +270,94 @@ declare enum Environment {
 type Address = string;
 type AssetPairString = string;
 type Timestamp = string;
-interface Duration {
-    secs: string;
+type Duration = {
+    secs: number;
     nanos: number;
-}
-interface Coin {
+};
+type Coin = {
     denom: string;
     amount: string;
-}
+};
 
-interface ClientConfig {
+type ClientConfig = {
     environment?: Environment;
-    override?: {
+    customOverride?: {
         rpcEndpoint?: string;
         contracts?: Partial<Contracts>;
     };
-}
-interface Contracts {
+};
+type Contracts = {
     oracle: Address;
     router: Address;
-}
+};
 
-interface OracleConfig {
+type OracleConfig = {
     admin: Address;
     priceThresholdRatio: string;
     priceExpireTime: Duration | null;
-}
-interface Price {
+};
+type Price = {
     assetPair: AssetPairString;
     price: string;
     expiryTime: Timestamp;
-}
-interface InvertiblePrice extends Price {
+};
+type InvertiblePrice = Price & {
     isInverse: boolean;
-}
-interface OracleAsset {
+};
+type OracleAsset = {
     name: string;
     symbol: string;
     precision: number;
-}
-interface OracleAssetPair {
+};
+type OracleAssetPair = {
     base: OracleAsset;
     quote: OracleAsset;
-}
+};
+
+declare enum AllowanceMode {
+    Allow = "allow",
+    Disallow = "disallow"
+}
+type PoolConfig = {
+    priceOracleContract: Address;
+    protocolFeeRecipient: Address;
+    protocolFee: string;
+    lpFee: string;
+    allowanceMode: AllowanceMode;
+    lps: Address[];
+    minBaseOut: string;
+};
+type BaseLiquidityDetails = {
+    baseLiquidity: Coin;
+    totalShares: string;
+};
 
-interface RouterConfig {
+type RouterConfig = {
     admin: Address;
     defaultPriceOracleContract: Address;
     defaultProtocolFeeRecipient: Address;
     defaultProtocolFee: string;
     defaultLpFee: string;
     settlementCodeId: number;
-}
-interface Pool {
+};
+type Pool = {
     poolAddress: Address;
     baseAssetSymbol: string;
     quoteAssetsSymbols: string[];
-}
-interface SwapParams {
+};
+type SwapParams = {
     assetIn: string;
     amountIn: string;
     assetOut: string;
     minimumAmountOut?: string;
     receiver?: Address;
-}
-interface SwapResult<TTxOutput = unknown> {
+};
+type SwapResult<TTxOutput = unknown> = {
     txOutput: TTxOutput;
     amountOut: string;
     assetOut: string;
     txHash: string;
-}
+};
 
 /**
  * Abstract base client for all implementations of the Bolt SDK for different chains/networks.
@@ -368,12 +386,12 @@ declare abstract class BaseClient<TSigner = unknown> {
     /**
      * Creates a new instance of the BaseClient.
      *
-     * @param config - Optional configuration object for the client
-     * @param config.override - Override configuration for RPC endpoint and contract addresses
-     * @param config.override.rpcEndpoint - The RPC endpoint URL for the blockchain network
-     * @param config.override.contracts - Contract addresses for oracle and router
-     * @param config.override.contracts.oracle - Address of the price oracle contract
-     * @param config.override.contracts.router - Address of the swap router contract
+     * @param config - (Optional) Configuration object for the client
+     * @param config.customOverride - (Optional) Override configuration for RPC endpoint and contract addresses
+     * @param config.customOverride.rpcEndpoint - (Optional) Custom RPC endpoint URL for the blockchain network
+     * @param config.customOverride.contracts - (Optional) Custom contract addresses
+     * @param config.customOverride.contracts.oracle - (Optional) Custom oracle contract address
+     * @param config.customOverride.contracts.router - (Optional) Custom router contract address
      *
      * @throws {InvalidObjectError} Thrown when required configuration fields are missing
      *
@@ -472,17 +490,20 @@ declare abstract class BaseClient<TSigner = unknown> {
      * Fetches the total liquidity for all base assets across all pools.
      *
      * @returns A promise that resolves to a record mapping pool addresses
-     *          to their respective base asset liquidity amounts
+     *          to their respective base asset liquidity details, including
+     *          the base liquidity amount and total shares
      *
      * @example
      * ```typescript
      * const liquidity = await client.getAllBaseAssetsLiquidity();
-     * Object.entries(liquidity).forEach(([poolAddress, coin]) => {
-     *   console.log(`Pool ${poolAddress}: ${coin.amount} ${coin.denom}`);
+     * Object.entries(liquidity).forEach(([poolAddress, details]) => {
+     *   console.log(`Pool ${poolAddress}:`);
+     *   console.log(`  Base: ${details.baseLiquidity.amount} ${details.baseLiquidity.denom}`);
+     *   console.log(`  Total Shares: ${details.totalShares}`);
      * });
      * ```
      */
-    abstract getAllBaseAssetsLiquidity(): Promise<Record<Address, Coin>>;
+    abstract getAllBaseAssetsLiquidity(): Promise<Record<Address, BaseLiquidityDetails>>;
     /**
      * Fetches all withdrawable quote assets for a specific user or liquidity provider.
      *
@@ -527,6 +548,8 @@ declare abstract class BaseClient<TSigner = unknown> {
      *
      * @returns A promise that resolves to an array containing all pool information
      *
+     * @throws Will throw an error if no pool exists for the specified base asset
+     *
      * @example
      * ```typescript
      * const pools = await client.getAllPools();
@@ -539,9 +562,58 @@ declare abstract class BaseClient<TSigner = unknown> {
      */
     abstract getAllPools(): Promise<Pool[]>;
     /**
-     * Executes a "swap exact in" operation on the blockchain from one asset to another.
+     * Fetches the configuration settings for a specific liquidity pool.
+     *
+     * This method retrieves detailed configuration parameters for a pool, including
+     * fee structures, oracle settings, liquidity provider information, and trading limits.
+     *
+     * @param poolContractAddress - The blockchain address of the pool contract
+     *
+     * @returns A promise that resolves to a pool configuration object
+     *          containing settings such as fees, oracle address, LP addresses, and minimum trade amounts
+     *
+     * @example
+     * ```typescript
+     * const poolConfig = await client.getPoolConfig("archway1pool...");
+     * console.log(`Oracle: ${poolConfig.priceOracleContract}`);
+     * console.log(`Protocol fee: ${poolConfig.protocolFee * 100}%`);
+     * console.log(`LP fee: ${poolConfig.lpFee * 100}%`);
+     * console.log(`Allowance mode: ${poolConfig.allowanceMode}`);
+     * console.log(`LPs: ${poolConfig.lps.join(', ')}`);
+     * console.log(`Min base output: ${poolConfig.minBaseOut}`);
+     * ```
+     */
+    abstract getPoolConfig(poolContractAddress: string): Promise<PoolConfig>;
+    /**
+     * Fetches the configuration settings for a pool identified by its base asset symbol.
+     *
+     * This method retrieves the pool configuration by first looking up the pool
+     * associated with the given base asset, then fetching its configuration parameters.
+     *
+     * @param baseAssetSymbol - The symbol of the base asset (e.g., "aarch", "ibc/...")
+     *
+     * @returns A promise that resolves to a pool configuration object containing
+     *          settings such as fees, oracle address, LP addresses, and minimum trade amounts
+     *
+     * @throws Will throw an error if no pool exists for the specified base asset
+     *
+     * @example
+     * ```typescript
+     * // Get pool configuration for ARCH base asset
+     * const poolConfig = await client.getPoolConfigByBaseAsset("aarch");
+     * console.log(`Oracle: ${poolConfig.priceOracleContract}`);
+     * console.log(`Protocol fee: ${poolConfig.protocolFee * 100}%`);
+     * console.log(`LP fee: ${poolConfig.lpFee * 100}%`);
+     * console.log(`Allowance mode: ${poolConfig.allowanceMode}`);
+     * console.log(`Number of LPs: ${poolConfig.lps.length}`);
+     * console.log(`Min base output: ${poolConfig.minBaseOut}`);
+     * ```
+     */
+    abstract getPoolConfigByBaseAsset(baseAssetSymbol: string): Promise<PoolConfig>;
+    /**
+     * Executes a swap operation on the blockchain from one asset to another.
      *
-     * This method performs a swap where the exact input amount is specified, and the output
+     * This method performs a "swap exact in" where the exact input amount is specified, and the output
      * amount varies based on current pool conditions and fees. The transaction includes
      * slippage protection through the optional minimumAmountOut parameter.
      *
@@ -565,7 +637,7 @@ declare abstract class BaseClient<TSigner = unknown> {
      * @example
      * ```typescript
      * // Swap exactly 1 ARCH for USDC (output amount varies)
-     * const result = await client.swapExactIn(signer, {
+     * const result = await client.swap(signer, {
      *   assetIn: "aarch",
      *   amountIn: "1000000000000000000", // Exactly 1 ARCH (18 decimals)
      *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D", // USDC IBC denom
@@ -585,61 +657,77 @@ declare abstract class BaseClient<TSigner = unknown> {
      * - Fees are deducted from the output
      * - Use minimumAmountOut to protect against excessive slippage
      */
-    abstract swapExactIn(signer: TSigner, params: SwapParams): Promise<SwapResult>;
+    abstract swap(signer: TSigner, params: SwapParams): Promise<SwapResult>;
 }
 
-interface CosmWasmClientConfig extends ClientConfig {
+type CosmWasmClientConfig = ClientConfig & {
     chain?: CosmWasmChain;
-}
+    cosmWasmClient?: CosmWasmClient | ArchwayClient;
+    signingCosmWasmClient?: SigningCosmWasmClient | SigningArchwayClient;
+};
 declare enum CosmWasmChain {
     Archway = "archway"
 }
 
-interface QueryOracleConfigResponse {
+type QueryOracleConfigResponse = {
     admin: Address;
     price_threshold_ratio: string;
     price_expire_time: Duration | null;
-}
-interface PriceRepresentation {
+};
+type PriceRepresentation = {
     asset_pair: AssetPairString;
     price: string;
     expiry_time: Timestamp;
-}
-interface InvertiblePriceRepresentation extends PriceRepresentation {
+};
+type InvertiblePriceRepresentation = PriceRepresentation & {
     is_inverse: boolean;
-}
-interface QueryPriceResponse {
+};
+type QueryPriceResponse = {
     pair_data: InvertiblePriceRepresentation;
-}
-interface QueryPricesResponse {
+};
+type QueryPricesResponse = {
     prices: PriceRepresentation[];
-}
-interface QueryAssetPairsResponse {
+};
+type QueryAssetPairsResponse = {
     list: OracleAssetPair[];
-}
+};
+
+type QuerySettlementConfigResponse = {
+    price_oracle_contract: Address;
+    protocol_fee_recipient: Address;
+    protocol_fee: string;
+    lp_fee: string;
+    allowance_mode: AllowanceMode;
+    lps: Address[];
+    min_base_out: string;
+};
+type QueryBaseLiquidityResponse = {
+    base_liquidity: Coin;
+    total_shares: string;
+};
 
-interface QueryRouterConfigResponse {
+type QueryRouterConfigResponse = {
     admin: Address;
     default_price_oracle_contract: Address;
     default_protocol_fee_recipient: Address;
     default_protocol_fee: string;
     default_lp_fee: string;
     settlement_code_id: number;
-}
-interface MarketRepresentation {
+};
+type MarketRepresentation = {
     market_address: Address;
     base_asset_symbol: string;
     quote_assets_symbols: string[];
-}
-interface QueryMarketsResponse {
+};
+type QueryMarketsResponse = {
     markets: MarketRepresentation[];
-}
-interface QueryBaseLiquidityAllResponse {
-    liquidity: Record<Address, Coin>;
-}
-interface QueryQuotesForUserAllResponse {
+};
+type QueryBaseLiquidityAllResponse = {
+    liquidity: Record<Address, QueryBaseLiquidityResponse>;
+};
+type QueryQuotesForUserAllResponse = {
     quotes: Record<Address, Coin[]>;
-}
+};
 
 /**
  * Client implementation for interacting with the Bolt Liquidity Outpost on CosmWasm-based blockchains.
@@ -697,11 +785,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner> {
      * @param config - (Optional) Configuration for the client
      * @param config.environment - (Optional) The deployment environment (Mainnet or Testnet). Defaults to Mainnet
      * @param config.chain - (Optional) The specific CosmWasm chain to connect to. Defaults to Archway
-     * @param config.override - (Optional) Overrides for RPC endpoint and contract addresses
-     * @param config.override.rpcEndpoint - (Optional) Custom RPC endpoint URL
-     * @param config.override.contracts - (Optional) Custom contract addresses
-     * @param config.override.contracts.oracle - (Optional) Custom oracle contract address
-     * @param config.override.contracts.router - (Optional) Custom router contract address
+     * @param config.customOverride - (Optional) Overrides for RPC endpoint and contract addresses
+     * @param config.customOverride.rpcEndpoint - (Optional) Custom RPC endpoint URL
+     * @param config.customOverride.contracts - (Optional) Custom contract addresses
+     * @param config.customOverride.contracts.oracle - (Optional) Custom oracle contract address
+     * @param config.customOverride.contracts.router - (Optional) Custom router contract address
+     * @param config.customOverride.cosmWasmClient - (Optional) Custom CosmWasmClient to use for blockchain queries
+     * @param config.customOverride.signingCosmWasmClient - (Optional) Custom SigningCosmWasmClient to use for blockchain transactions
      *
      * @throws {InvalidTypeError} Thrown when an unsupported chain is specified
      *
@@ -779,13 +869,17 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner> {
     /** @inheritdoc */
     getRouterConfig(): Promise<RouterConfig>;
     /** @inheritdoc */
-    getAllBaseAssetsLiquidity(): Promise<Record<Address, Coin>>;
+    getAllBaseAssetsLiquidity(): Promise<Record<Address, BaseLiquidityDetails>>;
     /** @inheritdoc */
     getAllQuotesByUser(address: Address): Promise<Record<Address, Coin[]>>;
     /** @inheritdoc */
     getPoolByBaseAsset(baseAssetSymbol: string): Promise<Pool>;
     /** @inheritdoc */
     getAllPools(): Promise<Pool[]>;
+    /** @inheritdoc */
+    getPoolConfig(poolContractAddress: Address): Promise<PoolConfig>;
+    /** @inheritdoc */
+    getPoolConfigByBaseAsset(baseAssetSymbol: string): Promise<PoolConfig>;
     /**
      * @inheritdoc
      *
@@ -809,7 +903,7 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner> {
      * console.log(`Gas used: ${result.gasUsed}`);
      * ```
      */
-    swapExactIn(signer: OfflineSigner, params: SwapParams): Promise<SwapResult<ExecuteResult>>;
+    swap(signer: OfflineSigner, params: SwapParams): Promise<SwapResult<ExecuteResult>>;
 }
 
-export { type Address, type AssetPairString, BoltCosmWasmClient, type BoltSdkError, BoltSdkErrorBase, BoltSdkErrorCode, type ClientConfig, type Coin, type Contracts, CosmWasmChain, type CosmWasmClientConfig, type Duration, Environment, InsufficientFundsError, InvalidAddressError, InvalidObjectError, InvalidParameterError, InvalidTypeError, type InvertiblePrice, type InvertiblePriceRepresentation, type MarketRepresentation, MissingParameterError, NetworkError, NotFoundError, type OracleAsset, type OracleAssetPair, type OracleConfig, ParameterOutOfRangeError, type Pool, type Price, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type RouterConfig, type SwapParams, type SwapResult, type Timestamp, TransactionEventNotFoundError, TransactionFailedError };
+export { type Address, AllowanceMode, type AssetPairString, BaseClient, type BaseLiquidityDetails, BoltCosmWasmClient, type BoltSdkError, BoltSdkErrorBase, BoltSdkErrorCode, type ClientConfig, type Coin, type Contracts, CosmWasmChain, type CosmWasmClientConfig, type Duration, Environment, InsufficientFundsError, InvalidAddressError, InvalidObjectError, InvalidParameterError, InvalidTypeError, type InvertiblePrice, type InvertiblePriceRepresentation, type MarketRepresentation, MissingParameterError, NetworkError, NotFoundError, type OracleAsset, type OracleAssetPair, type OracleConfig, ParameterOutOfRangeError, type Pool, type PoolConfig, type Price, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryBaseLiquidityResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type QuerySettlementConfigResponse, type RouterConfig, type SwapParams, type SwapResult, type Timestamp, TransactionEventNotFoundError, TransactionFailedError };