@cheqd/sdk-esm 5.3.7-develop.1 → 5.4.0-develop.1

package/build/types/cjs/src/modules/feemarket.d.ts

@@ -0,0 +1,244 @@
+import { GasPriceResponse, GasPricesResponse, ParamsResponse } from '@cheqd/ts-proto-cjs/feemarket/feemarket/v1/index.js';
+import { EncodeObject, GeneratedType } from '@cosmjs/proto-signing-cjs';
+import { GasPrice, QueryClient } from '@cosmjs/stargate-cjs';
+import { AbstractCheqdSDKModule, MinimalImportableCheqdSDKModule } from './_';
+import { DidStdFee, IContext, QueryExtensionSetup } from '../types';
+import { CheqdQuerier } from '../querier';
+import { CheqdSigningStargateClient } from '../signer';
+/** Default extension key for fee market-related query operations */
+export declare const defaultFeemarketExtensionKey: "feemarket";
+/**
+ * Protobuf message type literals for fee market operations.
+ * Used for consistent message type identification across the module.
+ */
+export declare const protobufLiterals: {
+    /** Gas price response message type */
+    readonly GasPriceResponse: "GasPriceResponse";
+    /** Gas prices response message type */
+    readonly GasPricesResponse: "GasPricesResponse";
+    /** Parameters response message type */
+    readonly ParamsResponse: "ParamsResponse";
+};
+/** Type URL for GasPriceResponse messages */
+export declare const typeUrlGasPriceResponse: "/feemarket.feemarket.v1.GasPriceResponse";
+/** Type URL for GasPricesResponse messages */
+export declare const typeUrlGasPricesResponse: "/feemarket.feemarket.v1.GasPricesResponse";
+/** Type URL for ParamsResponse messages */
+export declare const typeUrlParamsResponse: "/feemarket.feemarket.v1.ParamsResponse";
+/**
+ * Default gas price tier names for fee calculation.
+ * Provides predefined tiers for different transaction priority levels.
+ */
+export declare const defaultGasPriceTiers: {
+    /** Low priority tier with lowest gas prices */
+    readonly Low: "DefaultLowTier";
+    /** Average priority tier with moderate gas prices */
+    readonly Avg: "DefaultAvgTier";
+    /** High priority tier with highest gas prices */
+    readonly High: "DefaultHighTier";
+};
+/** Type representing the available default gas price tiers */
+/** Type representing the available default gas price tiers */
+export type DefaultGasPriceTiers = (typeof defaultGasPriceTiers)[keyof typeof defaultGasPriceTiers];
+/**
+ * Encode object interface for GasPriceResponse messages.
+ * Used for type-safe message encoding in gas price operations.
+ */
+export interface GasPriceEncodeObject extends EncodeObject {
+    readonly typeUrl: typeof typeUrlGasPriceResponse;
+    readonly value: Partial<GasPriceResponse>;
+}
+/**
+ * Type guard function to check if an object is a GasPriceEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a GasPriceEncodeObject
+ */
+export declare function isGasPriceEncodeObject(obj: EncodeObject): obj is GasPriceEncodeObject;
+/**
+ * Encode object interface for GasPricesResponse messages.
+ * Used for type-safe message encoding in gas prices query operations.
+ */
+export interface GasPricesEncodeObject extends EncodeObject {
+    readonly typeUrl: typeof typeUrlGasPricesResponse;
+    readonly value: Partial<GasPricesResponse>;
+}
+/**
+ * Type guard function to check if an object is a GasPricesEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a GasPricesEncodeObject
+ */
+export declare function isGasPricesEncodeObject(obj: EncodeObject): obj is GasPricesEncodeObject;
+/**
+ * Encode object interface for ParamsResponse messages.
+ * Used for type-safe message encoding in parameter query operations.
+ */
+export interface ParamsEncodeObject extends EncodeObject {
+    readonly typeUrl: typeof typeUrlParamsResponse;
+    readonly value: Partial<ParamsResponse>;
+}
+/**
+ * Type guard function to check if an object is a ParamsEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a ParamsEncodeObject
+ */
+export declare function isParamsEncodeObject(obj: EncodeObject): obj is ParamsEncodeObject;
+/** Minimal importable version of the fee market module for clean external interfaces */
+export type MinimalImportableFeemarketModule = MinimalImportableCheqdSDKModule<FeemarketModule>;
+/**
+ * Fee market extension interface for querier functionality.
+ * Provides methods for querying gas prices and fee market parameters.
+ */
+export type FeemarketExtension = {
+    readonly [defaultFeemarketExtensionKey]: {
+        /** Query gas price for a specific denomination */
+        readonly gasPrice: (denom: string) => Promise<GasPriceResponse>;
+        /** Query all available gas prices */
+        readonly gasPrices: () => Promise<GasPricesResponse>;
+        /** Query fee market module parameters */
+        readonly params: () => Promise<ParamsResponse>;
+    };
+};
+/**
+ * Sets up the fee market extension for the querier client.
+ * Creates and configures the fee market-specific query methods.
+ *
+ * @param base - Base QueryClient to extend
+ * @returns Configured fee market extension with query methods
+ */
+export declare const setupFeemarketExtension: (base: QueryClient) => FeemarketExtension;
+/**
+ * Fee Market Module class providing comprehensive fee market functionality.
+ * Handles gas price queries, dynamic fee calculation, and fee market parameter management.
+ */
+export declare class FeemarketModule extends AbstractCheqdSDKModule {
+    static readonly registryTypes: Iterable<[string, GeneratedType]>;
+    /**
+     * Default gas prices for different priority tiers.
+     * Used as fallback when live gas price queries are unavailable.
+     */
+    static readonly defaultGasPrices: {
+        DefaultLowTier: {
+            amount: string;
+            denom: string;
+        };
+        DefaultAvgTier: {
+            amount: string;
+            denom: string;
+        };
+        DefaultHighTier: {
+            amount: string;
+            denom: string;
+        };
+    };
+    /** Gas offset factor used for adjusting live gas prices */
+    static readonly gasOffsetFactor: number;
+    /** Address of the fee collector account that receives transaction fees */
+    static readonly feeCollectorAddress: "cheqd13pxn9n3qw79e03844rdadagmg0nshmwfszqu0g";
+    /** Address of the fee market module account */
+    static readonly moduleAccountAddress: "cheqd1el68mjnzv87uurqks8u29tec0cj3297047g2dl";
+    /** Querier extension setup function for fee market operations */
+    static readonly querierExtensionSetup: QueryExtensionSetup<FeemarketExtension>;
+    /** Querier instance with fee market extension capabilities */
+    /** Querier instance with fee market extension capabilities */
+    querier: CheqdQuerier & FeemarketExtension;
+    /**
+     * Constructs a new fee market module instance.
+     *
+     * @param signer - Signing client for blockchain transactions
+     * @param querier - Querier client with fee market extension for data retrieval
+     */
+    constructor(signer: CheqdSigningStargateClient, querier: CheqdQuerier & FeemarketExtension);
+    /**
+     * Gets the registry types for fee market message encoding/decoding.
+     *
+     * @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
+     */
+    getRegistryTypes(): Iterable<[string, GeneratedType]>;
+    /**
+     * Gets the querier extension setup for fee market operations.
+     *
+     * @returns Query extension setup function for fee market functionality
+     */
+    getQuerierExtensionSetup(): QueryExtensionSetup<FeemarketExtension>;
+    /**
+     * Queries the current gas price for a specific denomination.
+     * Retrieves live gas price data from the fee market module.
+     *
+     * @param denom - Token denomination to query gas price for
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the gas price response
+     */
+    queryGasPrice(denom: string, context?: IContext): Promise<GasPriceResponse>;
+    /**
+     * Queries all available gas prices from the fee market.
+     * Retrieves comprehensive gas pricing information for all denominations.
+     *
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the gas prices response
+     */
+    queryGasPrices(context?: IContext): Promise<GasPricesResponse>;
+    /**
+     * Queries the fee market module parameters.
+     * Retrieves configuration settings for the fee market functionality.
+     *
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the parameters response
+     */
+    queryParams(context?: IContext): Promise<ParamsResponse>;
+    /**
+     * Generates gas price for a denomination by live polling the fee market.
+     * Queries current gas prices and adjusts them using the gas offset factor.
+     * Throws an error if live polling fails.
+     *
+     * @param denom - Token denomination to generate gas price for
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the calculated gas price
+     * @throws Error if live poll for gas price fails or returns invalid data
+     */
+    generateGasPrice(denom: string, context?: IContext): Promise<GasPrice>;
+    /**
+     * Generates offline gas price for a denomination using static tier pricing.
+     * Uses predefined gas prices as fallback when live polling is unavailable.
+     *
+     * @param denom - Token denomination to generate gas price for
+     * @param tier - Priority tier for gas price calculation (defaults to Low)
+     * @returns Promise resolving to the static gas price
+     * @throws Error if denomination or tier is invalid
+     */
+    generateOfflineGasPrice(denom: string, tier?: DefaultGasPriceTiers): Promise<GasPrice>;
+    /**
+     * Generates safe gas price with automatic fallback to offline pricing.
+     * Attempts live polling first, falls back to static tier pricing if it fails.
+     *
+     * @param denom - Token denomination to generate gas price for
+     * @param tier - Priority tier for fallback gas price calculation (defaults to Low)
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the gas price (live or fallback)
+     */
+    generateSafeGasPrice(denom: string, tier?: DefaultGasPriceTiers, context?: IContext): Promise<GasPrice>;
+    /**
+     * Generates safe gas price with exponential backoff retry mechanism.
+     * Retries live polling with exponential backoff before falling back to offline pricing.
+     *
+     * @param denom - Token denomination to generate gas price for
+     * @param tier - Priority tier for fallback gas price calculation (defaults to Low)
+     * @param backoffOptions - Retry configuration options (defaults to DefaultBackoffOptions)
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the gas price (live with retries or fallback)
+     */
+    generateSafeGasPriceWithExponentialBackoff(denom: string, tier?: DefaultGasPriceTiers, backoffOptions?: Partial<import("exponential-backoff").IBackOffOptions>, context?: IContext): Promise<GasPrice>;
+    /**
+     * Generates transaction fees from a given gas price.
+     * Calculates the total fee amount based on gas price and gas limit.
+     *
+     * @param gasPrice - Gas price to use for fee calculation
+     * @param payer - Address of the account paying the transaction fees
+     * @param gas - Gas limit for the transaction (defaults to '200000')
+     * @returns Standard fee configuration for the transaction
+     */
+    static generateFeesFromGasPrice(gasPrice: GasPrice, payer: string, gas?: string): DidStdFee;
+}
+//# sourceMappingURL=feemarket.d.ts.map

