@cheqd/sdk 5.3.2 → 5.3.3-develop.2

package/build/cjs/registry.d.ts

@@ -1,4 +1,18 @@
 import { Registry, GeneratedType } from '@cosmjs/proto-signing-cjs';
+/**
+ * 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/cjs/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../cjs/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAIpE,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":["../../cjs/src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAIpE;;;;;;;;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/cjs/registry.js

@@ -4,10 +4,24 @@ exports.CheqdRegistry = void 0;
 exports.createDefaultCheqdRegistry = createDefaultCheqdRegistry;
 const proto_signing_cjs_1 = require("@cosmjs/proto-signing-cjs");
 const stargate_cjs_1 = require("@cosmjs/stargate-cjs");
+/**
+ * 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
+ */
 function createDefaultCheqdRegistry(customTypes) {
     if (!customTypes)
         customTypes = [];
     return new proto_signing_cjs_1.Registry([...stargate_cjs_1.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.
+ */
 exports.CheqdRegistry = new proto_signing_cjs_1.Registry(stargate_cjs_1.defaultRegistryTypes);
 //# sourceMappingURL=registry.js.map

package/build/cjs/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../cjs/src/registry.ts"],"names":[],"mappings":";;;AAIA,gEAGC;AAPD,iEAAoE;AAEpE,uDAA4D;AAE5D,SAAgB,0BAA0B,CAAC,WAA+C;IACzF,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,EAAE,CAAC;IACnC,OAAO,IAAI,4BAAQ,CAAC,CAAC,GAAG,mCAAoB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC;AAChE,CAAC;AAEY,QAAA,aAAa,GAAG,IAAI,4BAAQ,CAAC,mCAAoB,CAAC,CAAC"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../cjs/src/registry.ts"],"names":[],"mappings":";;;AAaA,gEAGC;AAhBD,iEAAoE;AAEpE,uDAA4D;AAE5D;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CAAC,WAA+C;IACzF,IAAI,CAAC,WAAW;QAAE,WAAW,GAAG,EAAE,CAAC;IACnC,OAAO,IAAI,4BAAQ,CAAC,CAAC,GAAG,mCAAoB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACU,QAAA,aAAa,GAAG,IAAI,4BAAQ,CAAC,mCAAoB,CAAC,CAAC"}

package/build/cjs/signer.d.ts

@@ -9,29 +9,115 @@ import { SignMode } from 'cosmjs-types-cjs/cosmos/tx/signing/v1beta1/signing';
 import { Any } from 'cosmjs-types-cjs/google/protobuf/any';
 import { Coin } from 'cosmjs-types-cjs/cosmos/base/v1beta1/coin';
 import { CheqdQuerier } from './querier';
+/**
+ * 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: number, 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 - Tendermint client for blockchain communication
+     * @param signer - Offline signer for transaction signing
+     * @param options - Additional configuration options including registry, gas price, and endpoint
+     */
     constructor(cometClient: Tendermint37Client | 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,
@@ -56,6 +142,7 @@ export declare class CheqdSigningStargateClient extends SigningStargateClient {
     broadcastTx(tx: Uint8Array, timeoutMs?: number, pollIntervalMs?: number, maxRetries?: number): Promise<DeliverTxResponse>;
     /**
      * Broadcasts a signed transaction to the network without monitoring it.
+     * Returns the transaction hash immediately after broadcast submission.
      *
      * If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure),
      * an error is thrown.
@@ -63,17 +150,101 @@ export declare class CheqdSigningStargateClient extends SigningStargateClient {
      * If the transaction is broadcasted, a `string` containing the hash of the transaction is returned. The caller then
      * usually needs to check if the transaction was included in a block and was successful.
      *
-     * @returns Returns the hash of the transaction
+     * @param tx - Signed transaction bytes to broadcast
+     * @returns Promise resolving to the hash of the transaction
+     * @throws BroadcastTxError if the transaction is rejected during CheckTx
      */
     broadcastTxSync(tx: Uint8Array): Promise<string>;
+    /**
+     * Simulates transaction execution to estimate gas usage.
+     * Uses the configured endpoint to query the blockchain for gas estimation.
+     *
+     * @param signerAddress - Address of the account that would sign the transaction
+     * @param messages - Array of messages to simulate
+     * @param memo - Transaction memo string
+     * @returns Promise resolving to the estimated gas units required
+     * @throws Error if endpoint is not configured
+     */
     simulate(signerAddress: string, messages: readonly EncodeObject[], memo: string | undefined): Promise<number>;
+    /**
+     * Constructs a transaction extension object for simulation and query operations.
+     * Provides methods for transaction simulation and retrieval.
+     *
+     * @param querier - CheqdQuerier instance for blockchain communication
+     * @returns Promise resolving to TxExtension with simulation and query capabilities
+     */
     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[]>;
+    /**
+     * Signs an UpdateDidDoc transaction payload using the provided signing inputs.
+     * Handles complex verification method resolution including external controllers
+     * and previous DID document verification methods.
+     *
+     * @param signInputs - Array of signing inputs containing verification method IDs and private keys
+     * @param payload - UpdateDidDoc payload to sign
+     * @param externalControllers - Optional external controller DID documents
+     * @param previousDidDocument - Optional previous version of the DID document
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     */
     signUpdateDidDocTx(signInputs: ISignInputs[], payload: MsgUpdateDidDocPayload, externalControllers?: DIDDocument[], previousDidDocument?: DIDDocument): Promise<SignInfo[]>;
+    /**
+     * Signs a DeactivateDidDoc transaction payload using the provided signing inputs.
+     * Validates verification methods and creates signatures for DID deactivation.
+     *
+     * @param signInputs - Array of signing inputs containing verification method IDs and private keys
+     * @param payload - DeactivateDidDoc payload to sign
+     * @param verificationMethod - Array of verification methods for signature validation
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     */
     signDeactivateDidDocTx(signInputs: ISignInputs[], payload: MsgDeactivateDidDocPayload, verificationMethod: VerificationMethod[]): Promise<SignInfo[]>;
+    /**
+     * Static method for signing identity transactions with multiple key types.
+     * Supports Ed25519, Secp256k1, and P256 signature algorithms.
+     *
+     * @param signBytes - Raw bytes to sign
+     * @param signInputs - Array of signing inputs with key types and private keys
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     * @throws Error if key type is undefined or unsupported
+     */
     static signIdentityTx(signBytes: Uint8Array, signInputs: ISignInputs[]): Promise<SignInfo[]>;
 }
 //# sourceMappingURL=signer.d.ts.map

package/build/cjs/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../cjs/src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,YAAY,EAEZ,aAAa,EAIb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACN,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,qBAAqB,EACrB,4BAA4B,EAE5B,UAAU,EAIV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACN,sBAAsB,EACtB,QAAQ,EACR,sBAAsB,EACtB,0BAA0B,EAC1B,kBAAkB,EAElB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,WAAW,EACX,SAAS,EACT,WAAW,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EAEX,MAAM,SAAS,CAAC;AACjB,OAAO,EAA0C,MAAM,EAA6B,MAAM,aAAa,CAAC;AAKxG,OAAO,EAAY,UAAU,EAAE,KAAK,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,oDAAoD,CAAC;AAC9E,OAAO,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,2CAA2C,CAAC;AAEjE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAUzC,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAExF;AAED,wBAAgB,eAAe,CAC9B,OAAO,EAAE,aAAa,CAAC;IAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAC3E,QAAQ,EAAE,QAAQ,GAChB,UAAU,EAAE,CAUd;AAED,wBAAgB,oBAAoB,CACnC,OAAO,EAAE,aAAa,CAAC;IAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAC3E,SAAS,EAAE,SAAS,IAAI,EAAE,EAC1B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,WAA4B,GAClC,UAAU,CAUZ;AAED,qBAAa,0BAA2B,SAAQ,qBAAqB;IACpE,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;IACnC,MAAM,CAAC,QAAQ,CAAC,WAAW,SAA2B;WAElC,iBAAiB,CACpC,QAAQ,EAAE,MAAM,GAAG,YAAY,EAC/B,MAAM,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,CAAC,4BAA4B,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,SAAS,GAC1E,OAAO,CAAC,0BAA0B,CAAC;gBAcrC,WAAW,EAAE,kBAAkB,GAAG,SAAS,EAC3C,MAAM,EAAE,aAAa,EACrB,OAAO,GAAE,4BAA4B,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO;IAQ7D,gBAAgB,CACrB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EAChC,IAAI,SAAK,GACP,OAAO,CAAC,iBAAiB,CAAC;IAkBhB,IAAI,CAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,EAAE,SAAS,EACd,IAAI,EAAE,MAAM,EACZ,kBAAkB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,KAAK,CAAC;YAiBH,WAAW;IAkCzB;;;;;;;;;;;;;;;;;;;OAmBG;IAEU,WAAW,CACvB,EAAE,EAAE,UAAU,EACd,SAAS,SAAS,EAClB,cAAc,SAAQ,EACtB,UAAU,SAAI,GACZ,OAAO,CAAC,iBAAiB,CAAC;IAkG7B;;;;;;;;;;OAUG;IACU,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAYvD,QAAQ,CACb,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,IAAI,EAAE,MAAM,GAAG,SAAS,GACtB,OAAO,CAAC,MAAM,CAAC;IAwBZ,0BAA0B,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAoEvE,aAAa,CAClB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,aAAa,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,GAAE,MAAiB,GAC5B,OAAO,CAAC,YAAY,CAAC;IA+ClB,eAAe,CAAC,mBAAmB,GAAE,OAAO,CAAC,kBAAkB,CAAC,EAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAqB9F,YAAY,CACjB,oBAAoB,EAAE,MAAM,EAC5B,mBAAmB,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,GAChD,OAAO,CAAC,CAAC,SAAS,EAAE,UAAU,KAAK,MAAM,CAAC;IAWvC,kBAAkB,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAoBnG,kBAAkB,CACvB,UAAU,EAAE,WAAW,EAAE,EACzB,OAAO,EAAE,sBAAsB,EAC/B,mBAAmB,CAAC,EAAE,WAAW,EAAE,EACnC,mBAAmB,CAAC,EAAE,WAAW,GAC/B,OAAO,CAAC,QAAQ,EAAE,CAAC;IA6ChB,sBAAsB,CAC3B,UAAU,EAAE,WAAW,EAAE,EACzB,OAAO,EAAE,0BAA0B,EACnC,kBAAkB,EAAE,kBAAkB,EAAE,GACtC,OAAO,CAAC,QAAQ,EAAE,CAAC;WAoBT,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAgClG"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../cjs/src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,YAAY,EAEZ,aAAa,EAIb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACN,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,qBAAqB,EACrB,4BAA4B,EAE5B,UAAU,EAIV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACN,sBAAsB,EACtB,QAAQ,EACR,sBAAsB,EACtB,0BAA0B,EAC1B,kBAAkB,EAElB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,WAAW,EACX,SAAS,EACT,WAAW,EACX,YAAY,EACZ,WAAW,EACX,WAAW,EAEX,MAAM,SAAS,CAAC;AACjB,OAAO,EAA0C,MAAM,EAA6B,MAAM,aAAa,CAAC;AAKxG,OAAO,EAAY,UAAU,EAAE,KAAK,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,oDAAoD,CAAC;AAC9E,OAAO,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,2CAA2C,CAAC;AAEjE,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAUzC;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAExF;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC9B,OAAO,EAAE,aAAa,CAAC;IAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAC3E,QAAQ,EAAE,QAAQ,GAChB,UAAU,EAAE,CAUd;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CACnC,OAAO,EAAE,aAAa,CAAC;IAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAC3E,SAAS,EAAE,SAAS,IAAI,EAAE,EAC1B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,WAA4B,GAClC,UAAU,CAUZ;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACpE,4EAA4E;IAC5E,OAAO,CAAC,UAAU,CAAmB;IACrC,8DAA8D;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAuB;IACjD,sDAAsD;IACtD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,oDAAoD;IACpD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;IACnC,iDAAiD;IACjD,MAAM,CAAC,QAAQ,CAAC,WAAW,SAA2B;IAEtD;;;;;;;;OAQG;WACiB,iBAAiB,CACpC,QAAQ,EAAE,MAAM,GAAG,YAAY,EAC/B,MAAM,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,CAAC,4BAA4B,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,SAAS,GAC1E,OAAO,CAAC,0BAA0B,CAAC;IAatC;;;;;;OAMG;gBAEF,WAAW,EAAE,kBAAkB,GAAG,SAAS,EAC3C,MAAM,EAAE,aAAa,EACrB,OAAO,GAAE,4BAA4B,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAO;IAQnE;;;;;;;;;;OAUG;IACG,gBAAgB,CACrB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EAChC,IAAI,SAAK,GACP,OAAO,CAAC,iBAAiB,CAAC;IAkB7B;;;;;;;;;;OAUG;IACU,IAAI,CAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,EAAE,SAAS,EACd,IAAI,EAAE,MAAM,EACZ,kBAAkB,CAAC,EAAE,UAAU,GAC7B,OAAO,CAAC,KAAK,CAAC;IAiBjB;;;;;;;;;;;OAWG;YACW,WAAW;IAkCzB;;;;;;;;;;;;;;;;;;;OAmBG;IAEU,WAAW,CACvB,EAAE,EAAE,UAAU,EACd,SAAS,SAAS,EAClB,cAAc,SAAQ,EACtB,UAAU,SAAI,GACZ,OAAO,CAAC,iBAAiB,CAAC;IAkG7B;;;;;;;;;;;;;OAaG;IACU,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAY7D;;;;;;;;;OASG;IACG,QAAQ,CACb,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,IAAI,EAAE,MAAM,GAAG,SAAS,GACtB,OAAO,CAAC,MAAM,CAAC;IAwBlB;;;;;;OAMG;IACG,0BAA0B,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAoE7E;;;;;;;;;;OAUG;IACG,aAAa,CAClB,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,aAAa,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,GAAE,MAAiB,GAC5B,OAAO,CAAC,YAAY,CAAC;IA+CxB;;;;;;;OAOG;IACG,eAAe,CAAC,mBAAmB,GAAE,OAAO,CAAC,kBAAkB,CAAC,EAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAqBpG;;;;;;;;OAQG;IACG,YAAY,CACjB,oBAAoB,EAAE,MAAM,EAC5B,mBAAmB,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,GAChD,OAAO,CAAC,CAAC,SAAS,EAAE,UAAU,KAAK,MAAM,CAAC;IAW7C;;;;;;;OAOG;IACG,kBAAkB,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAoBzG;;;;;;;;;;OAUG;IACG,kBAAkB,CACvB,UAAU,EAAE,WAAW,EAAE,EACzB,OAAO,EAAE,sBAAsB,EAC/B,mBAAmB,CAAC,EAAE,WAAW,EAAE,EACnC,mBAAmB,CAAC,EAAE,WAAW,GAC/B,OAAO,CAAC,QAAQ,EAAE,CAAC;IA6CtB;;;;;;;;OAQG;IACG,sBAAsB,CAC3B,UAAU,EAAE,WAAW,EAAE,EACzB,OAAO,EAAE,0BAA0B,EACnC,kBAAkB,EAAE,kBAAkB,EAAE,GACtC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAoBtB;;;;;;;;OAQG;WACU,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAgClG"}

package/build/cjs/signer.js

@@ -25,9 +25,24 @@ const querier_1 = require("./querier");
 const math_cjs_2 = require("@cosmjs/math-cjs");
 const service_1 = require("cosmjs-types-cjs/cosmos/tx/v1beta1/service");
 const tx_js_1 = require("cosmjs-types/cosmos/tx/v1beta1/tx.js");
+/**
+ * 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
+ */
 function calculateDidFee(gasLimit, gasPrice) {
     return (0, stargate_cjs_1.calculateFee)(gasLimit, gasPrice);
 }
+/**
+ * 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
+ */
 function makeSignerInfos(signers, signMode) {
     return signers.map(({ pubkey, sequence }) => ({
         publicKey: pubkey,
@@ -37,6 +52,17 @@ function makeSignerInfos(signers, signMode) {
         sequence: long_cjs_1.default.fromNumber(sequence),
     }));
 }
+/**
+ * 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
+ */
 function makeDidAuthInfoBytes(signers, feeAmount, gasLimit, feePayer, signMode = signing_1.SignMode.SIGN_MODE_DIRECT) {
     const authInfo = {
         signerInfos: makeSignerInfos(signers, signMode),
@@ -48,12 +74,31 @@ function makeDidAuthInfoBytes(signers, feeAmount, gasLimit, feePayer, signMode =
     };
     return tx_1.AuthInfo.encode(tx_1.AuthInfo.fromPartial(authInfo)).finish();
 }
+/**
+ * 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.
+ */
 class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
+    /** Map of DID signing algorithms for different verification method types */
     didSigners = {};
+    /** Gas price configuration for transaction fee calculation */
     _gasPrice;
+    /** Offline signer instance for transaction signing */
     _signer;
+    /** RPC endpoint URL for blockchain communication */
     endpoint;
+    /** Maximum gas limit allowed for transactions */
     static maxGasLimit = Number.MAX_SAFE_INTEGER;
+    /**
+     * 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 async connectWithSigner(endpoint, signer, options) {
         const cometClient = await tendermint_rpc_cjs_1.Tendermint37Client.connect(endpoint);
         return new CheqdSigningStargateClient(cometClient, signer, {
@@ -66,12 +111,30 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
             ...options,
         });
     }
+    /**
+     * Constructs a new CheqdSigningStargateClient instance with the provided Comet client and signer.
+     *
+     * @param cometClient - Tendermint client for blockchain communication
+     * @param signer - Offline signer for transaction signing
+     * @param options - Additional configuration options including registry, gas price, and endpoint
+     */
     constructor(cometClient, signer, options = {}) {
         super(cometClient, signer, options);
         this._signer = signer;
         this._gasPrice = options.gasPrice;
         this.endpoint = options.endpoint;
     }
+    /**
+     * 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
+     */
     async signAndBroadcast(signerAddress, messages, fee, memo = '') {
         let usedFee;
         if (fee == 'auto' || typeof fee === 'number') {
@@ -90,6 +153,17 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         const txBytes = tx_1.TxRaw.encode(txRaw).finish();
         return this.broadcastTx(txBytes, this.broadcastTimeoutMs, this.broadcastPollIntervalMs);
     }
+    /**
+     * 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
+     */
     async sign(signerAddress, messages, fee, memo, explicitSignerData) {
         let signerData;
         if (explicitSignerData) {
@@ -106,6 +180,18 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         }
         return this._signDirect(signerAddress, messages, fee, memo, signerData);
     }
+    /**
+     * 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
+     */
     async _signDirect(signerAddress, messages, fee, memo, { accountNumber, sequence, chainId }) {
         (0, utils_cjs_1.assert)((0, proto_signing_cjs_1.isOfflineDirectSigner)(this._signer));
         const accountFromSigner = (await this._signer.getAccounts()).find((account) => account.address === signerAddress);
@@ -223,6 +309,7 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
     }
     /**
      * Broadcasts a signed transaction to the network without monitoring it.
+     * Returns the transaction hash immediately after broadcast submission.
      *
      * If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure),
      * an error is thrown.
@@ -230,7 +317,9 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
      * If the transaction is broadcasted, a `string` containing the hash of the transaction is returned. The caller then
      * usually needs to check if the transaction was included in a block and was successful.
      *
-     * @returns Returns the hash of the transaction
+     * @param tx - Signed transaction bytes to broadcast
+     * @returns Promise resolving to the hash of the transaction
+     * @throws BroadcastTxError if the transaction is rejected during CheckTx
      */
     async broadcastTxSync(tx) {
         const broadcasted = await this.forceGetTmClient().broadcastTxSync({ tx });
@@ -240,6 +329,16 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         const transactionId = (0, encoding_cjs_1.toHex)(broadcasted.hash).toUpperCase();
         return transactionId;
     }
+    /**
+     * Simulates transaction execution to estimate gas usage.
+     * Uses the configured endpoint to query the blockchain for gas estimation.
+     *
+     * @param signerAddress - Address of the account that would sign the transaction
+     * @param messages - Array of messages to simulate
+     * @param memo - Transaction memo string
+     * @returns Promise resolving to the estimated gas units required
+     * @throws Error if endpoint is not configured
+     */
     async simulate(signerAddress, messages, memo) {
         if (!this.endpoint) {
             throw new Error('querier: endpoint is not set');
@@ -259,6 +358,13 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         (0, utils_cjs_1.assertDefined)(gasInfo);
         return math_cjs_2.Uint53.fromString(gasInfo.gasUsed.toString()).toNumber();
     }
+    /**
+     * Constructs a transaction extension object for simulation and query operations.
+     * Provides methods for transaction simulation and retrieval.
+     *
+     * @param querier - CheqdQuerier instance for blockchain communication
+     * @returns Promise resolving to TxExtension with simulation and query capabilities
+     */
     async constructSimulateExtension(querier) {
         // setup rpc client
         const rpc = (0, stargate_cjs_1.createProtobufRpcClient)(querier);
@@ -312,6 +418,17 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
             },
         };
     }
+    /**
+     * 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
+     */
     async batchMessages(messages, signerAddress, memo, maxGasLimit = 30000000 // default gas limit, use consensus params if available
     ) {
         // simulate
@@ -351,6 +468,14 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
                 gas: gasPerBatch,
             };
     }
+    /**
+     * 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
+     */
     async checkDidSigners(verificationMethods = []) {
         if (verificationMethods.length === 0) {
             throw new Error('No verification methods provided');
@@ -365,6 +490,15 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         });
         return this.didSigners;
     }
+    /**
+     * 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
+     */
     async getDidSigner(verificationMethodId, verificationMethods) {
         await this.checkDidSigners(verificationMethods);
         const verificationMethod = verificationMethods.find((method) => method.id === verificationMethodId)?.verificationMethodType;
@@ -373,6 +507,14 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         }
         return this.didSigners[verificationMethod];
     }
