@verii/verii-issuing 1.1.0-pre.1761078749 → 1.1.0-pre.1761633504

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verii/verii-issuing",
-  "version": "1.1.0-pre.1761078749",
+  "version": "1.1.0-pre.1761633504",
   "description": "Verii Issuing Package",
   "repository": "https://github.com/LFDT-Verii/core",
   "main": "src/index.js",
@@ -18,23 +18,23 @@
   "author": "Andres Olave",
   "license": "Apache-2.0",
   "dependencies": {
-    "@verii/blockchain-functions": "1.1.0-pre.1761078749",
-    "@verii/common-functions": "1.1.0-pre.1761078749",
-    "@verii/crypto": "1.1.0-pre.1761078749",
-    "@verii/did-doc": "1.1.0-pre.1761078749",
-    "@verii/jwt": "1.1.0-pre.1761078749",
-    "@verii/metadata-registration": "1.1.0-pre.1761078749",
-    "@verii/vc-checks": "1.1.0-pre.1761078749",
+    "@verii/blockchain-functions": "1.1.0-pre.1761633504",
+    "@verii/common-functions": "1.1.0-pre.1761633504",
+    "@verii/crypto": "1.1.0-pre.1761633504",
+    "@verii/did-doc": "1.1.0-pre.1761633504",
+    "@verii/jwt": "1.1.0-pre.1761633504",
+    "@verii/metadata-registration": "1.1.0-pre.1761633504",
+    "@verii/vc-checks": "1.1.0-pre.1761633504",
     "canonicalize": "2.1.0",
     "eth-url-parser": "1.0.4",
     "fast-shuffle": "6.1.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@verii/contract-permissions": "1.1.0-pre.1761078749",
-    "@verii/http-client": "1.1.0-pre.1761078749",
-    "@verii/test-regexes": "1.1.0-pre.1761078749",
-    "@verii/tests-helpers": "1.1.0-pre.1761078749",
+    "@verii/contract-permissions": "1.1.0-pre.1761633504",
+    "@verii/http-client": "1.1.0-pre.1761633504",
+    "@verii/test-regexes": "1.1.0-pre.1761633504",
+    "@verii/tests-helpers": "1.1.0-pre.1761633504",
     "eslint": "8.57.1",
     "eslint-config-airbnb-base": "14.2.1",
     "eslint-config-prettier": "8.10.2",
@@ -56,5 +56,5 @@
       "lib"
     ]
   },
-  "gitHead": "271e13259106a059ac269b208323fd99046f263e"
+  "gitHead": "2d03f7696df04682866781b65f0ce2a6bb939c34"
 }

package/src/domain/{prepare-jsonld-credential.js → build-jsonld-credential.js}

@@ -34,7 +34,7 @@ const { VelocityRevocationListType } = require('@verii/vc-checks');
  * @param {Context} context context
  * @returns {JsonLdCredential} a json-ld formatted unsigned credential
  */
