@trustvc/trustvc 1.2.10 → 1.3.0

package/dist/cjs/core/documentBuilder.js

@@ -1,5 +1,15 @@
 'use strict';
 
+var w3c = require('../w3c');
+var w3cCredentialStatus = require('@trustvc/w3c-credential-status');
+var w3cVc = require('@trustvc/w3c-vc');
+var ethers = require('ethers');
+var tokenRegistryV4$1 = require('@tradetrust-tt/token-registry-v4');
+var tokenRegistryV5$1 = require('@tradetrust-tt/token-registry-v5');
+var tokenRegistryV4 = require('../token-registry-v4');
+var tokenRegistryV5 = require('../token-registry-v5');
+var tradetrustUtils = require('@tradetrust-tt/tradetrust-utils');
+
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 class DocumentBuilder {
@@ -7,8 +17,149 @@ class DocumentBuilder {
     __name(this, "DocumentBuilder");
   }
   document;
-  constructor() {
-    this.document = new DocumentBuilder();
+  // Holds the document to be built and signed.
+  documentType = "w3c";
+  // Default to W3C
+  selectedStatusType = null;
+  // Tracks selected status type.
+  statusConfig = {};
+  // Configuration for the credential status.
+  rpcProviderUrl;
+  // Holds the RPC provider URL for verifying token registry.
+  requiredFields = ["credentialSubject"];
+  // Required fields that must be present in the document.
+  /**
+   * Constructor to initialize the document builder.
+   * @param {Partial<VerifiableCredential>} input - The input document.
+   * @param {string} [documentType] - The type of the document (default is "w3c").
+   */
+  constructor(input, documentType = "w3c") {
+    this.validateRequiredFields(input);
+    this.document = this.initializeDocument(input);
+    this.documentType = documentType;
+  }
+  // Public method to configure the document for transferable records. Sets up the token network and token registry.
+  transferableRecords(config) {
+    if (this.selectedStatusType) {
+      throw new Error(
+        "Configuration Error: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+      );
+    }
+    this.selectedStatusType = "transferableRecords";
+    this.addContext("https://trustvc.io/context/transferable-records-context.json");
+    this.statusConfig = {
+      type: "TransferableRecords",
+      tokenNetwork: { chain: config.chain, chainId: config.chainId },
+      tokenRegistry: config.tokenRegistry
+    };
+    this.rpcProviderUrl = config.rpcProviderUrl;
+    return this;
+  }
+  // Public method to configure the document for verifiable credentials. Sets up the status list and revocation information.
+  verifiableDocument(config) {
+    if (this.selectedStatusType) {
+      throw new Error(
+        "Configuration Error: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+      );
+    }
+    this.selectedStatusType = "verifiableDocument";
+    this.addContext("https://w3id.org/vc/status-list/2021/v1");
+    this.statusConfig = {
+      id: `${config.url}#${config.index}`,
+      type: "StatusList2021Entry",
+      statusPurpose: config.purpose || "revocation",
+      // Set status purpose to "revocation" by default.
+      statusListIndex: config.index,
+      statusListCredential: config.url
+    };
+    return this;
+  }
+  // Public method to sign the document using the provided private key and an optional cryptographic suite.
+  async sign(privateKey, cryptoSuite) {
+    if (this.selectedStatusType) {
+      this.document.credentialStatus = this.statusConfig;
+    }
+    if (this.selectedStatusType === "verifiableDocument") {
+      w3cCredentialStatus.assertCredentialStatus(this.document.credentialStatus);
+      const verificationResult = await w3cVc.verifyCredentialStatus(this.document.credentialStatus);
+      if (verificationResult.error)
+        throw new Error(`Credential Verification Failed: ${verificationResult.error}`);
+      if (verificationResult.status)
+        throw new Error("Credential Verification Failed: Invalid credential status detected.");
+    } else if (this.selectedStatusType === "transferableRecords") {
+      w3cCredentialStatus.assertTransferableRecords(this.document.credentialStatus, "sign");
+      await this.verifyTokenRegistry();
+    }
+    this.document.issuer = privateKey.id.split("#")[0];
+    this.document.issuanceDate = this.document.issuanceDate || (/* @__PURE__ */ new Date()).toISOString();
+    this.addContext("https://w3id.org/security/bbs/v1");
+    const signedVC = await w3c.signW3C(this.document, privateKey, cryptoSuite);
+    if (signedVC.error) throw new Error(`Signing Error: ${signedVC.error}`);
+    return signedVC.signed;
+  }
+  // Private helper method to validate that the required fields are present in the input document.
+  validateRequiredFields(input) {
+    this.requiredFields.forEach((field) => {
+      if (!input[field]) {
+        throw new Error(`Validation Error: Missing required field "${field}" in the credential.`);
+      }
+    });
+  }
+  // Private helper method to initialize the document with required context and type, adding the necessary context URL.
+  initializeDocument(input) {
+    return {
+      ...input,
+      "@context": this.buildContext(input["@context"]),
+      type: Array.from(new Set([].concat(input.type || [], "VerifiableCredential")))
+    };
+  }
+  // Private helper method to build the context for the document, ensuring uniqueness and adding the default W3C context.
+  buildContext(context) {
+    return [
+      "https://www.w3.org/2018/credentials/v1",
+      ...Array.isArray(context) ? context : context ? [context] : []
+    ].filter((v, i, a) => a.indexOf(v) === i);
+  }
+  // Private helper method to add a new context to the document if it does not already exist.
+  addContext(context) {
+    if (!this.document["@context"].includes(context)) {
+      this.document["@context"].push(context);
+    }
+  }
+  // Private helper method to verify that the token registry supports the required interface for transferable records.
+  async verifyTokenRegistry() {
+    const chainId = this.document.credentialStatus.tokenNetwork.chainId;
+    if (!(chainId in tradetrustUtils.SUPPORTED_CHAINS)) {
+      throw new Error(`Unsupported Chain: Chain ID ${chainId} is not supported.`);
+    }
+    try {
+      const provider = new ethers.ethers.providers.JsonRpcProvider(this.rpcProviderUrl);
+      const isV4Supported = await this.supportsInterface(
+        tokenRegistryV4.v4Contracts.TradeTrustToken__factory,
+        tokenRegistryV4$1.constants.contractInterfaceId.TradeTrustTokenMintable,
+        provider
+      );
+      const isV5Supported = await this.supportsInterface(
+        tokenRegistryV5.v5Contracts.TradeTrustToken__factory,
+        tokenRegistryV5$1.constants.contractInterfaceId.TradeTrustTokenMintable,
+        provider
+      );
+      if (!isV4Supported && !isV5Supported)
+        throw new Error("Token registry version is not supported.");
+    } catch (error) {
+      if (error.message === "Token registry version is not supported.") {
+        throw error;
+      } else {
+        throw new Error(
+          `Network Error: Unable to verify token registry. Please check the RPC URL or token registry address.`
+        );
+      }
+    }
+  }
+  // Private helper method to check if a contract supports a specific interface ID.
+  async supportsInterface(contractFactory, interfaceId, provider) {
+    const contract = contractFactory.connect(this.statusConfig.tokenRegistry, provider);
+    return contract.supportsInterface(interfaceId);
   }
 }
 

package/dist/cjs/core/index.js

@@ -4,6 +4,7 @@ var decrypt = require('./decrypt');
 var encrypt = require('./encrypt');
 var verify = require('./verify');
 var endorsementChain = require('./endorsement-chain');
+var documentBuilder = require('./documentBuilder');
 
 
 
@@ -31,3 +32,9 @@ Object.keys(endorsementChain).forEach(function (k) {
 		get: function () { return endorsementChain[k]; }
 	});
 });
+Object.keys(documentBuilder).forEach(function (k) {
+	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function () { return documentBuilder[k]; }
+	});
+});

