@docknetwork/wallet-sdk-wasm 1.5.11 → 1.7.0

package/lib/services/blockchain/service.js

@@ -13,19 +13,43 @@ var core_logger = require('../../core/logger.js');
 var modules_eventManager = require('../../modules/event-manager.js');
 var services_utilCrypto_service = require('../util-crypto/service.js');
 var types = require('@docknetwork/credential-sdk/types');
+var services_blockchain_cachedDidResolver = require('./cached-did-resolver.js');
 require('assert');
 require('@docknetwork/credential-sdk/utils');
 require('@scure/bip39');
 require('@scure/bip39/wordlists/english');
 require('../util-crypto/configs.js');
+require('../storage/index.js');
+require('../storage/service.js');
+require('../storage/service-rpc.js');
+require('../rpc-service-client.js');
+require('../../rpc-client.js');
+require('json-rpc-2.0');
+require('../../core/crypto.js');
+require('crypto');
+require('../../logger.js');
+require('../../rpc-util.js');
 
 // @ts-nocheck
+/**
+ * Universal resolver URL for DID resolution fallback
+ * @constant {string}
+ */
 const universalResolverUrl = 'https://uniresolver.truvera.io';
+/**
+ * Resolver that accepts any DID method using wildcard matching
+ * @class
+ * @extends ResolverRouter
+ * @private
+ */
 class AnyDIDResolver extends resolver.ResolverRouter {
     method = resolver.WILDCARD;
 }
 /**
- *
+ * Main blockchain service class for managing blockchain connections and DID resolution
+ * @class
+ * @description Provides methods for connecting to Cheqd blockchain, resolving DIDs,
+ * and managing blockchain-related operations
  */
 class BlockchainService {
     dock;
@@ -34,6 +58,12 @@ class BlockchainService {
     cheqdApiUrl;
     isBlockchainReady = false;
     resolver;
+    /**
+     * Event names emitted by the blockchain service
+     * @static
+     * @readonly
+     * @property {string} BLOCKCHAIN_READY - Emitted when blockchain connection is established
+     */
     static Events = {
         BLOCKCHAIN_READY: 'blockchain-ready',
     };
@@ -43,7 +73,15 @@ class BlockchainService {
         BlockchainService.prototype.init,
         BlockchainService.prototype.isApiConnected,
         BlockchainService.prototype.getAddress,
+        BlockchainService.prototype.resolveDID,
+        BlockchainService.prototype.getCachedDIDs,
+        BlockchainService.prototype.clearCache,
+        BlockchainService.prototype.getCacheEntry,
     ];
+    /**
+     * Creates a new BlockchainService instance
+     * @constructor
+     */
     constructor() {
         this.name = 'blockchain';
         this.cheqdApi = new cheqdBlockchainApi.CheqdAPI();
@@ -52,6 +90,15 @@ class BlockchainService {
         this.emitter = new events.EventEmitter();
         this.resolver = this.createDIDResolver();
     }
+    /**
+     * Gets the types and modules needed for DID or accumulator operations
+     * @param {string} didOrRegistryId - DID or registry identifier
+     * @returns {Object} Object containing accumulator-related types and modules
+     * @returns {typeof AccumulatorPublicKey} returns.PublicKey - Accumulator public key type
+     * @returns {typeof AccumulatorId} returns.AccumulatorId - Accumulator ID type
+     * @returns {typeof AccumulatorCommon} returns.AccumulatorCommon - Common accumulator type
+     * @returns {Object} returns.AccumulatorModule - Accumulator module instance
+     */
     getTypesForDIDOrAccumulator(didOrRegistryId) {
         return {
             PublicKey: types.AccumulatorPublicKey,
@@ -61,26 +108,67 @@ class BlockchainService {
         };
     }
     /**
-     *
-     * @returns
+     * Ensures the blockchain connection is ready before proceeding
+     * @returns {Promise<void>} Resolves when blockchain is ready
+     * @example
+     * await blockchainService.ensureBlockchainReady();
+     * // Blockchain is now connected and ready
      */
     async ensureBlockchainReady() {
-        if (this.isBlockchainReady) {
+        if (await this.isApiConnected()) {
             return;
         }
         return modules_eventManager.once(this.emitter, BlockchainService.Events.BLOCKCHAIN_READY);
     }
+    /**
+     * Gets the cached DIDs
+     * @returns {Promise<string[]>} Cached DIDs
+     */
+    getCachedDIDs() {
+        return this.resolver.getCachedDIDs();
+    }
+    /**
+     * Gets the cached DID resolution data
+     * @param {string} did - The DID to get the cache entry for
+     * @returns {Promise<any>} Cached DID resolution data
+     */
+    getCacheEntry(did) {
+        return this.resolver.getCacheEntry(did);
+    }
+    /**
+     * Clears cached data for a specific DID
+     * @param {string} did - The DID to clear from cache
+     * @returns {void}
+     */
+    clearCache(did) {
+        return this.resolver.clearCache(did);
+    }
+    /**
+     * Creates a DID resolver with caching support
+     * @private
+     * @returns {CachedDIDResolver} Cached DID resolver instance
+     */
     createDIDResolver() {
-        return new AnyDIDResolver([
+        const router = new AnyDIDResolver([
             new resolver.DIDKeyResolver(),
             new resolver.CoreResolver(this.modules),
             new resolver.UniversalResolver(universalResolverUrl),
         ]);
+        return new services_blockchain_cachedDidResolver.CachedDIDResolver(router);
     }
     /**
-     *
-     * @param {*} params
-     * @returns
+     * Initializes the blockchain service with connection parameters
+     * @param {InitParams} params - Initialization parameters
+     * @param {string} params.cheqdApiUrl - URL of the Cheqd API endpoint
+     * @param {string} [params.networkId] - Cheqd network identifier
+     * @param {string} [params.cheqdMnemonic] - Mnemonic for Cheqd wallet (auto-generated if not provided)
+     * @returns {Promise<boolean>} True if initialization successful
+     * @throws {Error} If cheqdApiUrl is not provided
+     * @example
+     * await blockchainService.init({
+     *   cheqdApiUrl: 'https://api.cheqd.network',
+     *   networkId: 'mainnet'
+     * });
      */
     async init(params) {
         if (!params?.cheqdApiUrl) {
@@ -122,8 +210,10 @@ class BlockchainService {
         return true;
     }
     /**
-     *
-     * @returns
+     * Disconnects from the blockchain
+     * @returns {Promise<void>} Resolves when disconnection is complete
+     * @example
+     * await blockchainService.disconnect();
      */
     async disconnect() {
         let result;
@@ -133,6 +223,11 @@ class BlockchainService {
         this._setBlockchainReady(false);
         return result;
     }
+    /**
+     * Waits for the blockchain to be ready
+     * @returns {Promise<void>} Resolves when blockchain is ready
+     * @private
+     */
     async waitBlockchainReady() {
         return new Promise(resolve => {
             if (this.isBlockchainReady) {
@@ -144,15 +239,38 @@ class BlockchainService {
         });
     }
     /**
-     *
-     * @returns
+     * Resolves a DID to its document
+     * @param {string} did - The DID to resolve
+     * @returns {Promise<Object>} The resolved DID document
+     * @example
+     * const didDoc = await blockchainService.resolveDID('did:key:z6Mk...');
+     */
+    async resolveDID(did) {
+        return this.resolver.resolve(did);
+    }
+    /**
+     * Checks if the blockchain API is connected
+     * @returns {Promise<boolean>} True if connected, false otherwise
+     * @example
+     * const isConnected = await blockchainService.isApiConnected();
      */
     async isApiConnected() {
         return this.cheqdApi.isInitialized();
     }
+    /**
+     * Gets the current Cheqd API URL
+     * @returns {Promise<string>} The Cheqd API URL
+     * @example
+     * const apiUrl = await blockchainService.getAddress();
+     */
     async getAddress() {
         return this.cheqdApiUrl;
     }
+    /**
+     * Sets the blockchain ready state and emits events
+     * @private
+     * @param {boolean} isBlockchainReady - Whether blockchain is ready
+     */
     _setBlockchainReady(isBlockchainReady) {
         this.isBlockchainReady = isBlockchainReady;
         if (isBlockchainReady) {
@@ -160,6 +278,20 @@ class BlockchainService {
         }
     }
 }
+/**
+ * Singleton instance of the blockchain service
+ * @type {BlockchainService}
+ * @example
+ * import { blockchainService } from '@docknetwork/wallet-sdk-wasm/services/blockchain';
+ *
+ * // Initialize the service
+ * await blockchainService.init({
+ *   cheqdApiUrl: 'https://api.cheqd.network'
+ * });
+ *
+ * // Resolve a DID
+ * const didDoc = await blockchainService.resolveDID('did:key:z6Mk...');
+ */
 const blockchainService = new BlockchainService();
 
 exports.BlockchainService = BlockchainService;

package/lib/services/blockchain/service.mjs

@@ -9,19 +9,43 @@ import { Logger } from '../../core/logger.mjs';
 import { once } from '../../modules/event-manager.mjs';
 import { utilCryptoService } from '../util-crypto/service.mjs';
 import { AccumulatorPublicKey, AccumulatorId, AccumulatorCommon } from '@docknetwork/credential-sdk/types';
+import { CachedDIDResolver } from './cached-did-resolver.mjs';
 import 'assert';
 import '@docknetwork/credential-sdk/utils';
 import '@scure/bip39';
 import '@scure/bip39/wordlists/english';
 import '../util-crypto/configs.mjs';
+import '../storage/index.mjs';
+import '../storage/service.mjs';
+import '../storage/service-rpc.mjs';
+import '../rpc-service-client.mjs';
+import '../../rpc-client.mjs';
+import 'json-rpc-2.0';
+import '../../core/crypto.mjs';
+import 'crypto';
+import '../../logger.mjs';
+import '../../rpc-util.mjs';
 
 // @ts-nocheck
+/**
+ * Universal resolver URL for DID resolution fallback
+ * @constant {string}
+ */
 const universalResolverUrl = 'https://uniresolver.truvera.io';
+/**
+ * Resolver that accepts any DID method using wildcard matching
+ * @class
+ * @extends ResolverRouter
+ * @private
+ */
 class AnyDIDResolver extends ResolverRouter {
     method = WILDCARD;
 }
 /**
- *
+ * Main blockchain service class for managing blockchain connections and DID resolution
+ * @class
+ * @description Provides methods for connecting to Cheqd blockchain, resolving DIDs,
+ * and managing blockchain-related operations
  */
 class BlockchainService {
     dock;
@@ -30,6 +54,12 @@ class BlockchainService {
     cheqdApiUrl;
     isBlockchainReady = false;
     resolver;
+    /**
+     * Event names emitted by the blockchain service
+     * @static
+     * @readonly
+     * @property {string} BLOCKCHAIN_READY - Emitted when blockchain connection is established
+     */
     static Events = {
         BLOCKCHAIN_READY: 'blockchain-ready',
     };
@@ -39,7 +69,15 @@ class BlockchainService {
         BlockchainService.prototype.init,
         BlockchainService.prototype.isApiConnected,
         BlockchainService.prototype.getAddress,
+        BlockchainService.prototype.resolveDID,
+        BlockchainService.prototype.getCachedDIDs,
+        BlockchainService.prototype.clearCache,
+        BlockchainService.prototype.getCacheEntry,
     ];
+    /**
+     * Creates a new BlockchainService instance
+     * @constructor
+     */
     constructor() {
         this.name = 'blockchain';
         this.cheqdApi = new CheqdAPI();
@@ -48,6 +86,15 @@ class BlockchainService {
         this.emitter = new EventEmitter();
         this.resolver = this.createDIDResolver();
     }
+    /**
+     * Gets the types and modules needed for DID or accumulator operations
+     * @param {string} didOrRegistryId - DID or registry identifier
+     * @returns {Object} Object containing accumulator-related types and modules
+     * @returns {typeof AccumulatorPublicKey} returns.PublicKey - Accumulator public key type
+     * @returns {typeof AccumulatorId} returns.AccumulatorId - Accumulator ID type
+     * @returns {typeof AccumulatorCommon} returns.AccumulatorCommon - Common accumulator type
+     * @returns {Object} returns.AccumulatorModule - Accumulator module instance
+     */
     getTypesForDIDOrAccumulator(didOrRegistryId) {
         return {
             PublicKey: AccumulatorPublicKey,
@@ -57,26 +104,67 @@ class BlockchainService {
         };
     }
     /**
-     *
-     * @returns
+     * Ensures the blockchain connection is ready before proceeding
+     * @returns {Promise<void>} Resolves when blockchain is ready
+     * @example
+     * await blockchainService.ensureBlockchainReady();
+     * // Blockchain is now connected and ready
      */
     async ensureBlockchainReady() {
-        if (this.isBlockchainReady) {
+        if (await this.isApiConnected()) {
             return;
         }
         return once(this.emitter, BlockchainService.Events.BLOCKCHAIN_READY);
     }
+    /**
+     * Gets the cached DIDs
+     * @returns {Promise<string[]>} Cached DIDs
+     */
+    getCachedDIDs() {
+        return this.resolver.getCachedDIDs();
+    }
+    /**
+     * Gets the cached DID resolution data
+     * @param {string} did - The DID to get the cache entry for
+     * @returns {Promise<any>} Cached DID resolution data
+     */
+    getCacheEntry(did) {
+        return this.resolver.getCacheEntry(did);
+    }
+    /**
+     * Clears cached data for a specific DID
+     * @param {string} did - The DID to clear from cache
+     * @returns {void}
+     */
+    clearCache(did) {
+        return this.resolver.clearCache(did);
+    }
+    /**
+     * Creates a DID resolver with caching support
+     * @private
+     * @returns {CachedDIDResolver} Cached DID resolver instance
+     */
     createDIDResolver() {
-        return new AnyDIDResolver([
+        const router = new AnyDIDResolver([
             new DIDKeyResolver(),
             new CoreResolver(this.modules),
             new UniversalResolver(universalResolverUrl),
         ]);
+        return new CachedDIDResolver(router);
     }
     /**
-     *
-     * @param {*} params
-     * @returns
+     * Initializes the blockchain service with connection parameters
+     * @param {InitParams} params - Initialization parameters
+     * @param {string} params.cheqdApiUrl - URL of the Cheqd API endpoint
+     * @param {string} [params.networkId] - Cheqd network identifier
+     * @param {string} [params.cheqdMnemonic] - Mnemonic for Cheqd wallet (auto-generated if not provided)
+     * @returns {Promise<boolean>} True if initialization successful
+     * @throws {Error} If cheqdApiUrl is not provided
+     * @example
+     * await blockchainService.init({
+     *   cheqdApiUrl: 'https://api.cheqd.network',
+     *   networkId: 'mainnet'
+     * });
      */
     async init(params) {
         if (!params?.cheqdApiUrl) {
@@ -118,8 +206,10 @@ class BlockchainService {
         return true;
     }
     /**
-     *
-     * @returns
+     * Disconnects from the blockchain
+     * @returns {Promise<void>} Resolves when disconnection is complete
+     * @example
+     * await blockchainService.disconnect();
      */
     async disconnect() {
         let result;
@@ -129,6 +219,11 @@ class BlockchainService {
         this._setBlockchainReady(false);
         return result;
     }
+    /**
+     * Waits for the blockchain to be ready
+     * @returns {Promise<void>} Resolves when blockchain is ready
+     * @private
+     */
     async waitBlockchainReady() {
         return new Promise(resolve => {
             if (this.isBlockchainReady) {
@@ -140,15 +235,38 @@ class BlockchainService {
         });
     }
     /**
-     *
-     * @returns
+     * Resolves a DID to its document
+     * @param {string} did - The DID to resolve
+     * @returns {Promise<Object>} The resolved DID document
+     * @example
+     * const didDoc = await blockchainService.resolveDID('did:key:z6Mk...');
+     */
+    async resolveDID(did) {
+        return this.resolver.resolve(did);
+    }
+    /**
+     * Checks if the blockchain API is connected
+     * @returns {Promise<boolean>} True if connected, false otherwise
+     * @example
+     * const isConnected = await blockchainService.isApiConnected();
      */
     async isApiConnected() {
         return this.cheqdApi.isInitialized();
     }
+    /**
+     * Gets the current Cheqd API URL
+     * @returns {Promise<string>} The Cheqd API URL
+     * @example
+     * const apiUrl = await blockchainService.getAddress();
+     */
     async getAddress() {
         return this.cheqdApiUrl;
     }
+    /**
+     * Sets the blockchain ready state and emits events
+     * @private
+     * @param {boolean} isBlockchainReady - Whether blockchain is ready
+     */
     _setBlockchainReady(isBlockchainReady) {
         this.isBlockchainReady = isBlockchainReady;
         if (isBlockchainReady) {
@@ -156,6 +274,20 @@ class BlockchainService {
         }
     }
 }
+/**
+ * Singleton instance of the blockchain service
+ * @type {BlockchainService}
+ * @example
+ * import { blockchainService } from '@docknetwork/wallet-sdk-wasm/services/blockchain';
+ *
+ * // Initialize the service
+ * await blockchainService.init({
+ *   cheqdApiUrl: 'https://api.cheqd.network'
+ * });
+ *
+ * // Resolve a DID
+ * const didDoc = await blockchainService.resolveDID('did:key:z6Mk...');
+ */
 const blockchainService = new BlockchainService();
 
 export { BlockchainService, blockchainService, universalResolverUrl };

package/lib/services/credential/bbs-revocation.js

@@ -20,6 +20,17 @@ require('@scure/bip39');
 require('@scure/bip39/wordlists/english');
 require('../util-crypto/configs.js');
 require('@docknetwork/credential-sdk/types');
+require('../blockchain/cached-did-resolver.js');
+require('../storage/index.js');
+require('../storage/service.js');
+require('../storage/service-rpc.js');
+require('../rpc-service-client.js');
+require('../../rpc-client.js');
+require('json-rpc-2.0');
+require('../../core/crypto.js');
+require('crypto');
+require('../../logger.js');
+require('../../rpc-util.js');
 
 const getWitnessDetails = async (credential, _membershipWitness) => {
     let witness = _membershipWitness;

package/lib/services/credential/bbs-revocation.mjs

@@ -16,6 +16,17 @@ import '@scure/bip39';
 import '@scure/bip39/wordlists/english';
 import '../util-crypto/configs.mjs';
 import '@docknetwork/credential-sdk/types';
+import '../blockchain/cached-did-resolver.mjs';
+import '../storage/index.mjs';
+import '../storage/service.mjs';
+import '../storage/service-rpc.mjs';
+import '../rpc-service-client.mjs';
+import '../../rpc-client.mjs';
+import 'json-rpc-2.0';
+import '../../core/crypto.mjs';
+import 'crypto';
+import '../../logger.mjs';
+import '../../rpc-util.mjs';
 
 const getWitnessDetails = async (credential, _membershipWitness) => {
     let witness = _membershipWitness;

package/lib/services/credential/config.js

@@ -20,7 +20,10 @@ const validation = {
     },
     verifyCredential: params => {
         const { credential } = params;
-        assert__default["default"](typeof credential === 'object', 'invalid credential');
+        assert__default["default"](typeof credential === 'object' || typeof credential === 'string', 'invalid credential');
+        if (typeof credential === 'object') {
+            assert__default["default"](Object.keys(credential).length > 0, 'invalid credential');
+        }
     },
     createBBSPresentation: params => {
         const { credentials } = params;

package/lib/services/credential/config.mjs

@@ -12,7 +12,10 @@ const validation = {
     },
     verifyCredential: params => {
         const { credential } = params;
-        assert(typeof credential === 'object', 'invalid credential');
+        assert(typeof credential === 'object' || typeof credential === 'string', 'invalid credential');
+        if (typeof credential === 'object') {
+            assert(Object.keys(credential).length > 0, 'invalid credential');
+        }
     },
     createBBSPresentation: params => {
         const { credentials } = params;

package/lib/services/credential/index.js

@@ -27,6 +27,17 @@ require('@scure/bip39');
 require('@scure/bip39/wordlists/english');
 require('../util-crypto/configs.js');
 require('@docknetwork/credential-sdk/types');
+require('../blockchain/cached-did-resolver.js');
+require('../storage/index.js');
+require('../storage/service.js');
+require('../storage/service-rpc.js');
+require('../rpc-service-client.js');
+require('../../rpc-client.js');
+require('json-rpc-2.0');
+require('../../core/crypto.js');
+require('crypto');
+require('../../logger.js');
+require('../../rpc-util.js');
 require('./bound-check.js');
 require('@docknetwork/crypto-wasm-ts/lib/legosnark');
 require('base64url');
@@ -45,6 +56,9 @@ require('@digitalbazaar/x25519-key-agreement-key-2019');
 require('@digitalbazaar/ed25519-verification-key-2018');
 require('@digitalbazaar/ed25519-verification-key-2020');
 require('../dids/keypair-utils.js');
+require('./sd-jwt.js');
+require('@sd-jwt/sd-jwt-vc');
+require('@sd-jwt/crypto-nodejs');
 
 // @ts-nocheck
 // TODO: rename it to credentialService, will need to update dock-app

package/lib/services/credential/index.mjs

@@ -23,6 +23,17 @@ import '@scure/bip39';
 import '@scure/bip39/wordlists/english';
 import '../util-crypto/configs.mjs';
 import '@docknetwork/credential-sdk/types';
+import '../blockchain/cached-did-resolver.mjs';
+import '../storage/index.mjs';
+import '../storage/service.mjs';
+import '../storage/service-rpc.mjs';
+import '../rpc-service-client.mjs';
+import '../../rpc-client.mjs';
+import 'json-rpc-2.0';
+import '../../core/crypto.mjs';
+import 'crypto';
+import '../../logger.mjs';
+import '../../rpc-util.mjs';
 import './bound-check.mjs';
 import '@docknetwork/crypto-wasm-ts/lib/legosnark';
 import 'base64url';
@@ -41,6 +52,9 @@ import '@digitalbazaar/x25519-key-agreement-key-2019';
 import '@digitalbazaar/ed25519-verification-key-2018';
 import '@digitalbazaar/ed25519-verification-key-2020';
 import '../dids/keypair-utils.mjs';
+import './sd-jwt.mjs';
+import '@sd-jwt/sd-jwt-vc';
+import '@sd-jwt/crypto-nodejs';
 
 // @ts-nocheck
 // TODO: rename it to credentialService, will need to update dock-app

package/lib/services/credential/pex-helpers.js

@@ -64,6 +64,17 @@ function getAttributeName({field, selectedCredentials, index}) {
   return attributeName;
 }
 
+/**
+ * Convert PEX request to bounds for each descriptor
+ * @param {*} pexRequest - The PEX request object containing input descriptors and constraints
+ * @param {*} selectedCredentials  - Array of selected credentials corresponding to the input descriptors
+ * @param {*} removeFromRequest - if true, removes range proofs fields from the request. it might be dangerous if you will be using the proof request later
+ *  because it will not have the range proofs fields anymore.
+ * @returns {Array} - Array of bounds for each descriptor, where each bound is an object with attributeName, min, and max
+ * @throws {Error} - If a field path is missing or empty
+ * @throws {Error} - If an unsupported format or type is encountered
+ * @throws {Error} - If a selected credential is expected but not found at the given index
+ */
 function pexToBounds(
   pexRequest,
   selectedCredentials = [],
@@ -166,6 +177,9 @@ function pexToBounds(
             : formatMinimum
           : minimum;
 
+      const proofRequestMax = max;
+      const proofRequestMin = min;
+
       if (max === undefined && min === undefined) {
         return;
       }
@@ -240,6 +254,10 @@ function pexToBounds(
         attributeName,
         min,
         max,
+        proofRequestMax,
+        proofRequestMin,
+        format,
+        type,
       });
     });
 
@@ -262,6 +280,7 @@ const attributesToSkip = [
   /^@context/,
   /^proof/,
   /^credentialSchema/,
+  /^issuanceDate/,
 ];
 
 const shouldSkipAttribute = attributeName =>
@@ -311,3 +330,4 @@ exports.MIN_INTEGER = MIN_INTEGER;
 exports.MIN_NUMBER = MIN_NUMBER;
 exports.getPexRequiredAttributes = getPexRequiredAttributes;
 exports.pexToBounds = pexToBounds;
+exports.shouldSkipAttribute = shouldSkipAttribute;