@trustvc/trustvc 1.3.0 → 1.4.1

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

@@ -28,57 +28,78 @@ class DocumentBuilder {
   // 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.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;
+  // 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;
   }
-  // Public method to configure the document for verifiable credentials. Sets up the status list and revocation information.
-  verifiableDocument(config) {
-    if (this.selectedStatusType) {
+  // 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: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+        "Configuration Error: Do not mix transferable records and verifiable document properties."
       );
     }
-    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
-    };
+    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;
   }
-  // Public method to sign the document using the provided private key and an optional cryptographic suite.
+  // 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);
@@ -95,8 +116,31 @@ class DocumentBuilder {
     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) => {
@@ -107,6 +151,7 @@ class DocumentBuilder {
   }
   // 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"]),

package/dist/cjs/core/endorsement-chain/useEndorsementChain.js

@@ -29,8 +29,17 @@ const calldata = /* @__PURE__ */ __name(async (provider, functionSignature, cont
   });
   return ethers$1.ethers.utils.getAddress(ethers$1.ethers.utils.hexDataSlice(result, 12));
 }, "calldata");
-const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleEscrowFactoryAddress, tokenRegistryAddress, tokenId) => {
+const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleEscrowFactoryAddress, tokenRegistryAddress, tokenId, options) => {
   try {
+    if (options?.titleEscrowVersion === "v4") {
+      return await calldata(
+        provider,
+        "getAddress(address,uint256)",
+        titleEscrowFactoryAddress,
+        ["address", "uint256"],
+        [tokenRegistryAddress, tokenId]
+      );
+    }
     return await calldata(
       provider,
       "getEscrowAddress(address,uint256)",
@@ -39,6 +48,15 @@ const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleE
       [tokenRegistryAddress, tokenId]
     );
   } catch {
+    if (options?.titleEscrowVersion === "v4") {
+      return await calldata(
+        provider,
+        "getEscrowAddress(address,uint256)",
+        titleEscrowFactoryAddress,
+        ["address", "uint256"],
+        [tokenRegistryAddress, tokenId]
+      );
+    }
     return await calldata(
       provider,
       "getAddress(address,uint256)",
@@ -48,7 +66,7 @@ const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleE
     );
   }
 }, "resolveTitleEscrowAddress");
-const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress, tokenId, provider) => {
+const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress, tokenId, provider, options) => {
   const Contract = ethers.getEthersContractFromProvider(provider);
   const tokenRegistryAbi = [
     "function titleEscrowFactory() external view returns (address)",
@@ -64,7 +82,8 @@ const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress
     provider,
     titleEscrowFactoryAddress,
     tokenRegistryAddress,
-    tokenId
+    tokenId,
+    options
   );
 }, "getTitleEscrowAddress");
 const checkSupportsInterface = /* @__PURE__ */ __name(async (titleEscrowAddress, interfaceId, provider) => {

package/dist/esm/core/documentBuilder.js

@@ -1,4 +1,4 @@
-import { signW3C } from '../w3c';
+import { signW3C, verifyW3CSignature } from '../w3c';
 import { assertCredentialStatus, assertTransferableRecords } from '@trustvc/w3c-credential-status';
 import { verifyCredentialStatus } from '@trustvc/w3c-vc';
 import { ethers } from 'ethers';
@@ -26,57 +26,78 @@ class DocumentBuilder {
   // 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.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;
+  // 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;
   }
-  // Public method to configure the document for verifiable credentials. Sets up the status list and revocation information.
-  verifiableDocument(config) {
-    if (this.selectedStatusType) {
+  // 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: You can only call either .transferableRecords() or .verifiableDocument(), not both."
+        "Configuration Error: Do not mix transferable records and verifiable document properties."
       );
     }
-    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
-    };
+    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;
   }
-  // Public method to sign the document using the provided private key and an optional cryptographic suite.
+  // 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);
@@ -93,8 +114,31 @@ class DocumentBuilder {
     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) => {
@@ -105,6 +149,7 @@ class DocumentBuilder {
   }
   // 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"]),

package/dist/esm/core/endorsement-chain/useEndorsementChain.js

@@ -27,8 +27,17 @@ const calldata = /* @__PURE__ */ __name(async (provider, functionSignature, cont
   });
   return ethers.utils.getAddress(ethers.utils.hexDataSlice(result, 12));
 }, "calldata");
