@cheqd/sdk 5.3.2 → 5.3.3-develop.2

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

@@ -5,47 +5,119 @@ import { AbstractCheqdSDKModule, MinimalImportableCheqdSDKModule } from './_.js'
 import { DidStdFee, IContext, QueryExtensionSetup } from '../types.js';
 import { CheqdQuerier } from '../querier.js';
 import { CheqdSigningStargateClient } from '../signer.js';
+/** 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 */
 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 fee market parameters 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: {
         readonly DefaultLowTier: {
             readonly amount: "5000";
@@ -60,51 +132,110 @@ export declare class FeemarketModule extends AbstractCheqdSDKModule {
             readonly denom: "ncheq";
         };
     };
+    /** 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: 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>;
     /**
-     * Generate gas price by denom by live polling. If live poll fails, the error is bubbled up.
-     * @param denom
-     * @returns GasPrice
+     * 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>;
     /**
-     * Generate offline gas price by denom by static tier.
-     * @param denom
-     * @param tier
-     * @returns 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>;
     /**
-     * Generate safe gas price by denom by live polling with fallback to offline gas price. If live poll fails, the error is caught and offline gas price is generated.
-     * @param denom
-     * @param tier
-     * @returns 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>;
     /**
-     * Generate safe gas price by denom by live polling with exponential backoff to offline gas price.
-     * @param denom
-     * @param tier
-     * @param backoffOptions
-     * @returns 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>;
     /**
-     * Generate fees from gas price. Use with live polling for gas price.
-     * @param gasPrice
-     * @param payer
-     * @param gas
-     * @returns DidStdFee
+     * 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;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"feemarket.d.ts","sourceRoot":"","sources":["../../../esm/src/modules/feemarket.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EAGd,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAA2B,QAAQ,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAI1D,eAAO,MAAM,4BAA4B,EAAG,WAAoB,CAAC;AAEjE,eAAO,MAAM,gBAAgB;;;;CAInB,CAAC;AAEX,eAAO,MAAM,uBAAuB,4CAAsE,CAAC;AAC3G,eAAO,MAAM,wBAAwB,6CAAuE,CAAC;AAC7G,eAAO,MAAM,qBAAqB,0CAAoE,CAAC;AAEvG,eAAO,MAAM,oBAAoB;;;;CAIvB,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEpG,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,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,oBAAoB,CAErF;AAED,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,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,qBAAqB,CAEvF;AAED,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,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,kBAAkB,CAEjF;AAED,MAAM,MAAM,gCAAgC,GAAG,+BAA+B,CAAC,eAAe,CAAC,CAAC;AAEhG,MAAM,MAAM,kBAAkB,GAAG;IAChC,QAAQ,CAAC,CAAC,4BAA4B,CAAC,EAAE;QACxC,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAChE,QAAQ,CAAC,SAAS,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACrD,QAAQ,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;KAC/C,CAAC;CACF,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,MAAM,WAAW,KAAG,kBAkB3D,CAAC;AAEF,qBAAa,eAAgB,SAAQ,sBAAsB;IAE1D,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAI9D;IAEF,MAAM,CAAC,QAAQ,CAAC,gBAAgB;;;;;;;;;;;;;MAIrB;IAEX,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAW;IAE1C,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAG,8CAA8C,CAAU;IAE9F,MAAM,CAAC,QAAQ,CAAC,oBAAoB,EAAG,8CAA8C,CAAU;IAE/F,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAA2B;IAEzG,OAAO,EAAE,YAAY,GAAG,kBAAkB,CAAC;gBAE/B,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY,GAAG,kBAAkB;IAc1F,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAIrD,wBAAwB,IAAI,mBAAmB,CAAC,kBAAkB,CAAC;IAI7D,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAM3E,cAAc,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM9D,WAAW,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;IAM9D;;;;OAIG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkB5E;;;;;OAKG;IACG,uBAAuB,CAC5B,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,oBAA+C,GACnD,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;OAKG;IACG,oBAAoB,CACzB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,oBAA+C,EACrD,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,QAAQ,CAAC;IAYpB;;;;;;OAMG;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;;;;;;OAMG;IACH,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAW,GAAG,SAAS;CAO7F"}
+{"version":3,"file":"feemarket.d.ts","sourceRoot":"","sources":["../../../esm/src/modules/feemarket.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EAGd,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAA2B,QAAQ,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAI1D,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;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;AACH,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;AACH,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;;;;;;;;;;;;;MAIrB;IAEX,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;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;IACH,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"}

package/build/types/modules/resource.d.ts

@@ -6,57 +6,199 @@ import { Metadata, MsgCreateResource, MsgCreateResourcePayload, QueryCollectionR
 import { DeliverTxResponse, QueryClient } from '@cosmjs/stargate';
 import { SignInfo } from '@cheqd/ts-proto/cheqd/did/v2/index.js';
 import { CheqdQuerier } from '../querier.js';
+/** Default extension key for resource-related query operations */
 export declare const defaultResourceExtensionKey: "resource";
+/**
+ * Protobuf message type literals for resource operations.
+ * Used for consistent message type identification across the module.
+ */
 export declare const protobufLiterals: {
+    /** Create resource message type */
     readonly MsgCreateResource: "MsgCreateResource";
+    /** Create resource response message type */
     readonly MsgCreateResourceResponse: "MsgCreateResourceResponse";
 };
+/** Type URL for MsgCreateResource messages */
 export declare const typeUrlMsgCreateResource: "/cheqd.resource.v2.MsgCreateResource";
+/** Type URL for MsgCreateResourceResponse messages */
 export declare const typeUrlMsgCreateResourceResponse: "/cheqd.resource.v2.MsgCreateResourceResponse";
+/**
+ * Encode object interface for MsgCreateResource messages.
+ * Used for type-safe message encoding in resource creation transactions.
+ */
 export interface MsgCreateResourceEncodeObject extends EncodeObject {
     readonly typeUrl: typeof typeUrlMsgCreateResource;
     readonly value: Partial<MsgCreateResource>;
 }
+/**
+ * Type guard function to check if an object is a MsgCreateResourceEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgCreateResourceEncodeObject
+ */
 export declare function isMsgCreateResourceEncodeObject(obj: EncodeObject): obj is MsgCreateResourceEncodeObject;
+/** Minimal importable version of the resource module for clean external interfaces */
 export type MinimalImportableResourceModule = MinimalImportableCheqdSDKModule<ResourceModule>;
+/**
+ * Resource extension interface for querier functionality.
+ * Provides methods for querying resources and their metadata.
+ */
 export type ResourceExtension = {
     readonly [defaultResourceExtensionKey]: {
+        /** Query a specific resource by collection and resource ID */
         readonly resource: (collectionId: string, resourceId: string) => Promise<ResourceWithMetadata>;
+        /** Query metadata for a specific resource */
         readonly resourceMetadata: (collectionId: string, resourceId: string) => Promise<Metadata>;
+        /** Query all resources in a collection with pagination support */
         readonly collectionResources: (collectionId: string, paginationKey?: Uint8Array) => Promise<QueryCollectionResourcesResponse>;
     };
 };
+/**
+ * Sets up the resource extension for the querier client.
+ * Creates and configures the resource-specific query methods.
+ *
+ * @param base - Base QueryClient to extend
+ * @returns Configured resource extension with query methods
+ */
 export declare const setupResourceExtension: (base: QueryClient) => ResourceExtension;
+/**
+ * Resource Module class providing comprehensive linked resource functionality.
+ * Handles creation, querying, and metadata management of resources linked to DID documents.
+ */
 export declare class ResourceModule extends AbstractCheqdSDKModule {
     static readonly registryTypes: Iterable<[string, GeneratedType]>;
+    /** Base denomination for Cheqd network transactions */
     static readonly baseMinimalDenom: "ncheq";
+    /**
+     * Standard fee amounts for different resource types.
+     * Fees vary based on resource content type and processing requirements.
+     */
     static readonly fees: {
+        /** Default fee for creating image resources */
         readonly DefaultCreateResourceImageFee: {
             readonly amount: "10000000000";
             readonly denom: "ncheq";
         };
+        /** Default fee for creating JSON resources */
         readonly DefaultCreateResourceJsonFee: {
             readonly amount: "10000000000";
             readonly denom: "ncheq";
         };
+        /** Default fee for creating other types of resources */
         readonly DefaultCreateResourceDefaultFee: {
             readonly amount: "10000000000";
             readonly denom: "ncheq";
         };
     };
+    /** Querier extension setup function for resource operations */
     static readonly querierExtensionSetup: QueryExtensionSetup<ResourceExtension>;
+    /** Querier instance with resource extension capabilities */
     querier: CheqdQuerier & ResourceExtension;
+    /**
+     * Constructs a new resource module instance.
+     *
+     * @param signer - Signing client for blockchain transactions
+     * @param querier - Querier client with resource extension for data retrieval
+     */
     constructor(signer: CheqdSigningStargateClient, querier: CheqdQuerier & ResourceExtension);
+    /**
+     * Gets the registry types for resource message encoding/decoding.
+     *
+     * @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
+     */
     getRegistryTypes(): Iterable<[string, GeneratedType]>;
+    /**
+     * Gets the querier extension setup for resource operations.
+     *
+     * @returns Query extension setup function for resource functionality
+     */
     getQuerierExtensionSetup(): QueryExtensionSetup<ResourceExtension>;
+    /**
+     * Signs a resource payload with provided signature inputs.
+     * Creates a complete signed resource message ready for blockchain submission.
+     *
+     * @param payload - Resource payload to sign
+     * @param signInputs - Signing inputs or pre-computed signatures
+     * @returns Promise resolving to the signed resource message
+     */
     static signPayload(payload: MsgCreateResourcePayload, signInputs: ISignInputs[] | SignInfo[]): Promise<MsgCreateResource>;
+    /**
+     * Creates a linked resource transaction on the blockchain.
+     * Handles automatic fee calculation based on resource content type and size.
+     *
+     * @param signInputs - Signing inputs or pre-computed signatures for the transaction
+     * @param resourcePayload - Resource payload containing data and metadata
+     * @param address - Address of the account submitting the transaction
+     * @param fee - Transaction fee configuration or 'auto' for automatic calculation
+     * @param memo - Optional transaction memo
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the transaction response
+     * @throws Error if linked resource data is empty when automatic fee calculation is requested
+     */
     createLinkedResourceTx(signInputs: ISignInputs[] | SignInfo[], resourcePayload: Partial<MsgCreateResourcePayload>, address: string, fee?: DidStdFee | 'auto' | number, memo?: string, context?: IContext): Promise<DeliverTxResponse>;
+    /**
+     * Queries a specific linked resource by collection and resource ID.
+     * Retrieves the complete resource data along with its metadata.
+     *
+     * @param collectionId - ID of the collection containing the resource
+     * @param resourceId - ID of the resource to query
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the resource with metadata
+     */
     queryLinkedResource(collectionId: string, resourceId: string, context?: IContext): Promise<ResourceWithMetadata>;
+    /**
+     * Queries metadata for a specific linked resource.
+     * Retrieves only the metadata without the resource content data.
+     *
+     * @param collectionId - ID of the collection containing the resource
+     * @param resourceId - ID of the resource to query metadata for
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the resource metadata
+     */
     queryLinkedResourceMetadata(collectionId: string, resourceId: string, context?: IContext): Promise<Metadata>;
+    /**
+     * Queries all resources in a collection with pagination support.
+     * Retrieves a list of all resources belonging to a specific collection.
+     *
+     * @param collectionId - ID of the collection to query resources for
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the collection resources response with pagination
+     */
     queryLinkedResources(collectionId: string, context?: IContext): Promise<QueryCollectionResourcesResponse>;
+    /**
+     * Reads and determines the MIME type of resource content.
+     * Analyzes the content to identify the appropriate MIME type for fee calculation and validation.
+     *
+     * @param content - Resource content as byte array
+     * @returns Promise resolving to the detected MIME type string
+     */
     static readMimeType(content: Uint8Array): Promise<string>;
+    /**
+     * Generates fee configuration for image resource creation transactions.
+     * Uses higher gas limits appropriate for image processing and storage.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for image resources
+     */
     static generateCreateResourceImageFees(feePayer: string, granter?: string): Promise<DidStdFee>;
+    /**
+     * Generates fee configuration for JSON resource creation transactions.
+     * Uses gas limits optimized for JSON data processing and validation.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for JSON resources
+     */
     static generateCreateResourceJsonFees(feePayer: string, granter?: string): Promise<DidStdFee>;
+    /**
+     * Generates fee configuration for default resource creation transactions.
+     * Uses standard gas limits for generic resource types and binary data.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for default resources
+     */
     static generateCreateResourceDefaultFees(feePayer: string, granter?: string): Promise<DidStdFee>;
 }
 //# sourceMappingURL=resource.d.ts.map

package/build/types/modules/resource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../esm/src/modules/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EACN,QAAQ,EACR,iBAAiB,EACjB,wBAAwB,EAGxB,gCAAgC,EAChC,oBAAoB,EAEpB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAA6C,MAAM,kBAAkB,CAAC;AAC7G,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAKjE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAG7C,eAAO,MAAM,2BAA2B,EAAG,UAAmB,CAAC;AAE/D,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC;AAEX,eAAO,MAAM,wBAAwB,wCAAuE,CAAC;AAC7G,eAAO,MAAM,gCAAgC,gDACgC,CAAC;AAE9E,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IAClE,QAAQ,CAAC,OAAO,EAAE,OAAO,wBAAwB,CAAC;IAClD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC3C;AAED,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,6BAA6B,CAEvG;AAED,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAC;AAE9F,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,CAAC,CAAC,2BAA2B,CAAC,EAAE;QACvC,QAAQ,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC/F,QAAQ,CAAC,gBAAgB,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3F,QAAQ,CAAC,mBAAmB,EAAE,CAC7B,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,UAAU,KACtB,OAAO,CAAC,gCAAgC,CAAC,CAAC;KAC/C,CAAC;CACF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,MAAM,WAAW,KAAG,iBA0B1D,CAAC;AAEF,qBAAa,cAAe,SAAQ,sBAAsB;IAEzD,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAG9D;IAEF,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAG,OAAO,CAAU;IAEpD,MAAM,CAAC,QAAQ,CAAC,IAAI;;;;;;;;;;;;;MAIT;IAEX,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,CAA0B;IAEvG,OAAO,EAAE,YAAY,GAAG,iBAAiB,CAAC;gBAE9B,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY,GAAG,iBAAiB;IAWlF,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAIrD,wBAAwB,IAAI,mBAAmB,CAAC,iBAAiB,CAAC;WAI5D,WAAW,CACvB,OAAO,EAAE,wBAAwB,EACjC,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,GACpC,OAAO,CAAC,iBAAiB,CAAC;IAevB,sBAAsB,CAC3B,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,EACtC,eAAe,EAAE,OAAO,CAAC,wBAAwB,CAAC,EAClD,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAyCvB,mBAAmB,CACxB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,oBAAoB,CAAC;IAO1B,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO5G,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gCAAgC,CAAC;WAOlG,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;WAMlD,+BAA+B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;WASvF,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;WAStF,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAQtG"}
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../esm/src/modules/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EACN,QAAQ,EACR,iBAAiB,EACjB,wBAAwB,EAGxB,gCAAgC,EAChC,oBAAoB,EAEpB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAA6C,MAAM,kBAAkB,CAAC;AAC7G,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAKjE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAG7C,kEAAkE;AAClE,eAAO,MAAM,2BAA2B,EAAG,UAAmB,CAAC;AAE/D;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAC5B,mCAAmC;;IAEnC,4CAA4C;;CAEnC,CAAC;AAEX,8CAA8C;AAC9C,eAAO,MAAM,wBAAwB,wCAAuE,CAAC;AAC7G,sDAAsD;AACtD,eAAO,MAAM,gCAAgC,gDACgC,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IAClE,QAAQ,CAAC,OAAO,EAAE,OAAO,wBAAwB,CAAC;IAClD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,6BAA6B,CAEvG;AAED,sFAAsF;AACtF,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,CAAC,CAAC,2BAA2B,CAAC,EAAE;QACvC,8DAA8D;QAC9D,QAAQ,CAAC,QAAQ,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC/F,6CAA6C;QAC7C,QAAQ,CAAC,gBAAgB,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3F,kEAAkE;QAClE,QAAQ,CAAC,mBAAmB,EAAE,CAC7B,YAAY,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,UAAU,KACtB,OAAO,CAAC,gCAAgC,CAAC,CAAC;KAC/C,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,MAAM,WAAW,KAAG,iBA0B1D,CAAC;AAEF;;;GAGG;AACH,qBAAa,cAAe,SAAQ,sBAAsB;IAEzD,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAG9D;IAEF,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAG,OAAO,CAAU;IAEpD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI;QACnB,+CAA+C;;;;;QAE/C,8CAA8C;;;;;QAE9C,wDAAwD;;;;;MAE9C;IAEX,+DAA+D;IAC/D,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,CAA0B;IAEvG,4DAA4D;IAC5D,OAAO,EAAE,YAAY,GAAG,iBAAiB,CAAC;IAE1C;;;;;OAKG;gBACS,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY,GAAG,iBAAiB;IAWzF;;;;OAIG;IACI,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAI5D;;;;OAIG;IACI,wBAAwB,IAAI,mBAAmB,CAAC,iBAAiB,CAAC;IAIzE;;;;;;;OAOG;WACU,WAAW,CACvB,OAAO,EAAE,wBAAwB,EACjC,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,GACpC,OAAO,CAAC,iBAAiB,CAAC;IAe7B;;;;;;;;;;;;OAYG;IACG,sBAAsB,CAC3B,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,EACtC,eAAe,EAAE,OAAO,CAAC,wBAAwB,CAAC,EAClD,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAyC7B;;;;;;;;OAQG;IACG,mBAAmB,CACxB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,oBAAoB,CAAC;IAOhC;;;;;;;;OAQG;IACG,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOlH;;;;;;;OAOG;IACG,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAO/G;;;;;;OAMG;WACU,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAM/D;;;;;;;OAOG;WACU,+BAA+B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IASpG;;;;;;;OAOG;WACU,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IASnG;;;;;;;OAOG;WACU,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAQtG"}

package/build/types/querier.d.ts

@@ -1,12 +1,62 @@
 import { QueryClient } from '@cosmjs/stargate';
 import { CometClient, ConsensusParams } from '@cosmjs/tendermint-rpc';
 import { QueryExtensionSetup, CheqdExtensions } from './types.js';
+/**
+ * Extended QueryClient specifically designed for the Cheqd blockchain network.
+ * Provides enhanced querying capabilities with support for custom extensions
+ * and consensus parameter retrieval.
+ */
 export declare class CheqdQuerier extends QueryClient {
+    /**
+     * Constructs a new CheqdQuerier instance with the provided Comet client.
+     *
+     * @param cometClient - Comet client for blockchain communication
+     */
     constructor(cometClient: CometClient);
+    /**
+     * Retrieves the consensus parameters from the blockchain network.
+     * This method creates a temporary connection to fetch the latest block results
+     * and extract consensus update information.
+     *
+     * @param url - RPC URL of the blockchain node
+     * @returns Promise resolving to consensus parameters or undefined if not available
+     */
     static getConsensusParameters(url: string): Promise<ConsensusParams | undefined>;
+    /**
+     * Creates a new CheqdQuerier instance by establishing a connection to the specified RPC URL.
+     * This is the primary method for creating a querier instance for blockchain communication.
+     *
+     * @param url - RPC URL of the blockchain node to connect to
+     * @returns Promise resolving to a connected CheqdQuerier instance
+     */
     static connect(url: string): Promise<CheqdQuerier>;
+    /**
+     * Creates a CheqdQuerier instance from an existing Comet client.
+     * Useful when you already have an established client connection.
+     *
+     * @param client - Existing Comet client
+     * @returns Promise resolving to a CheqdQuerier instance using the provided client
+     */
     static fromClient(client: CometClient): Promise<CheqdQuerier>;
+    /**
+     * Creates a CheqdQuerier instance with a single query extension.
+     * Extensions provide specialized query capabilities for specific blockchain modules.
+     *
+     * @param url - RPC URL of the blockchain node to connect to
+     * @param extension - Query extension setup to add specialized query functionality
+     * @returns Promise resolving to a CheqdQuerier instance with the specified extension
+     */
     static connectWithExtension(url: string, extension: QueryExtensionSetup<CheqdExtensions>): Promise<CheqdQuerier & CheqdExtensions>;
+    /**
+     * Creates a CheqdQuerier instance with multiple query extensions.
+     * This method supports adding multiple specialized query capabilities for different
+     * blockchain modules in a single operation. For single extensions, it delegates
+     * to connectWithExtension for efficiency.
+     *
+     * @param url - RPC URL of the blockchain node to connect to
+     * @param extensions - Variable number of query extension setups to add functionality
+     * @returns Promise resolving to a CheqdQuerier instance with all specified extensions
+     */
     static connectWithExtensions(url: string, ...extensions: QueryExtensionSetup<CheqdExtensions>[]): Promise<CheqdQuerier & CheqdExtensions>;
 }
 //# sourceMappingURL=querier.d.ts.map

package/build/types/querier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querier.d.ts","sourceRoot":"","sources":["../../esm/src/querier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAgB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElE,qBAAa,YAAa,SAAQ,WAAW;gBAChC,WAAW,EAAE,WAAW;WAIvB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;WAczE,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;WAK3C,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;WAItD,oBAAoB,CAChC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,mBAAmB,CAAC,eAAe,CAAC,GAC7C,OAAO,CAAC,YAAY,GAAG,eAAe,CAAC;WAK7B,qBAAqB,CACjC,GAAG,EAAE,MAAM,EACX,GAAG,UAAU,EAAE,mBAAmB,CAAC,eAAe,CAAC,EAAE,GACnD,OAAO,CAAC,YAAY,GAAG,eAAe,CAAC;CAY1C"}
+{"version":3,"file":"querier.d.ts","sourceRoot":"","sources":["../../esm/src/querier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAgB,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElE;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAIpC;;;;;;;OAOG;WACU,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IActF;;;;;;OAMG;WACU,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKxD;;;;;;OAMG;WACU,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAInE;;;;;;;OAOG;WACU,oBAAoB,CAChC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,mBAAmB,CAAC,eAAe,CAAC,GAC7C,OAAO,CAAC,YAAY,GAAG,eAAe,CAAC;IAK1C;;;;;;;;;OASG;WACU,qBAAqB,CACjC,GAAG,EAAE,MAAM,EACX,GAAG,UAAU,EAAE,mBAAmB,CAAC,eAAe,CAAC,EAAE,GACnD,OAAO,CAAC,YAAY,GAAG,eAAe,CAAC;CAY1C"}

package/build/types/registry.d.ts

@@ -1,4 +1,18 @@
 import { Registry, GeneratedType } from '@cosmjs/proto-signing';
+/**
+ * Creates a default Cheqd registry with optional custom types.
+ * The registry is used for encoding and decoding protobuf messages in blockchain transactions.
+ * It includes all default Stargate types and any additional custom types provided.
+ *
+ * @param customTypes - Optional iterable of custom type mappings to add to the registry.
+ *                     Each entry should be a tuple of [typeUrl, GeneratedType].
+ * @returns A configured Registry instance with default and custom types
+ */
 export declare function createDefaultCheqdRegistry(customTypes?: Iterable<[string, GeneratedType]>): Registry;
+/**
+ * Pre-configured Cheqd registry instance with default Stargate types.
+ * This is a ready-to-use registry for basic blockchain operations that don't require
+ * custom message types. For applications needing custom types, use createDefaultCheqdRegistry instead.
+ */
 export declare const CheqdRegistry: Registry;
 //# sourceMappingURL=registry.d.ts.map

package/build/types/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../esm/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAIhE,wBAAgB,0BAA0B,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,GAAG,QAAQ,CAGpG;AAED,eAAO,MAAM,aAAa,UAAqC,CAAC"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../esm/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAIhE;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,GAAG,QAAQ,CAGpG;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAqC,CAAC"}