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

package/build/types/cjs/src/signer.d.ts

@@ -0,0 +1,250 @@
+import { EncodeObject, OfflineSigner } from '@cosmjs/proto-signing-cjs';
+import { DeliverTxResponse, GasPrice, HttpEndpoint, SigningStargateClient, SigningStargateClientOptions, SignerData } from '@cosmjs/stargate-cjs';
+import { Tendermint37Client } from '@cosmjs/tendermint-rpc-cjs';
+import { MsgCreateDidDocPayload, SignInfo, MsgUpdateDidDocPayload, MsgDeactivateDidDocPayload, VerificationMethod } from '@cheqd/ts-proto-cjs/cheqd/did/v2';
+import { DIDDocument, DidStdFee, ISignInputs, MessageBatch, TSignerAlgo, TxExtension } from './types';
+import { Signer } from 'did-jwt-cjs';
+import { SignerInfo, TxRaw } from 'cosmjs-types-cjs/cosmos/tx/v1beta1/tx';
+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,
+     * with support for retrying on failure and graceful timeout handling.
+     *
+     * ## Optimizations over base implementation:
+     * - Implements a retry policy (`maxRetries`, default: 3) to handle transient broadcast errors.
+     * - Prevents double spend by reusing the exact same signed transaction (immutable `Uint8Array`).
+     * - Tracks and returns the last known transaction hash (`txId`), even in the case of timeout or failure.
+     * - Throws a `TimeoutError` if the transaction is not found within `timeoutMs`, attaching the `txHash` if known.
+     * - Polling frequency and timeout are customizable via `pollIntervalMs` and `timeoutMs` parameters.
+     *
+     * @param tx - The signed transaction bytes to broadcast.
+     * @param timeoutMs - Maximum duration (in milliseconds) to wait for block inclusion. Defaults to 60,000 ms.
+     * @param pollIntervalMs - Polling interval (in milliseconds) when checking for transaction inclusion. Defaults to 3,000 ms.
+     * @param maxRetries - Maximum number of times to retry `broadcastTxSync` on failure. Defaults to 3.
+     *
+     * @returns A `Promise` that resolves to `DeliverTxResponse` upon successful inclusion in a block.
+     * @throws `BroadcastTxError` if the transaction is rejected by the node during CheckTx.
+     * @throws `TimeoutError` if the transaction is not found on-chain within the timeout window. Includes `txHash` if available.
+     */
+    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.
+     *
+     * 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.
+     *
+     * @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/types/cjs/src/signer.d.ts.map

@@ -0,0 +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;;;;;;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/types/cjs/src/types.d.ts

