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

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

package/build/cjs/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../cjs/src/types.ts"],"names":[],"mappings":"AAmBA,0CAA0C;AAC1C,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,+CAA+C;IAC/C,mCAAmB,CAAA;IACnB,+CAA+C;IAC/C,mCAAmB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAkGD,4DAA4D;AAC5D,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC9B,oDAAoD;IACpD,iEAA0C,CAAA;IAC1C,oDAAoD;IACpD,iEAA0C,CAAA;IAC1C,wCAAwC;IACxC,6CAAsB,CAAA;AACvB,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B;AAED,sEAAsE;AACtE,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC/B,8BAA8B;IAC9B,4CAAoB,CAAA;IACpB,kBAAkB;IAClB,qCAAa,CAAA;AACd,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AA2GD;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,iFAAiF;IACjF,WAAW,CAAC,MAAgB;QAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;CACD,CAAC;AAEF,+DAA+D;AAC/D,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,oDAAoD;IACpD,8CAA+B,CAAA;AAChC,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/build/cjs/src/utils.d.ts

@@ -0,0 +1,233 @@
+import { IKeyPair, IKeyValuePair, ISignInputs, VerificationMethods, TMethodSpecificId, MethodSpecificIdAlgo, TVerificationKey, TVerificationKeyPrefix, CheqdNetwork, IVerificationKeys, VerificationMethod, DIDDocument, SpecValidationResult, Service } from './types';
+import { KeyPair } from '@stablelib/ed25519-cjs';
+import { DirectSecp256k1HdWallet, DirectSecp256k1Wallet } from '@cosmjs/proto-signing-cjs';
+import { EnglishMnemonic as _ } from '@cosmjs/crypto-cjs';
+import { Service as ProtoService, DidDoc } from '@cheqd/ts-proto-cjs/cheqd/did/v2';
+import { MsgCreateResourcePayload } from '@cheqd/ts-proto-cjs/cheqd/resource/v2';
+import { Coin } from 'cosmjs-types-cjs/cosmos/base/v1beta1/coin';
+import { BackoffOptions } from 'exponential-backoff-cjs';
+/**
+ * Represents an importable Ed25519 key with hexadecimal encoding.
+ * This type ensures type safety for Ed25519 key operations.
+ */
+export type TImportableEd25519Key = {
+    /** Public key in hexadecimal format */
+    publicKeyHex: string;
+    /** Private key in hexadecimal format */
+    privateKeyHex: string;
+    /** Key identifier */
+    kid: string;
+    /** Key type, must be 'Ed25519' */
+    type: 'Ed25519';
+};
+/**
+ * Utility object for validating TImportableEd25519Key objects.
+ * Provides type guard functionality to ensure key structure integrity.
+ */
+export declare const TImportableEd25519Key: {
+    /**
+     * Type guard to validate if an object is a valid TImportableEd25519Key.
+     *
+     * @param key - Object to validate
+     * @returns True if the object is a valid TImportableEd25519Key
+     */
+    isValid(key: any): key is TImportableEd25519Key;
+};
+/**
+ * Compares two arrays of key-value pairs for equality.
+ *
+ * @param kv1 - First array of key-value pairs
+ * @param kv2 - Second array of key-value pairs
+ * @returns True if both arrays contain identical key-value pairs in the same order
+ */
+export declare function isEqualKeyValuePair(kv1: IKeyValuePair[], kv2: IKeyValuePair[]): boolean;
+/**
+ * Extended English mnemonic class with additional validation patterns.
+ * Provides regex pattern matching for mnemonic phrase validation.
+ */
+export declare class EnglishMnemonic extends _ {
+    /** Regular expression pattern for validating English mnemonic phrases */
+    static readonly _mnemonicMatcher: RegExp;
+}
+/**
+ * Creates signing inputs from an importable Ed25519 key by matching it with verification methods.
+ * Supports multiple verification method types and key formats.
+ *
+ * @param key - The Ed25519 key to create signing inputs from
+ * @param verificationMethod - Array of verification methods to match against
+ * @returns Signing inputs containing verification method ID and private key
+ * @throws Error if key validation fails or no matching verification method is found
+ */
+export declare function createSignInputsFromImportableEd25519Key(key: TImportableEd25519Key, verificationMethod: VerificationMethod[]): ISignInputs;
+/**
+ * Creates a raw Ed25519 key pair using the StableLib library.
+ *
+ * @param seed - Optional seed string for deterministic key generation
+ * @returns Raw KeyPair object with publicKey and secretKey as Uint8Arrays
+ */
+export declare function createKeyPairRaw(seed?: string): KeyPair;
+/**
+ * Creates an Ed25519 key pair with Base64-encoded keys.
+ *
+ * @param seed - Optional seed string for deterministic key generation
+ * @returns Key pair with Base64-encoded public and private keys
+ */
+export declare function createKeyPairBase64(seed?: string): IKeyPair;
+/**
+ * Creates an Ed25519 key pair with hexadecimal-encoded keys.
+ *
+ * @param seed - Optional seed string for deterministic key generation
+ * @returns Key pair with hexadecimal-encoded public and private keys
+ */
+export declare function createKeyPairHex(seed?: string): IKeyPair;
+/**
+ * Creates verification keys structure with DID URLs and key identifiers.
+ * Supports multiple algorithm types and network configurations.
+ *
+ * @param publicKey - Public key in base64 or hex format
+ * @param algo - Algorithm for method-specific ID generation
+ * @param keyFragment - Key fragment for the verification key identifier
+ * @param network - Cheqd network (defaults to Testnet)
+ * @param methodSpecificId - Optional pre-computed method-specific ID
+ * @param didUrl - Optional pre-computed DID URL
+ * @returns Verification keys structure with all identifiers
+ * @throws Error if public key format is invalid
+ */
+export declare function createVerificationKeys(publicKey: string, algo: MethodSpecificIdAlgo, keyFragment: TVerificationKey<TVerificationKeyPrefix, number>, network?: CheqdNetwork, methodSpecificId?: TMethodSpecificId, didUrl?: string): IVerificationKeys;
+/**
+ * Creates DID verification methods from verification method types and keys.
+ * Supports Ed25519 keys in multiple formats (multibase, base58, JWK).
+ *
+ * @param verificationMethodTypes - Array of verification method types to create
+ * @param verificationKeys - Array of verification keys corresponding to each type
+ * @returns Array of formatted verification methods for DID documents
+ */
+export declare function createDidVerificationMethod(verificationMethodTypes: VerificationMethods[], verificationKeys: IVerificationKeys[]): VerificationMethod[];
+/**
+ * Creates a complete DID document payload with verification methods and controllers.
+ *
+ * @param verificationMethods - Array of verification methods for the DID
+ * @param verificationKeys - Array of verification keys for authentication
+ * @param controller - Optional array of controller DIDs (defaults to self-controlled)
+ * @returns Complete DID document with all required fields
+ * @throws Error if verification methods or keys are missing
+ */
+export declare function createDidPayload(verificationMethods: VerificationMethod[], verificationKeys: IVerificationKeys[], controller?: string[]): DIDDocument;
+/**
+ * Validates a DID document against the Cheqd specification and converts to protobuf format.
+ * Ensures all required fields are present and verification methods are supported.
+ *
+ * @param didDocument - DID document to validate
+ * @returns Validation result with protobuf conversion or error details
+ */
+export declare function validateSpecCompliantPayload(didDocument: DIDDocument): SpecValidationResult;
+/**
+ * Creates a Cosmos wallet from a seed phrase or private key.
+ * Automatically detects whether the input is a mnemonic phrase or hex-encoded private key.
+ *
+ * @param cosmosPayerSeed - Mnemonic phrase or hexadecimal private key
+ * @returns Promise resolving to DirectSecp256k1HdWallet or DirectSecp256k1Wallet
+ */
+export declare function createCosmosPayerWallet(cosmosPayerSeed: string): Promise<DirectSecp256k1HdWallet | DirectSecp256k1Wallet>;
+/**
+ * Converts a raw Ed25519 public key to multibase format with proper multicodec header.
+ *
+ * @param key - Raw Ed25519 public key as Uint8Array
+ * @returns Multibase-encoded string with Ed25519 multicodec prefix
+ */
+export declare function toMultibaseRaw(key: Uint8Array): import("multiformats-cjs/bases/base").Multibase<"z">;
+/**
+ * Creates a MsgCreateDidDoc payload ready for signing.
+ * Validates the DID document and converts it to protobuf format.
+ *
+ * @param didPayload - DID document to create message payload from
+ * @param versionId - Version identifier for the DID document
+ * @returns Encoded message payload bytes ready for signing
+ */
+export declare function createMsgCreateDidDocPayloadToSign(didPayload: DIDDocument, versionId: string): Promise<Uint8Array<ArrayBuffer>>;
+/** Alias for createMsgCreateDidDocPayloadToSign - used for DID document updates */
+export declare const createMsgUpdateDidDocPayloadToSign: typeof createMsgCreateDidDocPayloadToSign;
+/**
+ * Creates a MsgDeactivateDidDoc payload ready for signing.
+ *
+ * @param didPayload - DID document containing the ID to deactivate
+ * @param versionId - Optional version identifier for the deactivation
+ * @returns Encoded deactivation message payload bytes ready for signing
+ */
+export declare function createMsgDeactivateDidDocPayloadToSign(didPayload: DIDDocument, versionId?: string): Uint8Array<ArrayBuffer>;
+/**
+ * Creates a MsgCreateResource payload ready for signing.
+ *
+ * @param payload - Resource creation payload (partial or complete)
+ * @returns Encoded resource creation message payload bytes ready for signing
+ */
+export declare function createMsgResourcePayloadToSign(payload: Partial<MsgCreateResourcePayload> | MsgCreateResourcePayload): Uint8Array<ArrayBuffer>;
+/**
+ * Derives a Cosmos account address from a hexadecimal public key.
+ * Converts the public key to the appropriate format and generates a bech32 address.
+ *
+ * @param publicKeyHex - Secp256k1 public key in hexadecimal format
+ * @returns Bech32-encoded Cheqd account address
+ */
+export declare function getCosmosAccount(publicKeyHex: string): string;
+/**
+ * Checks the balance of all coins for a given address on the blockchain.
+ *
+ * @param address - Bech32-encoded account address to check balance for
+ * @param rpcAddress - RPC endpoint URL of the blockchain node
+ * @returns Promise resolving to array of coin balances
+ */
+export declare function checkBalance(address: string, rpcAddress: string): Promise<readonly Coin[]>;
+/**
+ * Checks if a given input is valid JSON.
+ *
+ * @param input - Input to validate as JSON
+ * @returns True if the input is a valid JSON string
+ */
+export declare function isJSON(input: any): boolean;
+/** Default configuration options for exponential backoff retry logic */
+export declare const DefaultBackoffOptions: BackoffOptions;
+/**
+ * Retries a function with exponential backoff strategy.
+ * Provides configurable retry logic with jitter and delay options.
+ *
+ * @template T - Return type of the function being retried
+ * @param fn - Async function to retry
+ * @param options - Optional backoff configuration (uses defaults if not provided)
+ * @returns Promise resolving to the function result or undefined if all retries fail
+ */
+export declare function retry<T>(fn: () => Promise<T>, options?: BackoffOptions): Promise<T | undefined>;
+/**
+ * Normalizes the authentication property of a DID document to an array of strings.
+ * Handles both string references and embedded verification method objects.
+ *
+ * @param didDocument - DID document to normalize authentication for
+ * @returns Array of authentication method identifiers
+ * @throws Error if authentication section is missing
+ */
+export declare function normalizeAuthentication(didDocument: DIDDocument): string[];
+/**
+ * Normalizes the controller property of a DID document to an array of strings.
+ * Defaults to self-controlled if no controller is specified.
+ *
+ * @param didDocument - DID document to normalize controller for
+ * @returns Array of controller DID identifiers
+ */
+export declare function normalizeController(didDocument: DIDDocument): string[];
+/**
+ * Normalizes DID document services to protobuf format.
+ * Converts service endpoints to arrays and includes optional properties.
+ *
+ * @param didDocument - DID document containing services to normalize
+ * @returns Array of protobuf-formatted services or undefined if no services
+ */
+export declare function normalizeService(didDocument: DIDDocument): ProtoService[] | undefined;
+/**
+ * Converts protobuf services back to standard DID document service format.
+ * Handles special context requirements for LinkedDomains services.
+ *
+ * @param didDocument - Protobuf DID document containing services to denormalize
+ * @returns Array of standard DID document services
+ */
+export declare function denormalizeService(didDocument: DidDoc): Service[];
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../cjs/src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,QAAQ,EACR,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EAGpB,OAAO,EACP,MAAM,SAAS,CAAC;AAIjB,OAAO,EAA4C,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAC3F,OAAO,EAAE,eAAe,IAAI,CAAC,EAAU,MAAM,oBAAoB,CAAC;AAIlE,OAAO,EAEN,OAAO,IAAI,YAAY,EAGvB,MAAM,EACN,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAGjF,OAAO,EAAE,IAAI,EAAE,MAAM,2CAA2C,CAAC;AACjE,OAAO,EAAW,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,kCAAkC;IAClC,IAAI,EAAE,SAAS,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB;IACjC;;;;;OAKG;iBACU,GAAG,GAAG,GAAG,IAAI,qBAAqB;CAY/C,CAAC;AAKF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,OAAO,CAEvF;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,CAAC;IACrC,yEAAyE;IACzE,gBAAuB,gBAAgB,SAAwB;CAC/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,wCAAwC,CACvD,GAAG,EAAE,qBAAqB,EAC1B,kBAAkB,EAAE,kBAAkB,EAAE,GACtC,WAAW,CA4Cb;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAM3D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAMxD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CACrC,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,EAC1B,WAAW,EAAE,gBAAgB,CAAC,sBAAsB,EAAE,MAAM,CAAC,EAC7D,OAAO,GAAE,YAAmC,EAC5C,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,MAAM,CAAC,EAAE,MAAM,GACb,iBAAiB,CA6BnB;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CAC1C,uBAAuB,EAAE,mBAAmB,EAAE,EAC9C,gBAAgB,EAAE,iBAAiB,EAAE,GACnC,kBAAkB,EAAE,CAkCtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC/B,mBAAmB,EAAE,kBAAkB,EAAE,EACzC,gBAAgB,EAAE,iBAAiB,EAAE,EACrC,UAAU,GAAE,MAAM,EAAO,GACvB,WAAW,CAYb;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAqD3F;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACtC,eAAe,EAAE,MAAM,GACrB,OAAO,CAAC,uBAAuB,GAAG,qBAAqB,CAAC,CAI1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,wDAO7C;AAED;;;;;;;GAOG;AACH,wBAAsB,kCAAkC,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,oCAkBlG;AAED,mFAAmF;AACnF,eAAO,MAAM,kCAAkC,2CAAqC,CAAC;AAErF;;;;;;GAMG;AACH,wBAAgB,sCAAsC,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,MAAM,2BAOjG;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,wBAAwB,2BAEnH;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAIhG;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAQ1C;AAED,wEAAwE;AACxE,eAAO,MAAM,qBAAqB,EAAE,cAO1B,CAAC;AAEX;;;;;;;;GAQG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAkBrG;AA4CD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAS1E;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAItE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,EAAE,GAAG,SAAS,CAYrF;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,EAAE,CAqBjE"}