@cheqd/sdk-esm 5.3.4-develop.2

package/build/types.js

@@ -0,0 +1,43 @@
+/** Supported Cheqd blockchain networks */
+export var CheqdNetwork;
+(function (CheqdNetwork) {
+    /** Production network for live transactions */
+    CheqdNetwork["Mainnet"] = "mainnet";
+    /** Test network for development and testing */
+    CheqdNetwork["Testnet"] = "testnet";
+})(CheqdNetwork || (CheqdNetwork = {}));
+/** Supported verification method types for DID documents */
+export var VerificationMethods;
+(function (VerificationMethods) {
+    /** Ed25519 verification key (2020 specification) */
+    VerificationMethods["Ed255192020"] = "Ed25519VerificationKey2020";
+    /** Ed25519 verification key (2018 specification) */
+    VerificationMethods["Ed255192018"] = "Ed25519VerificationKey2018";
+    /** JSON Web Key (2020 specification) */
+    VerificationMethods["JWK"] = "JsonWebKey2020";
+})(VerificationMethods || (VerificationMethods = {}));
+/** Supported algorithms for generating method-specific identifiers */
+export var MethodSpecificIdAlgo;
+(function (MethodSpecificIdAlgo) {
+    /** Base58 Bitcoin encoding */
+    MethodSpecificIdAlgo["Base58"] = "base58btc";
+    /** UUID format */
+    MethodSpecificIdAlgo["Uuid"] = "uuid";
+})(MethodSpecificIdAlgo || (MethodSpecificIdAlgo = {}));
+/**
+ * Utility object providing type guard functions for ISignInputs validation.
+ * Contains helper methods to validate and type-check signing input objects.
+ */
+export const ISignInputs = {
+    /** Type guard function to check if an object array contains valid ISignInputs */
+    isSignInput(object) {
+        return object.some((x) => 'privateKeyHex' in x);
+    },
+};
+/** Enumeration of supported service types for DID documents */
+export var ServiceType;
+(function (ServiceType) {
+    /** Service type for linking domain names to DIDs */
+    ServiceType["LinkedDomains"] = "LinkedDomains";
+})(ServiceType || (ServiceType = {}));
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAkBA,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;AA8FD,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;AAiFD;;;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/utils.d.ts

@@ -0,0 +1,223 @@
+import { IKeyPair, IKeyValuePair, ISignInputs, VerificationMethods, TMethodSpecificId, MethodSpecificIdAlgo, TVerificationKey, TVerificationKeyPrefix, CheqdNetwork, IVerificationKeys, VerificationMethod, DIDDocument, SpecValidationResult, Service } from './types.js';
+import { KeyPair } from '@stablelib/ed25519';
+import { DirectSecp256k1HdWallet, DirectSecp256k1Wallet } from '@cosmjs/proto-signing';
+import { EnglishMnemonic as _ } from '@cosmjs/crypto';
+import { Service as ProtoService, DidDoc } from '@cheqd/ts-proto/cheqd/did/v2/index.js';
+import { MsgCreateResourcePayload } from '@cheqd/ts-proto/cheqd/resource/v2/index.js';
+import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin';
+import { BackoffOptions } from 'exponential-backoff';
+/**
+ * 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.
+ * Supports both HD wallets from mnemonics and direct key wallets.
+ *
+ * @param cosmosPayerSeed - Mnemonic phrase or private key hex string
+ * @returns Promise resolving to either HD wallet or direct key wallet
+ */
+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): string;
+/**
+ * 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 DID document
+ * @returns Encoded message payload bytes ready for signing
+ */
+export declare function createMsgDeactivateDidDocPayloadToSign(didPayload: DIDDocument, versionId?: string): Uint8Array<ArrayBuffer>;
+/**
+ * Creates a resource payload ready for signing.
+ *
+ * @param payload - Resource payload to encode
+ * @returns Encoded resource payload bytes ready for signing
+ */
+export declare function createMsgResourcePayloadToSign(payload: Partial<MsgCreateResourcePayload> | MsgCreateResourcePayload): Uint8Array<ArrayBuffer>;
+/**
+ * Converts a public key to a Cosmos account address.
+ *
+ * @param publicKeyHex - Public key in hexadecimal format
+ * @returns Bech32-encoded Cosmos account address with 'cheqd' prefix
+ */
+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;
+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.
+ * Extracts authentication method identifiers from mixed string/object format.
+ *
+ * @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/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../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,EAEpB,OAAO,EAEP,MAAM,YAAY,CAAC;AAIpB,OAAO,EAA4C,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,eAAe,IAAI,CAAC,EAAU,MAAM,gBAAgB,CAAC;AAI9D,OAAO,EAEN,OAAO,IAAI,YAAY,EAGvB,MAAM,EACN,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AAGtF,OAAO,EAAE,IAAI,EAAE,MAAM,uCAAuC,CAAC;AAC7D,OAAO,EAAW,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE9D;;;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,CAiD3F;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,UAO7C;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;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAGhG;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAQ1C;AAED,wEAAwE;AACxE,eAAO,MAAM,qBAAqB,EAAE,cAO1B,CAAC;AAEX,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;AA8BD;;;;;;;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,CAmBjE"}