@bolt-liquidity-hq/cosmwasm-client 0.1.0-beta.10 → 0.1.0-beta.11

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { ArchwayClient, SigningArchwayClient } from '@archwayhq/arch3.js';
-import { ChainConfig, ClientConfig, Address, Duration, AssetPairString, Timestamp, OracleAssetPair, Coin, AllowanceMode, RouterConfig, BaseClient, OracleConfig, InvertiblePrice, Price, BaseLiquidityDetails, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
+import { ChainConfig, ClientConfig, Address, Duration, Timestamp, OracleAssetPair, Coin, AllowanceMode, RouterConfig, BaseClient, OracleConfig, InvertiblePrice, Price, BaseLiquidityDetails, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
 import { CosmWasmClient, SigningCosmWasmClient, ExecuteResult } from '@cosmjs/cosmwasm-stargate';
 import { OfflineSigner } from '@cosmjs/proto-signing';
 
@@ -10,10 +10,16 @@ type CosmWasmChainConfig = ChainConfig & {
 type CosmWasmClientConfig = ClientConfig<CosmWasmChainConfig> & {
     chain?: CosmWasmChain;
     cosmWasmClient?: CosmWasmClient | ArchwayClient;
+    signer?: OfflineSigner;
     signingCosmWasmClient?: SigningCosmWasmClient | SigningArchwayClient;
 };
 type CosmWasmChain = 'archway';
+type SignerWithSigningClient = {
+    signer: OfflineSigner;
+    signingCosmWasmClient: SigningCosmWasmClient | SigningArchwayClient;
+};
 
+type AssetPairString = string;
 type QueryOracleConfigResponse = {
     admin: Address;
     price_threshold_ratio: string;
@@ -94,17 +100,17 @@ type QueryQuotesForUserAllResponse = {
  * const client = new BoltCosmWasmClient();
  *
  * // Query oracle prices
- * const price = await client.getPrice("ARCH", "USDC");
+ * const price = await client.getPrice("aarch", "ibc/...");
  *
  * // Execute a swap (requires signer)
  * const signer = await DirectSecp256k1HdWallet.fromMnemonic("my mnemonic goes here", {
  *  prefix: 'archway',
  * });
- * const result = await client.swap(signer, {
+ * const result = await client.swap({
  *   assetIn: "aarch",
  *   amountIn: "1000000",
  *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D"
- * });
+ * }, signer);
  * ```
  */
 declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult> {
@@ -117,6 +123,11 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * @private
      */
     private _cosmWasmClient?;
+    /**
+     * Cached instance of the Signer for transaction execution
+     * @private
+     */
+    private _signer?;
     /**
      * Cached instance of the signing CosmWasm client for transaction execution
      * @private
@@ -130,12 +141,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * Creates a new instance of the BoltCosmWasmClient.
      *
      * The client automatically configures itself based on the specified chain and environment,
-     * loading the appropriate contract addresses, chain configuration, and assets from configuration files.
+     * loading the appropriate contract addresses, chain configuration, native token denomination,
+     * and assets from configuration files.
      *
      * @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.customOverride - (Optional) Custom overrides for chain configuration, contracts, and assets
+     * @param config.customOverride - (Optional) Custom overrides for chain configuration, contracts, native token, and assets
      * @param config.customOverride.chainConfig - (Optional) Override chain configuration
      * @param config.customOverride.chainConfig.id - (Optional) Custom chain ID
      * @param config.customOverride.chainConfig.name - (Optional) Custom chain name
@@ -144,8 +156,10 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * @param config.customOverride.contracts - (Optional) Override 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.nativeTokenDenom - (Optional) Custom native token denomination (e.g., "aarch")
      * @param config.customOverride.assetsConfig - (Optional) Custom asset configurations indexed by denom
      * @param config.cosmWasmClient - (Optional) Pre-existing CosmWasmClient to use for blockchain queries
+     * @param config.signer - (Optional) Pre-existing OfflineSigner for transaction signing
      * @param config.signingCosmWasmClient - (Optional) Pre-existing SigningCosmWasmClient to use for blockchain transactions
      *
      * @throws {InvalidTypeError} Thrown when an unsupported chain is specified
@@ -173,6 +187,7 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      *       oracle: 'archway1custom_oracle...',
      *       router: 'archway1custom_router...'
      *     },
+     *     nativeTokenDenom: 'aarch',
      *     assetsConfig: {
      *       'aarch': {
      *         symbol: 'ARCH',
@@ -190,6 +205,7 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * // Use pre-existing CosmWasm clients
      * const clientWithCustomClients = new BoltCosmWasmClient({
      *   cosmWasmClient: myCosmWasmClient,
+     *   signer: mySigner,
      *   signingCosmWasmClient: mySigningClient
      * });
      * ```
@@ -213,18 +229,18 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      */
     getCosmWasmClient(): Promise<CosmWasmClient | ArchwayClient>;
     /**
-     * Gets or creates a signing CosmWasm client instance for transaction execution.
+     * Gets or creates a signing CosmWasm client instance along with the signer for transaction execution.
      *
-     * This method implements lazy initialization and caching of the signing client.
+     * This method implements lazy initialization and caching of both the signing client and signer.
      * A signer must be provided either on first call or to replace the cached instance.
      * The appropriate client type is selected based on the configured chain.
      *
-     * @param signer - Optional offline signer for transaction signing. Required on first call
-     *                 or to replace the existing signer
+     * @param newSigner - Optional offline signer for transaction signing. Required on first call
+     *                    or to replace the existing signer
      *
-     * @returns A promise that resolves to the signing CosmWasm client instance
+     * @returns A promise that resolves to an object containing both the signer and signing client
      *
-     * @throws {MissingParameterError} Thrown when no signer is provided and no cached client exists
+     * @throws {MissingParameterError} Thrown when no signer is provided and no cached signer exists
      *
      * @example
      * ```typescript
@@ -232,13 +248,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * const signer = await DirectSecp256k1HdWallet.fromMnemonic("my mnemonic goes here", {
      *  prefix: 'archway',
      * });
-     * const signingClient = await boltClient.getSigningCosmWasmClient(signer);
+     * const { signer: cachedSigner, signingCosmWasmClient } = await boltClient.getSignerWithSigningClient(signer);
      *
-     * // Subsequent calls can reuse the cached client
-     * const cachedClient = await boltClient.getSigningCosmWasmClient();
+     * // Subsequent calls can reuse the cached signer and client
+     * const { signer, signingCosmWasmClient: client } = await boltClient.getSignerWithSigningClient();
      * ```
      */
-    getSigningCosmWasmClient(signer?: OfflineSigner): Promise<SigningCosmWasmClient | SigningArchwayClient>;
+    getSignerWithSigningClient(newSigner?: OfflineSigner): Promise<SignerWithSigningClient>;
     /** @inheritdoc */
     getOracleConfig(): Promise<OracleConfig>;
     /** @inheritdoc */
@@ -272,13 +288,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * const signer = await window.keplr.getOfflineSignerAuto(chainId);
      *
      * // Execute swap: 1 ARCH for USDC
-     * const result = await client.swap(signer, {
+     * const result = await client.swap({
      *   assetIn: "aarch",
      *   amountIn: "1000000000000000000", // 1 ARCH (18 decimals)
      *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D", // USDC IBC denom
      *   minimumAmountOut: "1950000000", // Minimum 1950 USDC expected
      *   receiver: "archway1..." // Optional custom receiver
-     * });
+     * }, signer);
      *
      * console.log(`Swap successful!`);
      * console.log(`Transaction hash: ${result.txHash}`);
@@ -291,7 +307,35 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * This implementation returns a CosmWasm ExecuteResult as the transaction output,
      * which includes details like gas used, block height, transaction hash, and events.
      */
-    swap(signer: OfflineSigner, params: SwapParams): Promise<SwapResult<ExecuteResult>>;
+    swap(params: SwapParams, signer?: OfflineSigner): Promise<SwapResult<ExecuteResult>>;
+    /**
+     * @inheritdoc
+     *
+     * @example
+     * ```typescript
+     * // Get signer (e.g., from Keplr wallet)
+     * const signer = await window.keplr.getOfflineSignerAuto(chainId);
+     *
+     * // Estimate gas for swapping 1 ARCH to USDC
+     * const gasEstimate = await client.estimateSwapGasFees({
+     *   assetIn: "aarch",
+     *   amountIn: "1000000000000000000", // 1 ARCH
+     *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D", // USDC
+     *   minimumAmountOut: "1950000000" // Min 1950 USDC
+     * }, signer, 1.3); // 30% safety margin
+     *
+     * if (gasEstimate) {
+     *   console.log(`Estimated gas: ${gasEstimate.amount} ${gasEstimate.denom}`);
+     * }
+     * ```
+     *
+     * @remarks
+     * - For CosmWasm chains, gas is always paid in the native token (e.g., "aarch" for Archway)
+     * - The returned amount is in the smallest denomination (6 decimals for most Cosmos chains)
+     * - Gas estimation uses CosmWasm's simulation capabilities
+     * - The gasAdjustment parameter helps account for variations in actual execution
+     */
+    estimateSwapGasFees(params: SwapParams, signer: OfflineSigner, gasAdjustment?: number): Promise<Coin | undefined>;
 }
 
-export { BoltCosmWasmClient, type CosmWasmChain, type CosmWasmChainConfig, type CosmWasmClientConfig, type CosmWasmRouterConfig, type InvertiblePriceRepresentation, type MarketRepresentation, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryBaseLiquidityResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type QuerySettlementConfigResponse };
+export { type AssetPairString, BoltCosmWasmClient, type CosmWasmChain, type CosmWasmChainConfig, type CosmWasmClientConfig, type CosmWasmRouterConfig, type InvertiblePriceRepresentation, type MarketRepresentation, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryBaseLiquidityResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type QuerySettlementConfigResponse, type SignerWithSigningClient };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ArchwayClient, SigningArchwayClient } from '@archwayhq/arch3.js';
-import { ChainConfig, ClientConfig, Address, Duration, AssetPairString, Timestamp, OracleAssetPair, Coin, AllowanceMode, RouterConfig, BaseClient, OracleConfig, InvertiblePrice, Price, BaseLiquidityDetails, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
+import { ChainConfig, ClientConfig, Address, Duration, Timestamp, OracleAssetPair, Coin, AllowanceMode, RouterConfig, BaseClient, OracleConfig, InvertiblePrice, Price, BaseLiquidityDetails, Pool, PoolConfig, Asset, SwapParams, SwapResult } from '@bolt-liquidity-hq/core';
 import { CosmWasmClient, SigningCosmWasmClient, ExecuteResult } from '@cosmjs/cosmwasm-stargate';
 import { OfflineSigner } from '@cosmjs/proto-signing';
 
@@ -10,10 +10,16 @@ type CosmWasmChainConfig = ChainConfig & {
 type CosmWasmClientConfig = ClientConfig<CosmWasmChainConfig> & {
     chain?: CosmWasmChain;
     cosmWasmClient?: CosmWasmClient | ArchwayClient;
+    signer?: OfflineSigner;
     signingCosmWasmClient?: SigningCosmWasmClient | SigningArchwayClient;
 };
 type CosmWasmChain = 'archway';
+type SignerWithSigningClient = {
+    signer: OfflineSigner;
+    signingCosmWasmClient: SigningCosmWasmClient | SigningArchwayClient;
+};
 
+type AssetPairString = string;
 type QueryOracleConfigResponse = {
     admin: Address;
     price_threshold_ratio: string;
@@ -94,17 +100,17 @@ type QueryQuotesForUserAllResponse = {
  * const client = new BoltCosmWasmClient();
  *
  * // Query oracle prices
- * const price = await client.getPrice("ARCH", "USDC");
+ * const price = await client.getPrice("aarch", "ibc/...");
  *
  * // Execute a swap (requires signer)
  * const signer = await DirectSecp256k1HdWallet.fromMnemonic("my mnemonic goes here", {
  *  prefix: 'archway',
  * });
- * const result = await client.swap(signer, {
+ * const result = await client.swap({
  *   assetIn: "aarch",
  *   amountIn: "1000000",
  *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D"
- * });
+ * }, signer);
  * ```
  */
 declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult> {
@@ -117,6 +123,11 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * @private
      */
     private _cosmWasmClient?;
+    /**
+     * Cached instance of the Signer for transaction execution
+     * @private
+     */
+    private _signer?;
     /**
      * Cached instance of the signing CosmWasm client for transaction execution
      * @private
@@ -130,12 +141,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * Creates a new instance of the BoltCosmWasmClient.
      *
      * The client automatically configures itself based on the specified chain and environment,
-     * loading the appropriate contract addresses, chain configuration, and assets from configuration files.
+     * loading the appropriate contract addresses, chain configuration, native token denomination,
+     * and assets from configuration files.
      *
      * @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.customOverride - (Optional) Custom overrides for chain configuration, contracts, and assets
+     * @param config.customOverride - (Optional) Custom overrides for chain configuration, contracts, native token, and assets
      * @param config.customOverride.chainConfig - (Optional) Override chain configuration
      * @param config.customOverride.chainConfig.id - (Optional) Custom chain ID
      * @param config.customOverride.chainConfig.name - (Optional) Custom chain name
@@ -144,8 +156,10 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * @param config.customOverride.contracts - (Optional) Override 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.nativeTokenDenom - (Optional) Custom native token denomination (e.g., "aarch")
      * @param config.customOverride.assetsConfig - (Optional) Custom asset configurations indexed by denom
      * @param config.cosmWasmClient - (Optional) Pre-existing CosmWasmClient to use for blockchain queries
+     * @param config.signer - (Optional) Pre-existing OfflineSigner for transaction signing
      * @param config.signingCosmWasmClient - (Optional) Pre-existing SigningCosmWasmClient to use for blockchain transactions
      *
      * @throws {InvalidTypeError} Thrown when an unsupported chain is specified
@@ -173,6 +187,7 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      *       oracle: 'archway1custom_oracle...',
      *       router: 'archway1custom_router...'
      *     },
+     *     nativeTokenDenom: 'aarch',
      *     assetsConfig: {
      *       'aarch': {
      *         symbol: 'ARCH',
@@ -190,6 +205,7 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * // Use pre-existing CosmWasm clients
      * const clientWithCustomClients = new BoltCosmWasmClient({
      *   cosmWasmClient: myCosmWasmClient,
+     *   signer: mySigner,
      *   signingCosmWasmClient: mySigningClient
      * });
      * ```
@@ -213,18 +229,18 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      */
     getCosmWasmClient(): Promise<CosmWasmClient | ArchwayClient>;
     /**
-     * Gets or creates a signing CosmWasm client instance for transaction execution.
+     * Gets or creates a signing CosmWasm client instance along with the signer for transaction execution.
      *
-     * This method implements lazy initialization and caching of the signing client.
+     * This method implements lazy initialization and caching of both the signing client and signer.
      * A signer must be provided either on first call or to replace the cached instance.
      * The appropriate client type is selected based on the configured chain.
      *
-     * @param signer - Optional offline signer for transaction signing. Required on first call
-     *                 or to replace the existing signer
+     * @param newSigner - Optional offline signer for transaction signing. Required on first call
+     *                    or to replace the existing signer
      *
-     * @returns A promise that resolves to the signing CosmWasm client instance
+     * @returns A promise that resolves to an object containing both the signer and signing client
      *
-     * @throws {MissingParameterError} Thrown when no signer is provided and no cached client exists
+     * @throws {MissingParameterError} Thrown when no signer is provided and no cached signer exists
      *
      * @example
      * ```typescript
@@ -232,13 +248,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * const signer = await DirectSecp256k1HdWallet.fromMnemonic("my mnemonic goes here", {
      *  prefix: 'archway',
      * });
-     * const signingClient = await boltClient.getSigningCosmWasmClient(signer);
+     * const { signer: cachedSigner, signingCosmWasmClient } = await boltClient.getSignerWithSigningClient(signer);
      *
-     * // Subsequent calls can reuse the cached client
-     * const cachedClient = await boltClient.getSigningCosmWasmClient();
+     * // Subsequent calls can reuse the cached signer and client
+     * const { signer, signingCosmWasmClient: client } = await boltClient.getSignerWithSigningClient();
      * ```
      */
-    getSigningCosmWasmClient(signer?: OfflineSigner): Promise<SigningCosmWasmClient | SigningArchwayClient>;
+    getSignerWithSigningClient(newSigner?: OfflineSigner): Promise<SignerWithSigningClient>;
     /** @inheritdoc */
     getOracleConfig(): Promise<OracleConfig>;
     /** @inheritdoc */
@@ -272,13 +288,13 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * const signer = await window.keplr.getOfflineSignerAuto(chainId);
      *
      * // Execute swap: 1 ARCH for USDC
-     * const result = await client.swap(signer, {
+     * const result = await client.swap({
      *   assetIn: "aarch",
      *   amountIn: "1000000000000000000", // 1 ARCH (18 decimals)
      *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D", // USDC IBC denom
      *   minimumAmountOut: "1950000000", // Minimum 1950 USDC expected
      *   receiver: "archway1..." // Optional custom receiver
-     * });
+     * }, signer);
      *
      * console.log(`Swap successful!`);
      * console.log(`Transaction hash: ${result.txHash}`);
@@ -291,7 +307,35 @@ declare class BoltCosmWasmClient extends BaseClient<OfflineSigner, ExecuteResult
      * This implementation returns a CosmWasm ExecuteResult as the transaction output,
      * which includes details like gas used, block height, transaction hash, and events.
      */
-    swap(signer: OfflineSigner, params: SwapParams): Promise<SwapResult<ExecuteResult>>;
+    swap(params: SwapParams, signer?: OfflineSigner): Promise<SwapResult<ExecuteResult>>;
+    /**
+     * @inheritdoc
+     *
+     * @example
+     * ```typescript
+     * // Get signer (e.g., from Keplr wallet)
+     * const signer = await window.keplr.getOfflineSignerAuto(chainId);
+     *
+     * // Estimate gas for swapping 1 ARCH to USDC
+     * const gasEstimate = await client.estimateSwapGasFees({
+     *   assetIn: "aarch",
+     *   amountIn: "1000000000000000000", // 1 ARCH
+     *   assetOut: "ibc/43897B9739BD63E3A08A88191999C632E052724AB96BD4C74AE31375C991F48D", // USDC
+     *   minimumAmountOut: "1950000000" // Min 1950 USDC
+     * }, signer, 1.3); // 30% safety margin
+     *
+     * if (gasEstimate) {
+     *   console.log(`Estimated gas: ${gasEstimate.amount} ${gasEstimate.denom}`);
+     * }
+     * ```
+     *
+     * @remarks
+     * - For CosmWasm chains, gas is always paid in the native token (e.g., "aarch" for Archway)
+     * - The returned amount is in the smallest denomination (6 decimals for most Cosmos chains)
+     * - Gas estimation uses CosmWasm's simulation capabilities
+     * - The gasAdjustment parameter helps account for variations in actual execution
+     */
+    estimateSwapGasFees(params: SwapParams, signer: OfflineSigner, gasAdjustment?: number): Promise<Coin | undefined>;
 }
 
-export { BoltCosmWasmClient, type CosmWasmChain, type CosmWasmChainConfig, type CosmWasmClientConfig, type CosmWasmRouterConfig, type InvertiblePriceRepresentation, type MarketRepresentation, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryBaseLiquidityResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type QuerySettlementConfigResponse };
+export { type AssetPairString, BoltCosmWasmClient, type CosmWasmChain, type CosmWasmChainConfig, type CosmWasmClientConfig, type CosmWasmRouterConfig, type InvertiblePriceRepresentation, type MarketRepresentation, type PriceRepresentation, type QueryAssetPairsResponse, type QueryBaseLiquidityAllResponse, type QueryBaseLiquidityResponse, type QueryMarketsResponse, type QueryOracleConfigResponse, type QueryPriceResponse, type QueryPricesResponse, type QueryQuotesForUserAllResponse, type QueryRouterConfigResponse, type QuerySettlementConfigResponse, type SignerWithSigningClient };