@cheqd/sdk 5.3.2-develop.2 → 5.3.3-develop.1

package/build/esm/modules/resource.js

@@ -7,16 +7,38 @@ import { fileTypeFromBuffer } from 'file-type';
 import { toString } from 'uint8arrays/to-string';
 import { assert } from '@cosmjs/utils';
 import { isJSON } from '../utils.js';
+/** Default extension key for resource-related query operations */
 export const defaultResourceExtensionKey = 'resource';
+/**
+ * Protobuf message type literals for resource operations.
+ * Used for consistent message type identification across the module.
+ */
 export const protobufLiterals = {
+    /** Create resource message type */
     MsgCreateResource: 'MsgCreateResource',
+    /** Create resource response message type */
     MsgCreateResourceResponse: 'MsgCreateResourceResponse',
 };
+/** Type URL for MsgCreateResource messages */
 export const typeUrlMsgCreateResource = `/${protobufPackage}.${protobufLiterals.MsgCreateResource}`;
+/** Type URL for MsgCreateResourceResponse messages */
 export const typeUrlMsgCreateResourceResponse = `/${protobufPackage}.${protobufLiterals.MsgCreateResourceResponse}`;
+/**
+ * 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 function isMsgCreateResourceEncodeObject(obj) {
     return obj.typeUrl === typeUrlMsgCreateResource;
 }
+/**
+ * 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 const setupResourceExtension = (base) => {
     const rpc = createProtobufRpcClient(base);
     const queryService = new QueryClientImpl(rpc);
@@ -42,20 +64,40 @@ export const setupResourceExtension = (base) => {
         },
     };
 };
+/**
+ * Resource Module class providing comprehensive linked resource functionality.
+ * Handles creation, querying, and metadata management of resources linked to DID documents.
+ */
 export class ResourceModule extends AbstractCheqdSDKModule {
     // @ts-expect-error underlying type `GeneratedType` is intentionally wider
     static registryTypes = [
         [typeUrlMsgCreateResource, MsgCreateResource],
         [typeUrlMsgCreateResourceResponse, MsgCreateResourceResponse],
     ];
+    /** Base denomination for Cheqd network transactions */
     static baseMinimalDenom = 'ncheq';
+    /**
+     * Standard fee amounts for different resource types.
+     * Fees vary based on resource content type and processing requirements.
+     */
     static fees = {
+        /** Default fee for creating image resources */
         DefaultCreateResourceImageFee: { amount: '10000000000', denom: ResourceModule.baseMinimalDenom },
+        /** Default fee for creating JSON resources */
         DefaultCreateResourceJsonFee: { amount: '10000000000', denom: ResourceModule.baseMinimalDenom },
+        /** Default fee for creating other types of resources */
         DefaultCreateResourceDefaultFee: { amount: '10000000000', denom: ResourceModule.baseMinimalDenom },
     };
+    /** Querier extension setup function for resource operations */
     static querierExtensionSetup = setupResourceExtension;
+    /** Querier instance with resource extension capabilities */
     querier;
+    /**
+     * 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, querier) {
         super(signer, querier);
         this.querier = querier;
@@ -66,12 +108,30 @@ export class ResourceModule extends AbstractCheqdSDKModule {
             queryLinkedResources: this.queryLinkedResources.bind(this),
         };
     }
+    /**
+     * Gets the registry types for resource message encoding/decoding.
+     *
+     * @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
+     */
     getRegistryTypes() {
         return ResourceModule.registryTypes;
     }
+    /**
+     * Gets the querier extension setup for resource operations.
+     *
+     * @returns Query extension setup function for resource functionality
+     */
     getQuerierExtensionSetup() {
         return ResourceModule.querierExtensionSetup;
     }
+    /**
+     * 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 async signPayload(payload, signInputs) {
         const signBytes = MsgCreateResourcePayload.encode(payload).finish();
         let signatures;
@@ -86,6 +146,19 @@ export class ResourceModule extends AbstractCheqdSDKModule {
             signatures,
         };
     }
+    /**
+     * 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
+     */
     async createLinkedResourceTx(signInputs, resourcePayload, address, fee, memo, context) {
         if (!this._signer) {
             this._signer = context.sdk.signer;
@@ -116,29 +189,70 @@ export class ResourceModule extends AbstractCheqdSDKModule {
         }
         return this._signer.signAndBroadcast(address, [encObj], fee, memo);
     }
+    /**
+     * 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
+     */
     async queryLinkedResource(collectionId, resourceId, context) {
         if (!this.querier) {
             this.querier = context.sdk.querier;
         }
         return await this.querier[defaultResourceExtensionKey].resource(collectionId, resourceId);
     }
+    /**
+     * 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
+     */
     async queryLinkedResourceMetadata(collectionId, resourceId, context) {
         if (!this.querier) {
             this.querier = context.sdk.querier;
         }
         return await this.querier[defaultResourceExtensionKey].resourceMetadata(collectionId, resourceId);
     }
+    /**
+     * 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
+     */
     async queryLinkedResources(collectionId, context) {
         if (!this.querier) {
             this.querier = context.sdk.querier;
         }
         return await this.querier[defaultResourceExtensionKey].collectionResources(collectionId);
     }
+    /**
+     * 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 async readMimeType(content) {
         if (isJSON(toString(content, 'utf-8')))
             return 'application/json';
         return (await fileTypeFromBuffer(content))?.mime ?? 'application/octet-stream';
     }
+    /**
+     * 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 async generateCreateResourceImageFees(feePayer, granter) {
         return {
             amount: [ResourceModule.fees.DefaultCreateResourceImageFee],
@@ -147,6 +261,14 @@ export class ResourceModule extends AbstractCheqdSDKModule {
             granter: granter,
         };
     }
+    /**
+     * 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 async generateCreateResourceJsonFees(feePayer, granter) {
         return {
             amount: [ResourceModule.fees.DefaultCreateResourceJsonFee],
@@ -155,6 +277,14 @@ export class ResourceModule extends AbstractCheqdSDKModule {
             granter: granter,
         };
     }
+    /**
+     * 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 async generateCreateResourceDefaultFees(feePayer, granter) {
         return {
             amount: [ResourceModule.fees.DefaultCreateResourceDefaultFee],

package/build/esm/modules/resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../esm/src/modules/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAmC,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D,OAAO,EAAuB,WAAW,EAAuB,MAAM,aAAa,CAAC;AACpF,OAAO,EAEN,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,eAAe,EAGf,eAAe,GACf,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAkC,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE7G,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAmB,CAAC;AAE/D,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,iBAAiB,EAAE,mBAAmB;IACtC,yBAAyB,EAAE,2BAA2B;CAC7C,CAAC;AAEX,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,eAAe,IAAI,gBAAgB,CAAC,iBAAiB,EAAW,CAAC;AAC7G,MAAM,CAAC,MAAM,gCAAgC,GAC5C,IAAI,eAAe,IAAI,gBAAgB,CAAC,yBAAyB,EAAW,CAAC;AAO9E,MAAM,UAAU,+BAA+B,CAAC,GAAiB;IAChE,OAAO,GAAG,CAAC,OAAO,KAAK,wBAAwB,CAAC;AACjD,CAAC;AAeD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAAiB,EAAqB,EAAE;IAC9E,MAAM,GAAG,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE1C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;IAE9C,OAAO;QACN,CAAC,2BAA2B,CAAC,EAAE;YAC9B,QAAQ,EAAE,KAAK,EAAE,YAAoB,EAAE,UAAkB,EAAE,EAAE;gBAC5D,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBACnF,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjB,OAAO,QAAQ,CAAC;YACjB,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,YAAoB,EAAE,UAAkB,EAAE,EAAE;gBACpE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC3F,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjB,OAAO,QAAQ,CAAC;YACjB,CAAC;YACD,mBAAmB,EAAE,KAAK,EAAE,YAAoB,EAAE,aAA0B,EAAE,EAAE;gBAC/E,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC;oBACvD,YAAY;oBACZ,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAA4B;iBACtE,CAAC,CAAC;gBACH,OAAO,QAAQ,CAAC;YACjB,CAAC;SACD;KACoB,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,OAAO,cAAe,SAAQ,sBAAsB;IACzD,0EAA0E;IAC1E,MAAM,CAAU,aAAa,GAAsC;QAClE,CAAC,wBAAwB,EAAE,iBAAiB,CAAC;QAC7C,CAAC,gCAAgC,EAAE,yBAAyB,CAAC;KAC7D,CAAC;IAEF,MAAM,CAAU,gBAAgB,GAAG,OAAgB,CAAC;IAEpD,MAAM,CAAU,IAAI,GAAG;QACtB,6BAA6B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;QACzG,4BAA4B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;QACxG,+BAA+B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;KAClG,CAAC;IAEX,MAAM,CAAU,qBAAqB,GAA2C,sBAAsB,CAAC;IAEvG,OAAO,CAAmC;IAE1C,YAAY,MAAkC,EAAE,OAAyC;QACxF,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG;YACd,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9D,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YACxD,2BAA2B,EAAE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACxE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC1D,CAAC;IACH,CAAC;IAEM,gBAAgB;QACtB,OAAO,cAAc,CAAC,aAAa,CAAC;IACrC,CAAC;IAEM,wBAAwB;QAC9B,OAAO,cAAc,CAAC,qBAAqB,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,WAAW,CACvB,OAAiC,EACjC,UAAsC;QAEtC,MAAM,SAAS,GAAG,wBAAwB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QACpE,IAAI,UAAsB,CAAC;QAC3B,IAAI,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,UAAU,GAAG,MAAM,0BAA0B,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACrF,CAAC;aAAM,CAAC;YACP,UAAU,GAAG,UAAU,CAAC;QACzB,CAAC;QAED,OAAO;YACN,OAAO;YACP,UAAU;SACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC3B,UAAsC,EACtC,eAAkD,EAClD,OAAe,EACf,GAAiC,EACjC,IAAa,EACb,OAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,MAAM,CAAC;QACrC,CAAC;QAED,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAEtE,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,MAAM,GAAkC;YAC7C,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,GAAG;SACV,CAAC;QAEF,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC,MAAM,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAClD,CAAC;YAED,GAAG,GAAG,MAAM,CAAC,KAAK;gBACjB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAEjE,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnC,OAAO,MAAM,cAAc,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;gBACtE,CAAC;gBAED,IAAI,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC7C,OAAO,MAAM,cAAc,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;gBACrE,CAAC;gBAED,OAAO,MAAM,cAAc,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;YACxE,CAAC,CAAC,EAAE,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,GAAI,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,mBAAmB,CACxB,YAAoB,EACpB,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAC3F,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAkB;QAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,OAAkB;QAClE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAC1F,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAmB;QAC5C,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,kBAAkB,CAAC;QAElE,OAAO,CAAC,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,0BAA0B,CAAC;IAChF,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,QAAgB,EAAE,OAAgB;QAC9E,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,6BAA6B,CAAC;YAC3D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,QAAgB,EAAE,OAAgB;QAC7E,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,CAAC;YAC1D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,QAAgB,EAAE,OAAgB;QAChF,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,+BAA+B,CAAC;YAC7D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC"}
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../esm/src/modules/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAmC,MAAM,QAAQ,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D,OAAO,EAAuB,WAAW,EAAuB,MAAM,aAAa,CAAC;AACpF,OAAO,EAEN,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,eAAe,EAGf,eAAe,GACf,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAkC,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE7G,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAGvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,kEAAkE;AAClE,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAmB,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,mCAAmC;IACnC,iBAAiB,EAAE,mBAAmB;IACtC,4CAA4C;IAC5C,yBAAyB,EAAE,2BAA2B;CAC7C,CAAC;AAEX,8CAA8C;AAC9C,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,eAAe,IAAI,gBAAgB,CAAC,iBAAiB,EAAW,CAAC;AAC7G,sDAAsD;AACtD,MAAM,CAAC,MAAM,gCAAgC,GAC5C,IAAI,eAAe,IAAI,gBAAgB,CAAC,yBAAyB,EAAW,CAAC;AAW9E;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAAC,GAAiB;IAChE,OAAO,GAAG,CAAC,OAAO,KAAK,wBAAwB,CAAC;AACjD,CAAC;AAuBD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAAiB,EAAqB,EAAE;IAC9E,MAAM,GAAG,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE1C,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC;IAE9C,OAAO;QACN,CAAC,2BAA2B,CAAC,EAAE;YAC9B,QAAQ,EAAE,KAAK,EAAE,YAAoB,EAAE,UAAkB,EAAE,EAAE;gBAC5D,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBACnF,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjB,OAAO,QAAQ,CAAC;YACjB,CAAC;YACD,gBAAgB,EAAE,KAAK,EAAE,YAAoB,EAAE,UAAkB,EAAE,EAAE;gBACpE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC3F,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACjB,OAAO,QAAQ,CAAC;YACjB,CAAC;YACD,mBAAmB,EAAE,KAAK,EAAE,YAAoB,EAAE,aAA0B,EAAE,EAAE;gBAC/E,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC;oBACvD,YAAY;oBACZ,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAA4B;iBACtE,CAAC,CAAC;gBACH,OAAO,QAAQ,CAAC;YACjB,CAAC;SACD;KACoB,CAAC;AACxB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,sBAAsB;IACzD,0EAA0E;IAC1E,MAAM,CAAU,aAAa,GAAsC;QAClE,CAAC,wBAAwB,EAAE,iBAAiB,CAAC;QAC7C,CAAC,gCAAgC,EAAE,yBAAyB,CAAC;KAC7D,CAAC;IAEF,uDAAuD;IACvD,MAAM,CAAU,gBAAgB,GAAG,OAAgB,CAAC;IAEpD;;;OAGG;IACH,MAAM,CAAU,IAAI,GAAG;QACtB,+CAA+C;QAC/C,6BAA6B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;QACzG,8CAA8C;QAC9C,4BAA4B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;QACxG,wDAAwD;QACxD,+BAA+B,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,cAAc,CAAC,gBAAgB,EAAW;KAClG,CAAC;IAEX,+DAA+D;IAC/D,MAAM,CAAU,qBAAqB,GAA2C,sBAAsB,CAAC;IAEvG,4DAA4D;IAC5D,OAAO,CAAmC;IAE1C;;;;;OAKG;IACH,YAAY,MAAkC,EAAE,OAAyC;QACxF,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG;YACd,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9D,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YACxD,2BAA2B,EAAE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC;YACxE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC1D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACtB,OAAO,cAAc,CAAC,aAAa,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,wBAAwB;QAC9B,OAAO,cAAc,CAAC,qBAAqB,CAAC;IAC7C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CACvB,OAAiC,EACjC,UAAsC;QAEtC,MAAM,SAAS,GAAG,wBAAwB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QACpE,IAAI,UAAsB,CAAC;QAC3B,IAAI,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,UAAU,GAAG,MAAM,0BAA0B,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACrF,CAAC;aAAM,CAAC;YACP,UAAU,GAAG,UAAU,CAAC;QACzB,CAAC;QAED,OAAO;YACN,OAAO;YACP,UAAU;SACV,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,sBAAsB,CAC3B,UAAsC,EACtC,eAAkD,EAClD,OAAe,EACf,GAAiC,EACjC,IAAa,EACb,OAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,MAAM,CAAC;QACrC,CAAC;QAED,MAAM,OAAO,GAAG,wBAAwB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAEtE,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,MAAM,GAAkC;YAC7C,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,GAAG;SACV,CAAC;QAEF,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC,MAAM,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAClD,CAAC;YAED,GAAG,GAAG,MAAM,CAAC,KAAK;gBACjB,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAEjE,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnC,OAAO,MAAM,cAAc,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;gBACtE,CAAC;gBAED,IAAI,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC7C,OAAO,MAAM,cAAc,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;gBACrE,CAAC;gBAED,OAAO,MAAM,cAAc,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;YACxE,CAAC,CAAC,EAAE,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,GAAI,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACxB,YAAoB,EACpB,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,2BAA2B,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAkB;QAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,OAAkB;QAClE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC,GAAI,CAAC,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAmB;QAC5C,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,kBAAkB,CAAC;QAElE,OAAO,CAAC,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,0BAA0B,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,QAAgB,EAAE,OAAgB;QAC9E,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,6BAA6B,CAAC;YAC3D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,QAAgB,EAAE,OAAgB;QAC7E,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,4BAA4B,CAAC;YAC1D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,QAAgB,EAAE,OAAgB;QAChF,OAAO;YACN,MAAM,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,+BAA+B,CAAC;YAC7D,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,OAAO;SACH,CAAC;IAChB,CAAC"}

package/build/esm/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/esm/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/esm/querier.js

@@ -1,9 +1,27 @@
 import { QueryClient } from '@cosmjs/stargate';
 import { connectComet } from '@cosmjs/tendermint-rpc';
+/**
+ * Extended QueryClient specifically designed for the Cheqd blockchain network.
+ * Provides enhanced querying capabilities with support for custom extensions
+ * and consensus parameter retrieval.
+ */
 export class CheqdQuerier extends QueryClient {
+    /**
+     * Constructs a new CheqdQuerier instance with the provided Comet client.
+     *
+     * @param cometClient - Comet client for blockchain communication
+     */
     constructor(cometClient) {
         super(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 async getConsensusParameters(url) {
         // connect to comet rpc
         const cometClient = await connectComet(url);
@@ -14,17 +32,49 @@ export class CheqdQuerier extends QueryClient {
         // return consensus parameters
         return result.consensusUpdates;
     }
+    /**
+     * 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 async connect(url) {
         const cometClient = await connectComet(url);
         return new CheqdQuerier(cometClient);
     }
+    /**
+     * 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 async fromClient(client) {
         return new CheqdQuerier(client);
     }
+    /**
+     * 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 async connectWithExtension(url, extension) {
         const cometClient = await connectComet(url);
         return CheqdQuerier.withExtensions(cometClient, extension);
     }
+    /**
+     * 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 async connectWithExtensions(url, ...extensions) {
         if (extensions.length === 1)
             return CheqdQuerier.connectWithExtension(url, extensions[0]);

package/build/esm/querier.js.map

@@ -1 +1 @@
-{"version":3,"file":"querier.js","sourceRoot":"","sources":["../../esm/src/querier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAe,YAAY,EAAmB,MAAM,wBAAwB,CAAC;AAGpF,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC5C,YAAY,WAAwB;QACnC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAW;QAC9C,uBAAuB;QACvB,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAE5C,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,YAAY,EAAE,CAAC;QAEhD,0BAA0B;QAC1B,WAAW,CAAC,UAAU,EAAE,CAAC;QAEzB,8BAA8B;QAC9B,OAAO,MAAM,CAAC,gBAAgB,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAW;QAC/B,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,OAAO,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAmB;QAC1C,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAChC,GAAW,EACX,SAA+C;QAE/C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,OAAO,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,qBAAqB,CACjC,GAAW,EACX,GAAG,UAAkD;QAErD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,YAAY,CAAC,oBAAoB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1F,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,UAKjB,CAAC;QACF,OAAO,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC;IAC/D,CAAC;CACD"}
+{"version":3,"file":"querier.js","sourceRoot":"","sources":["../../esm/src/querier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAe,YAAY,EAAmB,MAAM,wBAAwB,CAAC;AAGpF;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC5C;;;;OAIG;IACH,YAAY,WAAwB;QACnC,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,GAAW;QAC9C,uBAAuB;QACvB,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAE5C,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,YAAY,EAAE,CAAC;QAEhD,0BAA0B;QAC1B,WAAW,CAAC,UAAU,EAAE,CAAC;QAEzB,8BAA8B;QAC9B,OAAO,MAAM,CAAC,gBAAgB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAW;QAC/B,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,OAAO,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAmB;QAC1C,OAAO,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAChC,GAAW,EACX,SAA+C;QAE/C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,OAAO,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,CACjC,GAAW,EACX,GAAG,UAAkD;QAErD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,YAAY,CAAC,oBAAoB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1F,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,UAKjB,CAAC;QACF,OAAO,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC;IAC/D,CAAC;CACD"}

package/build/esm/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/esm/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"}

package/build/esm/registry.js

@@ -1,9 +1,23 @@
 import { Registry } from '@cosmjs/proto-signing';
 import { defaultRegistryTypes } from '@cosmjs/stargate';
+/**
+ * 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 function createDefaultCheqdRegistry(customTypes) {
     if (!customTypes)
         customTypes = [];
     return new Registry([...defaultRegistryTypes, ...customTypes]);
 }
+/**
+ * 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 const CheqdRegistry = new Registry(defaultRegistryTypes);
 //# sourceMappingURL=registry.js.map

package/build/esm/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../esm/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAiB,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,UAAU,0BAA0B,CAAC,WAA+C;IACzF,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,EAAE,CAAC;IACnC,OAAO,IAAI,QAAQ,CAAC,CAAC,GAAG,oBAAoB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,QAAQ,CAAC,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../esm/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAiB,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CAAC,WAA+C;IACzF,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,EAAE,CAAC;IACnC,OAAO,IAAI,QAAQ,CAAC,CAAC,GAAG,oBAAoB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,QAAQ,CAAC,oBAAoB,CAAC,CAAC"}

package/build/esm/signer.d.ts

@@ -10,29 +10,115 @@ import { Any } from 'cosmjs-types/google/protobuf/any.js';
 import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin.js';
 import { CheqdQuerier } from './querier.js';
 import { TxExtension } from './types';
+/**
+ * Calculates the transaction fee for DID operations using gas limit and gas price.
+ *
+ * @param gasLimit - Maximum amount of gas units that can be consumed by the transaction
+ * @param gasPrice - Price per gas unit, either as a string or GasPrice object
+ * @returns DidStdFee object containing the calculated fee structure
+ */
 export declare function calculateDidFee(gasLimit: number, gasPrice: string | GasPrice): DidStdFee;
+/**
+ * Creates SignerInfo objects for transaction authentication from signer data.
+ * Each signer info contains the public key, sequence number, and signing mode.
+ *
+ * @param signers - Array of signer objects containing public keys and sequence numbers
+ * @param signMode - Signing mode to use (e.g., SIGN_MODE_DIRECT)
+ * @returns Array of SignerInfo objects for transaction authentication
+ */
 export declare function makeSignerInfos(signers: ReadonlyArray<{
     readonly pubkey: Any;
     readonly sequence: number;
 }>, signMode: SignMode): SignerInfo[];
+/**
+ * Creates encoded AuthInfo bytes for DID transactions with fee payer support.
+ * The AuthInfo contains signer information, fee details, and gas limit.
+ *
+ * @param signers - Array of signer objects with public keys and sequence numbers
+ * @param feeAmount - Array of coins representing the transaction fee
+ * @param gasLimit - Maximum gas units that can be consumed
+ * @param feePayer - Address of the account paying the transaction fees
+ * @param signMode - Signing mode to use, defaults to SIGN_MODE_DIRECT
+ * @returns Encoded AuthInfo as Uint8Array for transaction construction
+ */
 export declare function makeDidAuthInfoBytes(signers: ReadonlyArray<{
     readonly pubkey: Any;
     readonly sequence: number;
 }>, feeAmount: readonly Coin[], gasLimit: bigint, feePayer: string, signMode?: SignMode): Uint8Array;
+/**
+ * Extended SigningStargateClient specifically designed for Cheqd blockchain operations.
+ * Provides enhanced transaction signing, broadcasting, and DID-specific functionality
+ * with support for custom fee payers and advanced retry mechanisms.
+ */
 export declare class CheqdSigningStargateClient extends SigningStargateClient {
+    /** Map of DID signing algorithms for different verification method types */
     private didSigners;
+    /** Gas price configuration for transaction fee calculation */
     private readonly _gasPrice;
+    /** Offline signer instance for transaction signing */
     private readonly _signer;
+    /** RPC endpoint URL for blockchain communication */
     private readonly endpoint?;
+    /** Maximum gas limit allowed for transactions */
     static readonly maxGasLimit: number;
+    /**
+     * Creates a new CheqdSigningStargateClient by establishing a connection to the specified endpoint.
+     * This is the primary factory method for creating a signing client instance.
+     *
+     * @param endpoint - RPC endpoint URL or HttpEndpoint object to connect to
+     * @param signer - Offline signer for transaction signing
+     * @param options - Additional client configuration options including registry and gas price
+     * @returns Promise resolving to a connected CheqdSigningStargateClient instance
+     */
     static connectWithSigner(endpoint: string | HttpEndpoint, signer: OfflineSigner, options?: (SigningStargateClientOptions & {
         endpoint?: string;
     }) | undefined): Promise<CheqdSigningStargateClient>;
+    /**
+     * Constructs a new CheqdSigningStargateClient instance with the provided Comet client and signer.
+     *
+     * @param cometClient - Comet client for blockchain communication
+     * @param signer - Offline signer for transaction signing
+     * @param options - Additional configuration options including registry, gas price, and endpoint
+     */
     constructor(cometClient: CometClient | undefined, signer: OfflineSigner, options?: SigningStargateClientOptions & {
         endpoint?: string;
     });
+    /**
+     * Signs and broadcasts a transaction to the blockchain network.
+     * Supports automatic fee calculation and custom fee payer functionality.
+     *
+     * @param signerAddress - Address of the account signing the transaction
+     * @param messages - Array of messages to include in the transaction
+     * @param fee - Fee configuration: 'auto' for automatic calculation, number for multiplier, or DidStdFee object
+     * @param memo - Optional transaction memo string
+     * @returns Promise resolving to DeliverTxResponse with transaction results
+     * @throws Error if gas price is not set when using automatic fee calculation
+     */
     signAndBroadcast(signerAddress: string, messages: readonly EncodeObject[], fee: DidStdFee | 'auto' | number, memo?: string): Promise<DeliverTxResponse>;
+    /**
+     * Signs a transaction without broadcasting it to the network.
+     * Creates a signed transaction that can be broadcast later.
+     *
+     * @param signerAddress - Address of the account signing the transaction
+     * @param messages - Array of messages to include in the transaction
+     * @param fee - Fee configuration for the transaction
+     * @param memo - Transaction memo string
+     * @param explicitSignerData - Optional explicit signer data to avoid querying the chain
+     * @returns Promise resolving to TxRaw containing the signed transaction
+     */
     sign(signerAddress: string, messages: readonly EncodeObject[], fee: DidStdFee, memo: string, explicitSignerData?: SignerData): Promise<TxRaw>;
+    /**
+     * Internal method for direct signing of transactions using SIGN_MODE_DIRECT.
+     * Handles the low-level transaction construction and signing process.
+     *
+     * @param signerAddress - Address of the account signing the transaction
+     * @param messages - Array of messages to include in the transaction
+     * @param fee - Fee configuration for the transaction
+     * @param memo - Transaction memo string
+     * @param signerData - Account data including number, sequence, and chain ID
+     * @returns Promise resolving to TxRaw containing the signed transaction
+     * @private
+     */
     private _signDirect;
     /**
      * Broadcasts a signed transaction to the network and monitors its inclusion in a block,
@@ -57,9 +143,45 @@ export declare class CheqdSigningStargateClient extends SigningStargateClient {
     broadcastTx(tx: Uint8Array, timeoutMs?: number, pollIntervalMs?: number, maxRetries?: number): Promise<DeliverTxResponse>;
     simulate(signerAddress: string, messages: readonly EncodeObject[], memo: string | undefined): Promise<number>;
     constructSimulateExtension(querier: CheqdQuerier): Promise<TxExtension>;
+    /**
+     * Batches multiple messages into optimal groups based on gas limits.
+     * Simulates each message individually and groups them to maximize throughput
+     * while staying within gas constraints.
+     *
+     * @param messages - Array of messages to batch
+     * @param signerAddress - Address of the account that will sign the transactions
+     * @param memo - Optional transaction memo
+     * @param maxGasLimit - Maximum gas limit per batch, defaults to 30,000,000
+     * @returns Promise resolving to MessageBatch with grouped messages and gas estimates
+     */
     batchMessages(messages: readonly EncodeObject[], signerAddress: string, memo?: string, maxGasLimit?: number): Promise<MessageBatch>;
+    /**
+     * Validates and initializes DID signers for the provided verification methods.
+     * Ensures that all verification method types are supported and assigns appropriate signers.
+     *
+     * @param verificationMethods - Array of verification methods to validate
+     * @returns Promise resolving to the configured signer algorithm map
+     * @throws Error if no verification methods are provided or unsupported types are found
+     */
     checkDidSigners(verificationMethods?: Partial<VerificationMethod>[]): Promise<TSignerAlgo>;
+    /**
+     * Retrieves the appropriate DID signer for a specific verification method.
+     * Looks up the verification method by ID and returns the corresponding signer function.
+     *
+     * @param verificationMethodId - ID of the verification method to get signer for
+     * @param verificationMethods - Array of available verification methods
+     * @returns Promise resolving to a signer function that takes a secret key
+     * @throws Error if the verification method is not found
+     */
     getDidSigner(verificationMethodId: string, verificationMethods: Partial<VerificationMethod>[]): Promise<(secretKey: Uint8Array) => Signer>;
+    /**
+     * Signs a CreateDidDoc transaction payload using the provided signing inputs.
+     * Validates verification methods and creates signatures for each signing input.
+     *
+     * @param signInputs - Array of signing inputs containing verification method IDs and private keys
+     * @param payload - CreateDidDoc payload to sign
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     */
     signCreateDidDocTx(signInputs: ISignInputs[], payload: MsgCreateDidDocPayload): Promise<SignInfo[]>;
     signUpdateDidDocTx(signInputs: ISignInputs[], payload: MsgUpdateDidDocPayload, externalControllers?: DIDDocument[], previousDidDocument?: DIDDocument): Promise<SignInfo[]>;
     signDeactivateDidDocTx(signInputs: ISignInputs[], payload: MsgDeactivateDidDocPayload, verificationMethod: VerificationMethod[]): Promise<SignInfo[]>;