@trustvc/trustvc 1.2.11 → 1.4.0

package/README.md

@@ -24,6 +24,7 @@ TrustVC is a comprehensive wrapper library designed to simplify the signing and
       - [TradeTrustToken](#tradetrusttoken)
       - [a) Token Registry v4](#a-token-registry-v4)
       - [b) Token Registry V5](#b-token-registry-v5)
+    - [7. **Document Builder**](#7-document-builder)
 
 ## Installation
 
@@ -587,3 +588,155 @@ function rejectTransferOwners(bytes calldata _remark) external;
 ```
 
 For more information on Token Registry and Title Escrow contracts **version v5**, please visit the readme of [TradeTrust Token Registry V5](https://github.com/TradeTrust/token-registry/blob/master/README.md)
+
+### 7. **Document Builder**
+> The `DocumentBuilder` class helps build and manage W3C Verifiable Credentials (VCs) with credential status features. It supports creating documents with two types of credential statuses: `transferableRecords` and `verifiableDocument`. It can sign the document using a private key, verify its signature, and serialize the document to a JSON format. Additionally, it allows for configuration of document rendering methods and expiration dates.
+
+#### Usage
+
+##### Create a new DocumentBuilder instance
+To create a new document, instantiate the `DocumentBuilder` with the base document (Verifiable Credential) that you want to build.
+
+To learn more about defining custom contexts, check out the [Credential Subject - Custom Contexts guide](https://docs.tradetrust.io/docs/how-tos/credential-subject).
+
+```ts
+// Adds a custom vocabulary used to define terms in the `credentialSubject`.
+// Users can define their own context if they have domain-specific fields or custom data structures.
+const builder = new DocumentBuilder({
+  '@context': 'https://w3c-ccg.github.io/citizenship-vocab/contexts/citizenship-v1.jsonld'
+});
+```
+
+##### Set Credential Subject
+Set the subject of the Verifiable Credential, which typically contains information about the entity the credential is issued to.
+
+```ts
+builder.credentialSubject({
+  id: 'did:example:123',
+  name: 'John Doe',
+});
+```
+
+##### Configure Credential Status
+You can configure the credential status as either `transferableRecords` or `verifiableDocument`.
+
+**Transferable Records**
+```ts
+builder.credentialStatus({
+  // Refers to the supported network.
+  // See: https://docs.tradetrust.io/docs/introduction/key-components-of-tradetrust/blockchain/supported-network
+  chain: 'Ethereum',
+  chainId: 1,
+  tokenRegistry: '0x1234567890abcdef...',
+  rpcProviderUrl: 'https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID',
+});
+```
+
+> ⚠️ **Disclaimer:**  
+> This builder **does not mint** documents on-chain. If you're using `transferableRecords`, you'll need to mint the document.  
+> [See the minting guide here](https://docs.tradetrust.io/docs/how-tos/credential-status#2-minting-the-credential)
+
+
+**Verifiable Document**
+```ts
+builder.credentialStatus({
+  url: 'https://example.com/status-list',
+  // `index: <placeholder>` refers to the bit position in the status list that will be set for revocation.
+  // Note: A document with the specific index must be marked as not revoked in the status list.
+  index: <placeholder>,
+  purpose: 'revocation',
+});
+```
+
+##### Set Expiration Date
+You can set an expiration date for the document.
+
+```ts
+builder.expirationDate('2026-01-01T00:00:00Z');
+```
+
+##### Define Rendering Method
+Set the rendering method to be used for the document.
+
+```ts
+builder.renderMethod({
+  id: 'https://example.com/rendering-method',
+  type: 'EMBEDDED_RENDERER',
+  templateName: 'BILL_OF_LADING',
+});
+```
+
+##### Sign the Document
+To sign the document, provide a `PrivateKeyPair` from `@trustvc/trustvc`.
+
+```ts
+const privateKey: PrivateKeyPair = {
+  id: 'did:example:456#key1',
+  controller: 'did:example:456',
+  type: VerificationType.Bls12381G2Key2020,
+  publicKeyBase58: 'your-public-key-base58',
+  privateKeyBase58: 'your-private-key-base58',
+};
+
+const signedDocument = await builder.sign(privateKey);
+console.log(signedDocument);
+```
+
+Example Output After Signing
+```json
+{
+  "@context": [
+    "https://www.w3.org/2018/credentials/v1",
+    "https://w3c-ccg.github.io/citizenship-vocab/contexts/citizenship-v1.jsonld",
+    "https://w3id.org/vc/status-list/2021/v1",
+    "https://trustvc.io/context/render-method-context.json",
+    "https://w3id.org/security/bbs/v1"
+  ],
+  "type": ["VerifiableCredential"],
+  "credentialSubject": {
+    "id": "did:example:123",
+    "name": "John Doe"
+  },
+  "expirationDate": "2026-01-01T00:00:00Z",
+  "renderMethod": [
+    {
+      "id": "https://example.com/rendering-method",
+      "type": "EMBEDDED_RENDERER",
+      "templateName": "BILL_OF_LADING"
+    }
+  ],
+  "credentialStatus": {
+    "id": "https://example.com/status-list#<placeholder>",
+    "type": "StatusList2021Entry",
+    "statusPurpose": "revocation",
+    "statusListIndex": "<placeholder>",
+    "statusListCredential": "https://example.com/status-list"
+  },
+  "issuer": "did:example:456",
+  "issuanceDate": "2025-01-01T00:00:00Z",
+  "id": "urn:bnid:_:0195fec2-4ae1-7cca-9182-03fd7da5142b",
+  "proof": {
+    "type": "BbsBlsSignature2020",
+    "created": "2025-01-01T00:00:01Z",
+    "proofPurpose": "assertionMethod",
+    "proofValue": "rV56L+QYozATRy3GOVLomzUo99sXtw2x0Cy9dEkHJ15wi4cS12cQJRIwzONVi3YscdhaSKoqD1jWmwb5A/khLZnDq5eo3QzDgTVClYuV86opL3HJyoS4+t2rRt3wl+chnATy2jqr5zMEvcVJ3gdXpQ==",
+    "verificationMethod": "did:example:456#key1"
+  }
+}
+```
+
+##### Verify the Document
+To verify the signature of the signed document:
+
+```ts
+const isVerified = await builder.verify();
+console.log(isVerified); // true or false
+```
+
+##### Convert Document to JSON String
+To get the current state of the document as a JSON string:
+
+```ts
+const documentJson = builder.toString();
+console.log(documentJson);
+```

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,194 @@ 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.
+  isSigned = false;
+  // Tracks if a document is signed
+  /**
+   * 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.document = this.initializeDocument(input);
+    this.documentType = documentType;
+  }
+  // Sets the credential subject of the document.
+  credentialSubject(subject) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.credentialSubject = subject;
+    return this;
+  }
+  // Configures the credential status of the document based on the provided type (Transferable Records or Verifiable Document).
+  credentialStatus(config) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    const isTransferable = this.isTransferableRecordsConfig(config);
+    const isVerifiable = this.isVerifiableDocumentConfig(config);
+    if (isTransferable && isVerifiable) {
+      throw new Error(
+        "Configuration Error: Do not mix transferable records and verifiable document properties."
+      );
+    }
+    if (isTransferable) {
+      this.selectedStatusType = "transferableRecords";
+      this.statusConfig = {
+        type: "TransferableRecords",
+        tokenNetwork: { chain: config.chain, chainId: config.chainId },
+        tokenRegistry: config.tokenRegistry
+      };
+      this.rpcProviderUrl = config.rpcProviderUrl;
+      this.addContext("https://trustvc.io/context/transferable-records-context.json");
+    } else if (isVerifiable) {
+      this.selectedStatusType = "verifiableDocument";
+      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
+      };
+      this.addContext("https://w3id.org/vc/status-list/2021/v1");
+    } else {
+      throw new Error("Configuration Error: Missing required fields for credential status.");
+    }
+    return this;
+  }
+  // Sets the expiration date of the document.
+  expirationDate(date) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.expirationDate = typeof date === "string" ? date : date.toISOString();
+    return this;
+  }
+  // Defines the rendering method for the document.
+  renderMethod(method) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.renderMethod = [method];
+    this.addContext("https://trustvc.io/context/render-method-context.json");
+    return this;
+  }
+  // Sign the document using the provided private key and an optional cryptographic suite.
+  async sign(privateKey, cryptoSuite) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    if (this.selectedStatusType) {
+      this.document.credentialStatus = this.statusConfig;
+    }
+    this.validateRequiredFields(this.document);
+    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}`);
+    this.isSigned = true;
+    return signedVC.signed;
+  }
+  // Verify the document.
+  async verify() {
+    if (!this.isSigned) throw new Error("Verification Error: Document is not signed yet.");
+    const verificationResult = await w3c.verifyW3CSignature(
+      this.document
+    );
+    if (verificationResult.error)
+      throw new Error(`Verification Error: ${verificationResult.error}`);
+    return verificationResult.verified;
+  }
+  // Returns the current state of the document as a JSON string.
+  toString() {
+    return JSON.stringify(this.document, null, 2);
+  }
+  // Type guard for transferable records configuration
+  isTransferableRecordsConfig(config) {
+    return config && typeof config.tokenRegistry === "string" && typeof config.chain === "string" && typeof config.chainId === "number" && typeof config.rpcProviderUrl === "string";
+  }
+  // Type guard for verifiable document configuration
+  isVerifiableDocumentConfig(config) {
+    return config && typeof config.url === "string" && typeof config.index === "number";
+  }
+  // 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) {
+    if (input.proof) throw new Error("Configuration Error: Document is already signed.");
+    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, verifyW3CSignature } 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,194 @@ 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.
+  isSigned = false;
+  // Tracks if a document is signed
+  /**
+   * 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.document = this.initializeDocument(input);
+    this.documentType = documentType;
+  }
+  // Sets the credential subject of the document.
+  credentialSubject(subject) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.credentialSubject = subject;
+    return this;
+  }
+  // Configures the credential status of the document based on the provided type (Transferable Records or Verifiable Document).
+  credentialStatus(config) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    const isTransferable = this.isTransferableRecordsConfig(config);
+    const isVerifiable = this.isVerifiableDocumentConfig(config);
+    if (isTransferable && isVerifiable) {
+      throw new Error(
+        "Configuration Error: Do not mix transferable records and verifiable document properties."
+      );
+    }
+    if (isTransferable) {
+      this.selectedStatusType = "transferableRecords";
+      this.statusConfig = {
+        type: "TransferableRecords",
+        tokenNetwork: { chain: config.chain, chainId: config.chainId },
+        tokenRegistry: config.tokenRegistry
+      };
+      this.rpcProviderUrl = config.rpcProviderUrl;
+      this.addContext("https://trustvc.io/context/transferable-records-context.json");
+    } else if (isVerifiable) {
+      this.selectedStatusType = "verifiableDocument";
+      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
+      };
+      this.addContext("https://w3id.org/vc/status-list/2021/v1");
+    } else {
+      throw new Error("Configuration Error: Missing required fields for credential status.");
+    }
+    return this;
+  }
+  // Sets the expiration date of the document.
+  expirationDate(date) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.expirationDate = typeof date === "string" ? date : date.toISOString();
+    return this;
+  }
+  // Defines the rendering method for the document.
+  renderMethod(method) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    this.document.renderMethod = [method];
+    this.addContext("https://trustvc.io/context/render-method-context.json");
+    return this;
+  }
+  // Sign the document using the provided private key and an optional cryptographic suite.
+  async sign(privateKey, cryptoSuite) {
+    if (this.isSigned) throw new Error("Configuration Error: Document is already signed.");
+    if (this.selectedStatusType) {
+      this.document.credentialStatus = this.statusConfig;
+    }
+    this.validateRequiredFields(this.document);
+    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}`);
+    this.isSigned = true;
+    return signedVC.signed;
+  }
+  // Verify the document.
+  async verify() {
+    if (!this.isSigned) throw new Error("Verification Error: Document is not signed yet.");
+    const verificationResult = await verifyW3CSignature(
+      this.document
+    );
+    if (verificationResult.error)
+      throw new Error(`Verification Error: ${verificationResult.error}`);
+    return verificationResult.verified;
+  }
+  // Returns the current state of the document as a JSON string.
+  toString() {
+    return JSON.stringify(this.document, null, 2);
+  }
+  // Type guard for transferable records configuration
+  isTransferableRecordsConfig(config) {
+    return config && typeof config.tokenRegistry === "string" && typeof config.chain === "string" && typeof config.chainId === "number" && typeof config.rpcProviderUrl === "string";
+  }
+  // Type guard for verifiable document configuration
+  isVerifiableDocumentConfig(config) {
+    return config && typeof config.url === "string" && typeof config.index === "number";
+  }
+  // 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) {
+    if (input.proof) throw new Error("Configuration Error: Document is already signed.");
+    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,46 @@
+import { PrivateKeyPair } from '@trustvc/w3c-issuer';
+import { VerifiableCredential, SignedVerifiableCredential } from '@trustvc/w3c-vc';
+
+interface W3CVerifiableDocumentConfig {
+    url: string;
+    index: number;
+    purpose?: string;
+}
+interface W3CTransferableRecordsConfig {
+    chain: string;
+    chainId: number;
+    tokenRegistry: string;
+    rpcProviderUrl: string;
+}
+interface RenderMethod {
+    id: string;
+    type: string;
+    templateName: string;
+}
 declare class DocumentBuilder {
-    document: DocumentBuilder;
-    constructor();
+    private document;
+    private documentType;
+    private selectedStatusType;
+    private statusConfig;
+    private rpcProviderUrl;
+    private requiredFields;
+    private isSigned;
+    constructor(input: Partial<VerifiableCredential>, documentType?: string);
+    credentialSubject(subject: Partial<VerifiableCredential>): this;
+    credentialStatus(config: W3CTransferableRecordsConfig | W3CVerifiableDocumentConfig): this;
+    expirationDate(date: string | Date): this;
+    renderMethod(method: RenderMethod): this;
+    sign(privateKey: PrivateKeyPair, cryptoSuite?: string): Promise<SignedVerifiableCredential>;
+    verify(): Promise<boolean>;
+    toString(): string;
+    private isTransferableRecordsConfig;
+    private isVerifiableDocumentConfig;
+    private validateRequiredFields;
+    private initializeDocument;
+    private buildContext;
+    private addContext;
+    private verifyTokenRegistry;
+    private supportsInterface;
 }
 
-export { DocumentBuilder };
+export { DocumentBuilder, type RenderMethod, 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, RenderMethod, 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.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, RenderMethod, 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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "1.2.11",
+  "version": "1.4.0",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",