-const prepareJsonLdCredential = (
+const buildJsonLdCredential = (
   issuer,
   credentialSubjectId,
   offer,
@@ -215,5 +215,5 @@ const buildCredentialTypeJsonLdContext = (credentialTypeMetadata) =>
     : [];
 
 module.exports = {
-  prepareJsonLdCredential,
+  buildJsonLdCredential,
 };

package/src/domain/{build-verifiable-credentials.js → prepare-jwt-vcs.js}

@@ -26,9 +26,10 @@ const { jsonLdToUnsignedVcJwtContent, jwtSign } = require('@verii/jwt');
 const { extractCredentialType } = require('@verii/vc-checks');
 const { hashOffer } = require('./hash-offer');
 const { buildRevocationUrl } = require('../adapters/build-revocation-url');
-const { prepareJsonLdCredential } = require('./prepare-jsonld-credential');
+const { buildJsonLdCredential } = require('./build-jsonld-credential');
 
-/** @import { Issuer, AllocationListEntry, CredentialOffer, CredentialMetadata, CredentialTypeMetadata, Context } from "../types/types" */
+// eslint-disable-next-line max-len
+/** @import { Issuer, AllocationListEntry, CredentialOffer, CredentialMetadata, CredentialTypeMetadata, Context, JsonLdCredential } from "../types/types" */
 
 /**
  * Builds the VCs
@@ -39,9 +40,9 @@ const { prepareJsonLdCredential } = require('./prepare-jsonld-credential');
  * @param {AllocationListEntry[]} revocationListEntries revocation list entries
  * @param {{[Name: string]: CredentialTypeMetadata}} credentialTypesMap the credential types
  * @param {Context} context the context
- * @returns {Promise<{metadata: CredentialMetadata, vcJwt: string}[]>} the vc and its metadata
+ * @returns {Promise<{vcJwt: string, jsonLdCredential: JsonLdCredential, metadata: CredentialMetadata}[]>} the vc and its metadata
  */
-const buildVerifiableCredentials = async (
+const prepareJwtVcs = async (
   offers,
   credentialSubjectId,
   issuer,
@@ -78,7 +79,7 @@ const buildVerifiableCredentials = async (
         issuer,
         context
       );
-      const jsonLdCredential = prepareJsonLdCredential(
+      const jsonLdCredential = buildJsonLdCredential(
         issuer,
         credentialSubjectId,
         offer,
@@ -113,4 +114,4 @@ const buildVelocityCredentialMetadataDID = (entry, issuer, contentHash) =>
     entry.index
   }:${contentHash}`;
 
-module.exports = { buildVerifiableCredentials };
+module.exports = { prepareJwtVcs };

package/src/issue-verii-credentials.js

@@ -14,15 +14,13 @@
  * limitations under the License.
  */
 
-const { filter, flow, map } = require('lodash/fp');
+const { map } = require('lodash/fp');
 const { allocateListEntries } = require('./allocate-list-entries');
 const {
   initCredentialMetadataContract,
 } = require('./adapters/init-credential-metadata-contract');
 const { createRevocationList } = require('./adapters/create-revocation-list');
-const {
-  buildVerifiableCredentials,
-} = require('./domain/build-verifiable-credentials');
+const { prepareJwtVcs } = require('./domain/prepare-jwt-vcs');
 
 const REVOCATION_LIST_SIZE = 10240;
 const METADATA_LIST_SIZE = 10000;
@@ -30,31 +28,51 @@ const METADATA_LIST_SIZE = 10000;
 /** @import { Issuer, AllocationListEntry, CredentialOffer, CredentialMetadata, CredentialTypeMetadata, Context } from "../types/types" */
 
 /**
- * Prepares verifiable credentials from local offers without anchoring them to the blockchain.
- * Current assumption is that offers contain all required fields including @context, type, contentHash
+ * Prepares, signs and anchors a verifiable credential from a credential offer.
  * @param {CredentialOffer[]} offers  array of offers
  * @param {string} credentialSubjectId  optional field if credential subject needs to be bound into the offer
  * @param {{[Name: string]: CredentialTypeMetadata}} credentialTypesMap the credential types metadata
  * @param {Issuer} issuer  the issuer
  * @param {Context} context the context
- * @returns {Promise<{vcs: object[], revocationListEntries: object[]}>} Returns prepared credentials and revocation list entries
+ * @returns {Promise<string[]>} Returns signed credentials for each offer in vc-jwt format
  */
-const prepareVeriiVerifiableCredentials = async (
+const issueVeriiCredentials = async (
   offers,
   credentialSubjectId,
   credentialTypesMap,
   issuer,
   context
 ) => {
-  // pre-allocate list entries using internal tables/collections
-  const revocationListEntries = await allocateListEntries(
-    offers.length,
+  const vcs = await signVeriiCredentials(
+    offers,
+    credentialSubjectId,
+    credentialTypesMap,
     issuer,
-    'revocationListAllocations',
-    REVOCATION_LIST_SIZE,
     context
   );
 
+  await anchorVeriiCredentials(map('metadata', vcs), issuer, context);
+
+  return map('vcJwt', vcs);
+};
+
+/**
+ * Prepares and signs verifiable credentials from local offers without anchoring them to the blockchain.
+ * Assumption is that credential offers contain all required fields including @context, type, contentHash
+ * @param {CredentialOffer[]} offers  array of offers
+ * @param {string} credentialSubjectId  optional field if credential subject needs to be bound into the offer
+ * @param {{[Name: string]: CredentialTypeMetadata}} credentialTypesMap the credential types metadata
+ * @param {Issuer} issuer  the issuer
+ * @param {Context} context the context
+ * @returns {Promise<{vcJwt: string, metadata: CredentialMetadata}[]>} Returns array of signed vcs (in jwt format) and their metadata
+ */
+const signVeriiCredentials = async (
+  offers,
+  credentialSubjectId,
+  credentialTypesMap,
+  issuer,
+  context
+) => {
   const metadataEntries = await allocateListEntries(
     offers.length,
     issuer,
@@ -62,9 +80,29 @@ const prepareVeriiVerifiableCredentials = async (
     METADATA_LIST_SIZE,
     context
   );
+  const newMetadataListEntry = getNewListEntry(metadataEntries);
+  if (newMetadataListEntry != null) {
+    const { createList } = await initCredentialMetadataContract(
+      issuer,
+      context
+    );
+    await createList(newMetadataListEntry.listId);
+  }
+
+  // pre-allocate list entries using internal tables/collections
+  const revocationListEntries = await allocateListEntries(
+    offers.length,
+    issuer,
+    'revocationListAllocations',
+    REVOCATION_LIST_SIZE,
+    context
+  );
+  const newRevocationListEntry = getNewListEntry(revocationListEntries);
+  if (newRevocationListEntry != null) {
+    await createRevocationList(newRevocationListEntry.listId, issuer, context);
+  }
 
-  // build credential and metadata
-  const vcs = await buildVerifiableCredentials(
+  return prepareJwtVcs(
     offers,
     credentialSubjectId,
     issuer,
@@ -73,85 +111,30 @@ const prepareVeriiVerifiableCredentials = async (
     credentialTypesMap,
     context
   );
-
-  return { vcs, revocationListEntries };
 };
 
 /**
- * Anchors prepared verifiable credentials to the blockchain.
- * @param {object[]} vcs  array of verifiable credentials
- * @param {object[]} revocationListEntries  array of revocation list entries
+ * Anchors prepared verifiable credentials to the blockchain using their credential metadata.
+ * @param {CredentialMetadata[]} credentialMetadatas array of verifiable credential metadata
  * @param {Issuer} issuer  the issuer
  * @param {Context} context the context
- * @returns {Promise<string[]>} Returns signed credentials for each offer in vc-jwt format
  */
-const anchorVeriiVerifiableCredentials = async (
-  vcs,
-  revocationListEntries,
-  issuer,
-  context
-) => {
-  // create any necessary revocation lists on dlt
-  await Promise.all(
-    flow(
-      filter({ isNewList: true }),
-      map((entry) => createRevocationList(entry.listId, issuer, context))
-    )(revocationListEntries)
-  );
-
-  const { addEntry, createList } = await initCredentialMetadataContract(
-    issuer,
-    context
-  );
-
-  // create any necessary metadata lists on dlt
-  await Promise.all(
-    flow(
-      filter({ metadata: { isNewList: true } }),
-      map(({ metadata: { listId } }) => createList(listId, issuer, context))
-    )(vcs)
-  );
+const anchorVeriiCredentials = async (credentialMetadatas, issuer, context) => {
+  const { addEntry } = await initCredentialMetadataContract(issuer, context);
 
   // create credential metadata entries on dlt
-  await Promise.all(map(({ metadata }) => addEntry(metadata), vcs));
-
-  return map('vcJwt', vcs);
+  await Promise.all(map((metadata) => addEntry(metadata), credentialMetadatas));
 };
 
 /**
- * Creates verifiable credential from a local offer. Current assumption is that offers contain all required fields
- * including @context, type, contentHash
- * @param {CredentialOffer[]} offers  array of offers
- * @param {string} credentialSubjectId  optional field if credential subject needs to be bound into the offer
- * @param {{[Name: string]: CredentialTypeMetadata}} credentialTypesMap the credential types metadata
- * @param {Issuer} issuer  the issuer
- * @param {Context} context the context
- * @returns {Promise<string[]>} Returns signed credentials for each offer in vc-jwt format
+ * Gets the new list entry. Since the number of entries per list is 10k then only one will ever be returned
+ * @param {AllocationListEntry[]} entries the entries
+ * @returns {AllocationListEntry | undefined} returns the new list entry if it exists, otherwise undefined
  */
-const issueVeriiCredentials = async (
-  offers,
-  credentialSubjectId,
-  credentialTypesMap,
-  issuer,
-  context
-) => {
-  const { vcs, revocationListEntries } =
-    await prepareVeriiVerifiableCredentials(
-      offers,
-      credentialSubjectId,
-      credentialTypesMap,
-      issuer,
-      context
-    );
-  return anchorVeriiVerifiableCredentials(
-    vcs,
-    revocationListEntries,
-    issuer,
-    context
-  );
-};
+const getNewListEntry = (entries) => entries?.find((entry) => entry.isNewList);
+
 module.exports = {
-  anchorVeriiVerifiableCredentials,
+  anchorVeriiCredentials,
   issueVeriiCredentials,
-  prepareVeriiVerifiableCredentials,
+  signVeriiCredentials,
 };