package/dist/esm/core/documentBuilder.js

@@ -1,3 +1,13 @@
+import { signW3C } from '../w3c';
+import { assertCredentialStatus, assertTransferableRecords } from '@trustvc/w3c-credential-status';
+import { verifyCredentialStatus } from '@trustvc/w3c-vc';
+import { ethers } from 'ethers';
+import { constants } from '@tradetrust-tt/token-registry-v4';
+import { constants as constants$1 } from '@tradetrust-tt/token-registry-v5';
+import { v4Contracts } from '../token-registry-v4';
+import { v5Contracts } from '../token-registry-v5';
+import { SUPPORTED_CHAINS } from '@tradetrust-tt/tradetrust-utils';
+
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 class DocumentBuilder {
@@ -5,8 +15,149 @@ class DocumentBuilder {
     __name(this, "DocumentBuilder");
   }
   document;
-  constructor() {
-    this.document = new DocumentBuilder();
+  // Holds the document to be built and signed.
+  documentType = "w3c";
+  // Default to W3C
+  selectedStatusType = null;
+  // Tracks selected status type.
+  statusConfig = {};
+  // Configuration for the credential status.
+  rpcProviderUrl;
+  // Holds the RPC provider URL for verifying token registry.
+  requiredFields = ["credentialSubject"];
+  // Required fields that must be present in the document.
+  /**
+   * Constructor to initialize the document builder.
+   * @param {Partial<VerifiableCredential>} input - The input document.
+   * @param {string} [documentType] - The type of the document (default is "w3c").
+   */
+  constructor(input, documentType = "w3c") {
+    this.validateRequiredFields(input);
+    this.document = this.initializeDocument(input);
+    this.documentType = documentType;
+  }
+  // Public method to configure the document for transferable records. Sets up the token network and token registry.
+  transferableRecords(config) {
+    if (this.selectedStatusType) {
+      throw new Error(
+        "Configuration Error: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+      );
+    }
+    this.selectedStatusType = "transferableRecords";
+    this.addContext("https://trustvc.io/context/transferable-records-context.json");
+    this.statusConfig = {
+      type: "TransferableRecords",
+      tokenNetwork: { chain: config.chain, chainId: config.chainId },
+      tokenRegistry: config.tokenRegistry
+    };
+    this.rpcProviderUrl = config.rpcProviderUrl;
+    return this;
+  }
+  // Public method to configure the document for verifiable credentials. Sets up the status list and revocation information.
+  verifiableDocument(config) {
+    if (this.selectedStatusType) {
+      throw new Error(
+        "Configuration Error: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+      );
+    }
+    this.selectedStatusType = "verifiableDocument";
+    this.addContext("https://w3id.org/vc/status-list/2021/v1");
+    this.statusConfig = {
+      id: `${config.url}#${config.index}`,
+      type: "StatusList2021Entry",
+      statusPurpose: config.purpose || "revocation",
+      // Set status purpose to "revocation" by default.
+      statusListIndex: config.index,
+      statusListCredential: config.url
+    };
+    return this;
+  }
+  // Public method to sign the document using the provided private key and an optional cryptographic suite.
+  async sign(privateKey, cryptoSuite) {
+    if (this.selectedStatusType) {
+      this.document.credentialStatus = this.statusConfig;
+    }
+    if (this.selectedStatusType === "verifiableDocument") {
+      assertCredentialStatus(this.document.credentialStatus);
+      const verificationResult = await verifyCredentialStatus(this.document.credentialStatus);
+      if (verificationResult.error)
+        throw new Error(`Credential Verification Failed: ${verificationResult.error}`);
+      if (verificationResult.status)
+        throw new Error("Credential Verification Failed: Invalid credential status detected.");
+    } else if (this.selectedStatusType === "transferableRecords") {
+      assertTransferableRecords(this.document.credentialStatus, "sign");
+      await this.verifyTokenRegistry();
+    }
+    this.document.issuer = privateKey.id.split("#")[0];
+    this.document.issuanceDate = this.document.issuanceDate || (/* @__PURE__ */ new Date()).toISOString();
+    this.addContext("https://w3id.org/security/bbs/v1");
+    const signedVC = await signW3C(this.document, privateKey, cryptoSuite);
+    if (signedVC.error) throw new Error(`Signing Error: ${signedVC.error}`);
+    return signedVC.signed;
+  }
+  // Private helper method to validate that the required fields are present in the input document.
+  validateRequiredFields(input) {
+    this.requiredFields.forEach((field) => {
+      if (!input[field]) {
+        throw new Error(`Validation Error: Missing required field "${field}" in the credential.`);
+      }
+    });
+  }
+  // Private helper method to initialize the document with required context and type, adding the necessary context URL.
+  initializeDocument(input) {
+    return {
+      ...input,
+      "@context": this.buildContext(input["@context"]),
+      type: Array.from(new Set([].concat(input.type || [], "VerifiableCredential")))
+    };
+  }
+  // Private helper method to build the context for the document, ensuring uniqueness and adding the default W3C context.
+  buildContext(context) {
+    return [
+      "https://www.w3.org/2018/credentials/v1",
+      ...Array.isArray(context) ? context : context ? [context] : []
+    ].filter((v, i, a) => a.indexOf(v) === i);
+  }
+  // Private helper method to add a new context to the document if it does not already exist.
+  addContext(context) {
+    if (!this.document["@context"].includes(context)) {
+      this.document["@context"].push(context);
+    }
+  }
+  // Private helper method to verify that the token registry supports the required interface for transferable records.
+  async verifyTokenRegistry() {
+    const chainId = this.document.credentialStatus.tokenNetwork.chainId;
+    if (!(chainId in SUPPORTED_CHAINS)) {
+      throw new Error(`Unsupported Chain: Chain ID ${chainId} is not supported.`);
+    }
+    try {
+      const provider = new ethers.providers.JsonRpcProvider(this.rpcProviderUrl);
+      const isV4Supported = await this.supportsInterface(
+        v4Contracts.TradeTrustToken__factory,
+        constants.contractInterfaceId.TradeTrustTokenMintable,
+        provider
+      );
+      const isV5Supported = await this.supportsInterface(
+        v5Contracts.TradeTrustToken__factory,
+        constants$1.contractInterfaceId.TradeTrustTokenMintable,
+        provider
+      );
+      if (!isV4Supported && !isV5Supported)
+        throw new Error("Token registry version is not supported.");
+    } catch (error) {
+      if (error.message === "Token registry version is not supported.") {
+        throw error;
+      } else {
+        throw new Error(
+          `Network Error: Unable to verify token registry. Please check the RPC URL or token registry address.`
+        );
+      }
+    }
+  }
+  // Private helper method to check if a contract supports a specific interface ID.
+  async supportsInterface(contractFactory, interfaceId, provider) {
+    const contract = contractFactory.connect(this.statusConfig.tokenRegistry, provider);
+    return contract.supportsInterface(interfaceId);
   }
 }
 

package/dist/esm/core/index.js

@@ -2,3 +2,4 @@ export * from './decrypt';
 export * from './encrypt';
 export * from './verify';
 export * from './endorsement-chain';
+export * from './documentBuilder';

package/dist/types/core/documentBuilder.d.ts

@@ -1,6 +1,35 @@
+import * as _trustvc_w3c_vc from '@trustvc/w3c-vc';
+import { VerifiableCredential } from '@trustvc/w3c-vc';
+import { PrivateKeyPair } from '@trustvc/w3c-issuer';
+
+interface W3CVerifiableDocumentConfig {
+    url: string;
+    index: number;
+    purpose?: string;
+}
+interface W3CTransferableRecordsConfig {
+    chain: string;
+    chainId: number;
+    tokenRegistry: string;
+    rpcProviderUrl: string;
+}
 declare class DocumentBuilder {
-    document: DocumentBuilder;
-    constructor();
+    private document;
+    private documentType;
+    private selectedStatusType;
+    private statusConfig;
+    private rpcProviderUrl;
+    private requiredFields;
+    constructor(input: Partial<VerifiableCredential>, documentType?: string);
+    transferableRecords(config: W3CTransferableRecordsConfig): this;
+    verifiableDocument(config: W3CVerifiableDocumentConfig): this;
+    sign(privateKey: PrivateKeyPair, cryptoSuite?: string): Promise<_trustvc_w3c_vc.SignedVerifiableCredential>;
+    private validateRequiredFields;
+    private initializeDocument;
+    private buildContext;
+    private addContext;
+    private verifyTokenRegistry;
+    private supportsInterface;
 }
 
-export { DocumentBuilder };
+export { DocumentBuilder, type W3CTransferableRecordsConfig, type W3CVerifiableDocumentConfig };

package/dist/types/core/index.d.ts

@@ -7,9 +7,11 @@ export { fetchEventTime, mergeTransfersV4, mergeTransfersV5, sortLogChain } from
 export { getEndorsementChain } from './endorsement-chain/retrieveEndorsementChain.js';
 export { EndorsementChain, ParsedLog, TitleEscrowTransferEvent, TitleEscrowTransferEventType, TokenTransferEvent, TokenTransferEventType, TradeTrustTokenEventType, TransferBaseEvent, TransferEvent, TransferEventType, TypedEvent } from './endorsement-chain/types.js';
 export { TitleEscrowInterface, fetchEndorsementChain, getTitleEscrowAddress, isTitleEscrowVersion } from './endorsement-chain/useEndorsementChain.js';
+export { DocumentBuilder, W3CTransferableRecordsConfig, W3CVerifiableDocumentConfig } from './documentBuilder.js';
 import '@trustvc/w3c-vc';
 import '@tradetrust-tt/tt-verify/dist/types/src/types/core';
 import 'ethersV6';
 import '@ethersproject/abstract-provider';
 import 'ethers';
 import 'ethers/lib/utils';
+import '@trustvc/w3c-issuer';

package/dist/types/{index-1ws_BWZW.d.ts → index-Bc5NlE8f.d.ts}

@@ -1,4 +1,4 @@
-import * as w3cVc from '@trustvc/w3c-vc';
+import * as _trustvc_w3c_vc from '@trustvc/w3c-vc';
 
 function _mergeNamespaces(n, m) {
 	m.forEach(function (e) {
@@ -17,6 +17,6 @@ function _mergeNamespaces(n, m) {
 
 var index = /*#__PURE__*/_mergeNamespaces({
 	__proto__: null
-}, [w3cVc]);
+}, [_trustvc_w3c_vc]);
 
 export { index as i };

package/dist/types/index.d.ts

@@ -19,6 +19,7 @@ export { fetchEventTime, mergeTransfersV4, mergeTransfersV5, sortLogChain } from
 export { getEndorsementChain } from './core/endorsement-chain/retrieveEndorsementChain.js';
 export { EndorsementChain, ParsedLog, TitleEscrowTransferEvent, TitleEscrowTransferEventType, TokenTransferEvent, TokenTransferEventType, TradeTrustTokenEventType, TransferBaseEvent, TransferEvent, TransferEventType, TypedEvent } from './core/endorsement-chain/types.js';
 export { TitleEscrowInterface, fetchEndorsementChain, getTitleEscrowAddress, isTitleEscrowVersion } from './core/endorsement-chain/useEndorsementChain.js';
+export { DocumentBuilder, W3CTransferableRecordsConfig, W3CVerifiableDocumentConfig } from './core/documentBuilder.js';
 export { signOA } from './open-attestation/sign.js';
 export { KeyPair } from './open-attestation/types.js';
 export { diagnose, getAssetId, getDocumentData, getIssuerAddress, getTemplateURL, isObfuscated, isRawV2Document, isRawV3Document, isSignedWrappedV2Document, isSignedWrappedV3Document, isTransferableAsset, isWrappedV2Document, isWrappedV3Document } from './open-attestation/utils.js';
@@ -32,7 +33,7 @@ export { i as isser } from './index-ClF4_Nqk.js';
 export { signW3C } from './w3c/sign.js';
 export { RawVerifiableCredential, SignedVerifiableCredential, SigningResult, VerificationResult } from '@trustvc/w3c-vc';
 export { PrivateKeyPair } from '@trustvc/w3c-issuer';
-export { i as vc } from './index-1ws_BWZW.js';
+export { i as vc } from './index-Bc5NlE8f.js';
 export { verifyW3CSignature } from './w3c/verify.js';
 export { errorMessageHandling, CONSTANTS as errorMessages, interpretFragments } from '@tradetrust-tt/tradetrust-utils';
 export * from '@tradetrust-tt/tradetrust-utils/constants/network';

package/dist/types/w3c/index.d.ts

@@ -4,7 +4,7 @@ export { i as isser } from '../index-ClF4_Nqk.js';
 export { signW3C } from './sign.js';
 export { RawVerifiableCredential, SignedVerifiableCredential, SigningResult, VerificationResult } from '@trustvc/w3c-vc';
 export { PrivateKeyPair } from '@trustvc/w3c-issuer';
-export { i as vc } from '../index-1ws_BWZW.js';
+export { i as vc } from '../index-Bc5NlE8f.js';
 export { verifyW3CSignature } from './verify.js';
 import '@trustvc/w3c-context';
 import '@trustvc/w3c-credential-status';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "1.2.10",
+  "version": "1.3.0",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -114,7 +114,7 @@
     "@tradetrust-tt/token-registry-v4": "npm:@tradetrust-tt/token-registry@^4.15.2",
     "@tradetrust-tt/token-registry-v5": "npm:@tradetrust-tt/token-registry@^5.1.4",
     "@tradetrust-tt/tradetrust": "^6.10.1",
-    "@tradetrust-tt/tradetrust-utils": "^2.2.0",
+    "@tradetrust-tt/tradetrust-utils": "^2.2.1",
     "@tradetrust-tt/tt-verify": "^9.3.1",
     "@trustvc/w3c-context": "^1.2.1",
     "@trustvc/w3c-credential-status": "^1.2.1",