@@ -0,0 +1,221 @@
+import { Service as ProtobufService, VerificationMethod as ProtobufVerificationMethod } from '@cheqd/ts-proto-cjs/cheqd/did/v2';
+import { CheqdSDK } from './index';
+import { Coin, EncodeObject } from '@cosmjs/proto-signing-cjs';
+import { Signer } from 'did-jwt-cjs';
+import { QueryClient } from '@cosmjs/stargate-cjs';
+import { DIDDocument, DIDResolutionResult } from 'did-resolver-cjs';
+import { DidExtension } from './modules/did';
+import { ResourceExtension } from './modules/resource';
+import { FeemarketExtension } from './modules/feemarket';
+import { FeeabstractionExtension } from './modules/feeabstraction';
+import { GetTxResponse, SimulateResponse } from 'cosmjs-types-cjs/cosmos/tx/v1beta1/service';
+import { Any } from 'cosmjs-types-cjs/google/protobuf/any';
+import { Pubkey } from '@cosmjs/amino-cjs';
+import { MovingAverage, OracleExtension, WMAStrategy } from './modules/oracle';
+export { DIDDocument, VerificationMethod, Service, ServiceEndpoint, JsonWebKey } from 'did-resolver-cjs';
+/** Supported Cheqd blockchain networks */
+export declare enum CheqdNetwork {
+    /** Production network for live transactions */
+    Mainnet = "mainnet",
+    /** Test network for development and testing */
+    Testnet = "testnet"
+}
+/** Function type for setting up query extensions on a base QueryClient */
+export type QueryExtensionSetup<T> = (base: QueryClient) => T;
+/**
+ * Utility type for creating exclusive extension objects where only one extension can be active at a time.
+ * Ensures type safety when working with mutually exclusive extensions.
+ */
+export type CheqdExtension<K extends string, V = any> = {
+    [P in K]: Record<P, V> & Partial<Record<Exclude<K, P>, never>> extends infer O ? {
+        [Q in keyof O]: O[Q];
+    } : never;
+}[K];
+/** Union type of all supported Cheqd query extensions */
+export type CheqdExtensions = DidExtension | ResourceExtension | FeemarketExtension | FeeabstractionExtension | OracleExtension;
+/**
+ * Extension interface for transaction-related operations.
+ * Provides methods for transaction retrieval and simulation.
+ */
+export interface TxExtension {
+    readonly tx: {
+        /** Retrieves a transaction by its ID */
+        getTx: (txId: string) => Promise<GetTxResponse>;
+        /** Simulates a transaction to estimate gas usage and validate execution */
+        simulate: (messages: readonly Any[], memo: string | undefined, signer: Pubkey, signerAddress: string, sequence: number, gasLimit: number) => Promise<SimulateResponse>;
+    };
+}
+/** Generic interface for module methods that can be executed with variable arguments */
+export interface IModuleMethod {
+    (...args: any[]): Promise<any>;
+}
+/** Map of method names to their corresponding module method implementations */
+export interface IModuleMethodMap extends Record<string, IModuleMethod> {
+}
+/** Context interface providing access to the SDK instance for module methods */
+export interface IContext {
+    sdk: CheqdSDK;
+}
+/** DID document with associated metadata from resolution results */
+export type DIDDocumentWithMetadata = Pick<DIDResolutionResult, 'didDocument' | 'didDocumentMetadata'>;
+/**
+ * Result of DID specification validation containing validation status,
+ * error information, and converted protobuf objects.
+ */
+export type SpecValidationResult = {
+    /** Whether the validation passed */
+    valid: boolean;
+    /** Error message if validation failed */
+    error?: string;
+    /** Converted verification methods in protobuf format */
+    protobufVerificationMethod?: ProtobufVerificationMethod[];
+    /** Converted services in protobuf format */
+    protobufService?: ProtobufService[];
+};
+/**
+ * Result of authentication validation for DID operations,
+ * including resolved external controllers and previous document state.
+ */
+export type AuthenticationValidationResult = {
+    /** Whether the authentication validation passed */
+    valid: boolean;
+    /** Error message if validation failed */
+    error?: string;
+    /** Resolved external controller DID documents */
+    externalControllersDocuments?: DIDDocument[];
+    /** Previous version of the DID document for updates */
+    previousDidDocument?: DIDDocument;
+};
+/**
+ * Batched messages grouped by gas consumption limits,
+ * with corresponding gas estimates for each batch.
+ */
+export type MessageBatch = {
+    /** Array of message batches grouped by gas limits */
+    readonly batches: EncodeObject[][];
+    /** Gas estimates for each corresponding batch */
+    readonly gas: number[];
+};
+/** Supported verification method types for DID documents */
+export declare enum VerificationMethods {
+    /** Ed25519 verification key (2020 specification) */
+    Ed255192020 = "Ed25519VerificationKey2020",
+    /** Ed25519 verification key (2018 specification) */
+    Ed255192018 = "Ed25519VerificationKey2018",
+    /** JSON Web Key (2020 specification) */
+    JWK = "JsonWebKey2020"
+}
+/** Supported algorithms for generating method-specific identifiers */
+export declare enum MethodSpecificIdAlgo {
+    /** Base58 Bitcoin encoding */
+    Base58 = "base58btc",
+    /** UUID format */
+    Uuid = "uuid"
+}
+/** Map of verification method types to their corresponding signer algorithms */
+export type TSignerAlgo = {
+    [key in VerificationMethods as string]?: (secretKey: Uint8Array) => Signer;
+};
+/**
+ * Interface for signing inputs containing verification method details
+ * and the private key required for signing operations.
+ */
+export interface ISignInputs {
+    /** ID of the verification method to use for signing */
+    verificationMethodId: string;
+    /** Type of cryptographic key (Ed25519, Secp256k1, or P256) */
+    keyType?: 'Ed25519' | 'Secp256k1' | 'P256';
+    /** Private key in hexadecimal format */
+    privateKeyHex: string;
+}
+/**
+ * Interface representing a cryptographic key pair with optional algorithm specification.
+ */
+export interface IKeyPair {
+    /** Public key string */
+    publicKey: string;
+    /** Private key string */
+    privateKey: string;
+    /** Optional algorithm used for key generation */
+    algo?: MethodSpecificIdAlgo;
+}
+/** Generic key-value pair interface for flexible data storage */
+export interface IKeyValuePair {
+    /** The key identifier */
+    key: string;
+    /** The associated value (can be any type) */
+    value: any;
+}
+/** String type for verification key prefixes */
+export type TVerificationKeyPrefix = string;
+/** Template literal type for creating verification key identifiers with prefix and number */
+export type TVerificationKey<K extends TVerificationKeyPrefix, N extends number> = `${K}-${N}`;
+/**
+ * Interface for verification key structures with strongly typed DID URLs and key IDs.
+ * Provides type safety for Cheqd DID identifiers and verification key relationships.
+ */
+export interface IVerificationKeys {
+    /** Method-specific identifier for the DID */
+    readonly methodSpecificId: TMethodSpecificId;
+    /** Fully qualified DID URL for the Cheqd network */
+    readonly didUrl: `did:cheqd:${CheqdNetwork}:${IVerificationKeys['methodSpecificId']}` extends string ? string : never;
+    /** Key identifier combining DID URL with verification key fragment */
+    readonly keyId: `${IVerificationKeys['didUrl']}#${TVerificationKey<TVerificationKeyPrefix, number>}`;
+    /** Public key string representation */
+    readonly publicKey: string;
+}
+/** String type representing a method-specific identifier for DIDs */
+export type TMethodSpecificId = string;
+/**
+ * DID-specific fee structure extending standard fee with payer and granter support.
+ * Enables fee delegation and payment by third parties for DID operations.
+ */
+export interface DidStdFee {
+    /** Array of coins representing the fee amount */
+    readonly amount: readonly Coin[];
+    /** Gas limit for the transaction */
+    readonly gas: string;
+    /** Optional address of the account paying the fees */
+    payer?: string;
+    /** Optional address of the account granting fee payment permissions */
+    granter?: string;
+}
+/**
+ * Identity-specific fee options for DID and DLR transactions.
+ * Enables customization of fee payment and slippage tolerance.
+ */
+export interface DidFeeOptions {
+    /** Optional explicit USD amount, otherwise we use lower bound from parameters */
+    wantedAmountUsd?: string;
+    /** Optional slippage in basis points; default is module's defaultSlippageBps */
+    slippageBps?: number;
+    /**
+     * Optional fee denom.
+     * - If 'ncheq': pay in native after oracle conversion.
+     * - If accepted fee-abstraction denom: go through fee-abstraction flow.
+     * - If omitted: pay in native 'ncheq'.
+     */
+    feeDenom?: string;
+    /** Optional gas limit for the transaction */
+    gasLimit?: string;
+    /** Optional moving average type. */
+    movingAverageType?: MovingAverage;
+    /** Optional WMA strategy, if applicable */
+    wmaStrategy?: WMAStrategy;
+    /** Optional weights for WMA strategy CUSTOM, if applicable */
+    wmaWeights?: number[];
+}
+/**
+ * Utility object providing type guard functions for ISignInputs validation.
+ * Contains helper methods to validate and type-check signing input objects.
+ */
+export declare const ISignInputs: {
+    /** Type guard function to check if an object array contains valid ISignInputs */
+    isSignInput(object: Object[]): object is ISignInputs[];
+};
+/** Enumeration of supported service types for DID documents */
+export declare enum ServiceType {
+    /** Service type for linking domain names to DIDs */
+    LinkedDomains = "LinkedDomains"
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../cjs/src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,OAAO,IAAI,eAAe,EAC1B,kBAAkB,IAAI,0BAA0B,EAChD,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC7F,OAAO,EAAE,GAAG,EAAE,MAAM,sCAAsC,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzG,0CAA0C;AAC1C,oBAAY,YAAY;IACvB,+CAA+C;IAC/C,OAAO,YAAY;IACnB,+CAA+C;IAC/C,OAAO,YAAY;CACnB;AAED,0EAA0E;AAC1E,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,KAAK,CAAC,CAAC;AAE9D;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,GAAG,GAAG,IAAI;KACtD,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAAE,GAAG,KAAK;CACjH,CAAC,CAAC,CAAC,CAAC;AAEL,yDAAyD;AACzD,MAAM,MAAM,eAAe,GACxB,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,CAAC;AAEnB;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,EAAE,EAAE;QACZ,wCAAwC;QACxC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;QAChD,2EAA2E;QAC3E,QAAQ,EAAE,CACT,QAAQ,EAAE,SAAS,GAAG,EAAE,EACxB,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,KACZ,OAAO,CAAC,gBAAgB,CAAC,CAAC;KAC/B,CAAC;CACF;AAED,wFAAwF;AACxF,MAAM,WAAW,aAAa;IAC7B,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC/B;AAED,+EAA+E;AAC/E,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC;CAAG;AAE1E,gFAAgF;AAChF,MAAM,WAAW,QAAQ;IACxB,GAAG,EAAE,QAAQ,CAAC;CACd;AAED,oEAAoE;AACpE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,EAAE,aAAa,GAAG,qBAAqB,CAAC,CAAC;AAEvG;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;IACf,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,0BAA0B,CAAC,EAAE,0BAA0B,EAAE,CAAC;IAC1D,4CAA4C;IAC5C,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC5C,mDAAmD;IACnD,KAAK,EAAE,OAAO,CAAC;IACf,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,4BAA4B,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7C,uDAAuD;IACvD,mBAAmB,CAAC,EAAE,WAAW,CAAC;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,CAAC;IACnC,iDAAiD;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,4DAA4D;AAC5D,oBAAY,mBAAmB;IAC9B,oDAAoD;IACpD,WAAW,+BAA+B;IAC1C,oDAAoD;IACpD,WAAW,+BAA+B;IAC1C,wCAAwC;IACxC,GAAG,mBAAmB;CACtB;AAED,sEAAsE;AACtE,oBAAY,oBAAoB;IAC/B,8BAA8B;IAC9B,MAAM,cAAc;IACpB,kBAAkB;IAClB,IAAI,SAAS;CACb;AAED,gFAAgF;AAChF,MAAM,MAAM,WAAW,GAAG;KACxB,GAAG,IAAI,mBAAmB,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,KAAK,MAAM;CAC1E,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,uDAAuD;IACvD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC;IAC3C,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,IAAI,CAAC,EAAE,oBAAoB,CAAC;CAC5B;AAED,iEAAiE;AACjE,MAAM,WAAW,aAAa;IAC7B,yBAAyB;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,KAAK,EAAE,GAAG,CAAC;CACX;AAED,gDAAgD;AAChD,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,6FAA6F;AAC7F,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,sBAAsB,EAAE,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;AAE/F;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,6CAA6C;IAC7C,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAC7C,oDAAoD;IACpD,QAAQ,CAAC,MAAM,EAAE,aAAa,YAAY,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,EAAE,SAAS,MAAM,GACjG,MAAM,GACN,KAAK,CAAC;IACT,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,sBAAsB,EAAE,MAAM,CAAC,EAAE,CAAC;IACrG,uCAAuC;IACvC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAED,qEAAqE;AACrE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC;IACjC,oCAAoC;IACpC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,iFAAiF;IACjF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gFAAgF;IAChF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,aAAa,CAAC;IAClC,2CAA2C;IAC3C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW;IACvB,iFAAiF;wBAC7D,MAAM,EAAE,GAAG,MAAM,IAAI,WAAW,EAAE;CAGtD,CAAC;AAEF,+DAA+D;AAC/D,oBAAY,WAAW;IACtB,oDAAoD;IACpD,aAAa,kBAAkB;CAC/B"}