+    /**
+     * 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
+     */
     async signCreateDidDocTx(signInputs, payload) {
         await this.checkDidSigners(payload?.verificationMethod);
         const signBytes = v2_1.MsgCreateDidDocPayload.encode(payload).finish();
@@ -384,6 +526,17 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         }));
         return signInfos;
     }
+    /**
+     * Signs an UpdateDidDoc transaction payload using the provided signing inputs.
+     * Handles complex verification method resolution including external controllers
+     * and previous DID document verification methods.
+     *
+     * @param signInputs - Array of signing inputs containing verification method IDs and private keys
+     * @param payload - UpdateDidDoc payload to sign
+     * @param externalControllers - Optional external controller DID documents
+     * @param previousDidDocument - Optional previous version of the DID document
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     */
     async signUpdateDidDocTx(signInputs, payload, externalControllers, previousDidDocument) {
         await this.checkDidSigners(payload?.verificationMethod);
         const signBytes = v2_1.MsgUpdateDidDocPayload.encode(payload).finish();
@@ -413,6 +566,15 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         }));
         return signInfos;
     }
+    /**
+     * Signs a DeactivateDidDoc transaction payload using the provided signing inputs.
+     * Validates verification methods and creates signatures for DID deactivation.
+     *
+     * @param signInputs - Array of signing inputs containing verification method IDs and private keys
+     * @param payload - DeactivateDidDoc payload to sign
+     * @param verificationMethod - Array of verification methods for signature validation
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     */
     async signDeactivateDidDocTx(signInputs, payload, verificationMethod) {
         await this.checkDidSigners(verificationMethod);
         const signBytes = v2_1.MsgDeactivateDidDocPayload.encode(payload).finish();
@@ -424,6 +586,15 @@ class CheqdSigningStargateClient extends stargate_cjs_1.SigningStargateClient {
         }));
         return signInfos;
     }
+    /**
+     * Static method for signing identity transactions with multiple key types.
+     * Supports Ed25519, Secp256k1, and P256 signature algorithms.
+     *
+     * @param signBytes - Raw bytes to sign
+     * @param signInputs - Array of signing inputs with key types and private keys
+     * @returns Promise resolving to array of SignInfo objects with signatures
+     * @throws Error if key type is undefined or unsupported
+     */
     static async signIdentityTx(signBytes, signInputs) {
         let signInfos = [];
         for (let signInput of signInputs) {