-const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleEscrowFactoryAddress, tokenRegistryAddress, tokenId) => {
+const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleEscrowFactoryAddress, tokenRegistryAddress, tokenId, options) => {
   try {
+    if (options?.titleEscrowVersion === "v4") {
+      return await calldata(
+        provider,
+        "getAddress(address,uint256)",
+        titleEscrowFactoryAddress,
+        ["address", "uint256"],
+        [tokenRegistryAddress, tokenId]
+      );
+    }
     return await calldata(
       provider,
       "getEscrowAddress(address,uint256)",
@@ -37,6 +46,15 @@ const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleE
       [tokenRegistryAddress, tokenId]
     );
   } catch {
+    if (options?.titleEscrowVersion === "v4") {
+      return await calldata(
+        provider,
+        "getEscrowAddress(address,uint256)",
+        titleEscrowFactoryAddress,
+        ["address", "uint256"],
+        [tokenRegistryAddress, tokenId]
+      );
+    }
     return await calldata(
       provider,
       "getAddress(address,uint256)",
@@ -46,7 +64,7 @@ const resolveTitleEscrowAddress = /* @__PURE__ */ __name(async (provider, titleE
     );
   }
 }, "resolveTitleEscrowAddress");
-const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress, tokenId, provider) => {
+const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress, tokenId, provider, options) => {
   const Contract = getEthersContractFromProvider(provider);
   const tokenRegistryAbi = [
     "function titleEscrowFactory() external view returns (address)",
@@ -62,7 +80,8 @@ const getTitleEscrowAddress = /* @__PURE__ */ __name(async (tokenRegistryAddress
     provider,
     titleEscrowFactoryAddress,
     tokenRegistryAddress,
-    tokenId
+    tokenId,
+    options
   );
 }, "getTitleEscrowAddress");
 const checkSupportsInterface = /* @__PURE__ */ __name(async (titleEscrowAddress, interfaceId, provider) => {

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

@@ -1,6 +1,5 @@
-import * as _trustvc_w3c_vc from '@trustvc/w3c-vc';
-import { VerifiableCredential } from '@trustvc/w3c-vc';
 import { PrivateKeyPair } from '@trustvc/w3c-issuer';
+import { VerifiableCredential, SignedVerifiableCredential } from '@trustvc/w3c-vc';
 
 interface W3CVerifiableDocumentConfig {
     url: string;
@@ -13,6 +12,11 @@ interface W3CTransferableRecordsConfig {
     tokenRegistry: string;
     rpcProviderUrl: string;
 }
+interface RenderMethod {
+    id: string;
+    type: string;
+    templateName: string;
+}
 declare class DocumentBuilder {
     private document;
     private documentType;
@@ -20,10 +24,17 @@ declare class DocumentBuilder {
     private statusConfig;
     private rpcProviderUrl;
     private requiredFields;
+    private isSigned;
     constructor(input: Partial<VerifiableCredential>, documentType?: string);
-    transferableRecords(config: W3CTransferableRecordsConfig): this;
-    verifiableDocument(config: W3CVerifiableDocumentConfig): this;
-    sign(privateKey: PrivateKeyPair, cryptoSuite?: string): Promise<_trustvc_w3c_vc.SignedVerifiableCredential>;
+    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;
@@ -32,4 +43,4 @@ declare class DocumentBuilder {
     private supportsInterface;
 }
 
-export { DocumentBuilder, type W3CTransferableRecordsConfig, type W3CVerifiableDocumentConfig };
+export { DocumentBuilder, type RenderMethod, type W3CTransferableRecordsConfig, type W3CVerifiableDocumentConfig };

package/dist/types/core/endorsement-chain/useEndorsementChain.d.ts

@@ -8,7 +8,9 @@ declare const TitleEscrowInterface: {
     V4: string;
     V5: string;
 };
-declare const getTitleEscrowAddress: (tokenRegistryAddress: string, tokenId: string, provider: Provider | ethers.Provider) => Promise<string>;
+declare const getTitleEscrowAddress: (tokenRegistryAddress: string, tokenId: string, provider: Provider | ethers.Provider, options?: {
+    titleEscrowVersion?: "v4" | "v5";
+}) => Promise<string>;
 interface TitleEscrowVersionParams {
     tokenRegistryAddress?: string;
     tokenId?: string;

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

@@ -7,7 +7,7 @@ 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';
+export { DocumentBuilder, RenderMethod, W3CTransferableRecordsConfig, W3CVerifiableDocumentConfig } from './documentBuilder.js';
 import '@trustvc/w3c-vc';
 import '@tradetrust-tt/tt-verify/dist/types/src/types/core';
 import 'ethersV6';

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

@@ -1,4 +1,4 @@
-import * as _trustvc_w3c_vc from '@trustvc/w3c-vc';
+import * as w3cVc 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
-}, [_trustvc_w3c_vc]);
+}, [w3cVc]);
 
 export { index as i };

package/dist/types/index.d.ts

@@ -19,7 +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 { 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';
@@ -33,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-Bc5NlE8f.js';
+export { i as vc } from './index-1ws_BWZW.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-Bc5NlE8f.js';
+export { i as vc } from '../index-1ws_BWZW.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.3.0",
+  "version": "1.4.1",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -116,10 +116,10 @@
     "@tradetrust-tt/tradetrust": "^6.10.1",
     "@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",
+    "@trustvc/w3c-context": "^1.2.2",
+    "@trustvc/w3c-credential-status": "^1.2.2",
     "@trustvc/w3c-issuer": "^1.2.1",
-    "@trustvc/w3c-vc": "^1.2.3",
+    "@trustvc/w3c-vc": "^1.2.4",
     "did-resolver": "^4.1.0",
     "ethers": "^5.7.2",
     "ethersV6": "npm:ethers@^6.13.5",