package/build/types/cjs/src/modules/feemarket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feemarket.d.ts","sourceRoot":"","sources":["../../../../../../cjs/src/modules/feemarket.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EAGd,MAAM,qDAAqD,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAA2B,QAAQ,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,KAAK,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAIvD,oEAAoE;AACpE,eAAO,MAAM,4BAA4B,EAAG,WAAoB,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAC5B,sCAAsC;;IAEtC,uCAAuC;;IAEvC,uCAAuC;;CAE9B,CAAC;AAEX,6CAA6C;AAC7C,eAAO,MAAM,uBAAuB,4CAAsE,CAAC;AAC3G,8CAA8C;AAC9C,eAAO,MAAM,wBAAwB,6CAAuE,CAAC;AAC7G,2CAA2C;AAC3C,eAAO,MAAM,qBAAqB,0CAAoE,CAAC;AAEvG;;;GAGG;AACH,eAAO,MAAM,oBAAoB;IAChC,+CAA+C;;IAE/C,qDAAqD;;IAErD,iDAAiD;;CAExC,CAAC;AAEX,8DAA8D;AAE9D,8DAA8D;AAC9D,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEpG;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACzD,QAAQ,CAAC,OAAO,EAAE,OAAO,uBAAuB,CAAC;IACjD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC1C;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,oBAAoB,CAErF;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IAC1D,QAAQ,CAAC,OAAO,EAAE,OAAO,wBAAwB,CAAC;IAClD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,qBAAqB,CAEvF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACvD,QAAQ,CAAC,OAAO,EAAE,OAAO,qBAAqB,CAAC;IAC/C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACxC;AAED;;;;;GAKG;AAEH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,kBAAkB,CAEjF;AAED,wFAAwF;AACxF,MAAM,MAAM,gCAAgC,GAAG,+BAA+B,CAAC,eAAe,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,QAAQ,CAAC,CAAC,4BAA4B,CAAC,EAAE;QACxC,kDAAkD;QAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAChE,qCAAqC;QACrC,QAAQ,CAAC,SAAS,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACrD,yCAAyC;QACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;KAC/C,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AAEH,eAAO,MAAM,uBAAuB,GAAI,MAAM,WAAW,KAAG,kBAkB3D,CAAC;AAEF;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,sBAAsB;IAE1D,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAI9D;IAEF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB;;;;;;;;;;;;;MAI9B;IAEF,2DAA2D;IAC3D,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAW;IAE1C,0EAA0E;IAC1E,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAG,8CAA8C,CAAU;IAE9F,+CAA+C;IAC/C,MAAM,CAAC,QAAQ,CAAC,oBAAoB,EAAG,8CAA8C,CAAU;IAE/F,iEAAiE;IACjE,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAA2B;IAEzG,8DAA8D;IAE9D,8DAA8D;IAC9D,OAAO,EAAE,YAAY,GAAG,kBAAkB,CAAC;IAE3C;;;;;OAKG;gBACS,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY,GAAG,kBAAkB;IAc1F;;;;OAIG;IACH,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAIrD;;;;OAIG;IAEH,wBAAwB,IAAI,mBAAmB,CAAC,kBAAkB,CAAC;IAInE;;;;;;;OAOG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAMjF;;;;;;OAMG;IACG,cAAc,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMpE;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAM9D;;;;;;;;;OASG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkB5E;;;;;;;;OAQG;IACG,uBAAuB,CAC5B,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,oBAA+C,GACnD,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;OAQG;IACG,oBAAoB,CACzB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,oBAA+C,EACrD,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,QAAQ,CAAC;IAYpB;;;;;;;;;OASG;IACG,0CAA0C,CAC/C,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,oBAA+C,EACrD,cAAc,yDAAwB,EACtC,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,QAAQ,CAAC;IAapB;;;;;;;;OAQG;IACH,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAW,GAAG,SAAS;CAO7F"}