@trustvc/trustvc 2.0.7 → 2.1.0

package/README.md

@@ -155,7 +155,7 @@ const signedWrappedDocument = await signOA(wrappedDocument, {
 
 #### b) TrustVC W3C Signing (signW3C)
 
-The `signW3C` function signs W3C Verifiable Credentials using the provided cryptographic suite and key pair. By default, it uses the **ecdsa-sd-2023** crypto suite unless otherwise specified.
+The `signW3C` function signs W3C Verifiable Credentials using the provided cryptographic suite and key pair. By default, it uses the **ecdsa-sd-2023** crypto suite unless otherwise specified. It also supports **bbs-2023** for modern BBS signatures.
 
 ```ts
 import { signW3C, VerificationType } from '@trustvc/trustvc';
@@ -195,7 +195,7 @@ const signingResult = await signW3C(rawDocument, {
   secretKeyMultibase: '<secretKeyMultibase>'
 });
 
-// You can also specify mandatory pointers for selective disclosure with ecdsa-sd-2023
+// You can also specify mandatory pointers for selective disclosure with ecdsa-sd-2023 / bbs-2023
 const signingResultWithPointers = await signW3C(
   rawDocument,
   {
@@ -212,7 +212,22 @@ const signingResultWithPointers = await signW3C(
   }
 );
 
-// Alternatively, specify a different crypto suite. Ensure the context is updated to include the crypto suite.
+// Using BBS-2023 cryptosuite
+const signingResultWithBbs2023 = await signW3C(
+  rawDocument,
+  {
+    '@context': 'https://w3id.org/security/multikey/v1',
+    id: 'did:web:trustvc.github.io:did:1#multikey-2',
+    type: VerificationType.Multikey,
+    controller: 'did:web:trustvc.github.io:did:1',
+    publicKeyMultibase: 'zUC75kRac7BdtjawFUxowfgD6mzqnRHFxAfMDaBynebdYgakviQkPS1KNJEw7uGWqj91H3hSE4pTERb3EZKLgKXjpqHWrN8dyE8SKyPBE3k7kUGjBNAqJoNGgUzqUW3DSaWrcNr',
+    secretKeyMultibase: '<secretKeyMultibase>',
+  },
+  'bbs-2023'
+);
+
+// ⚠️ DEPRECATED: BbsBlsSignature2020 is no longer supported
+// Use 'ecdsa-sd-2023 or bbs-2023' cryptosuite instead as shown above
 const signingResultWithBbs = await signW3C(
   rawDocument,
   {
@@ -222,7 +237,7 @@ const signingResultWithBbs = await signW3C(
     publicKeyBase58: 'oRfEeWFresvhRtXCkihZbxyoi2JER7gHTJ5psXhHsdCoU1MttRMi3Yp9b9fpjmKh7bMgfWKLESiK2YovRd8KGzJsGuamoAXfqDDVhckxuc9nmsJ84skCSTijKeU4pfAcxeJ',
     privateKeyBase58: '<privateKeyBase58>',
   },
-  'BbsBlsSignature2020'
+  'BbsBlsSignature2020' // This will return an error
 );
 
 ```
@@ -231,7 +246,7 @@ const signingResultWithBbs = await signW3C(
 
 ### 3. **Deriving (Selective Disclosure)**
 
-> When using ECDSA-SD-2023 crypto suite, we can derive a new credential with selective disclosure. This means you can choose which parts of the credential to reveal while keeping others hidden.
+> When using ECDSA-SD-2023 or BBS-2023 crypto suites, we can derive a new credential with selective disclosure. This means you can choose which parts of the credential to reveal while keeping others hidden.
 
 ```ts
 import { deriveW3C } from '@trustvc/trustvc';
@@ -282,7 +297,7 @@ const derivationResult = await deriveW3C(signedDocument, {
 
 ### 4. **Verifying**
 
-> TrustVC simplifies the verification process with a single function that supports both W3C Verifiable Credentials (VCs) and OpenAttestation Verifiable Documents (VDs). Whether you're working with W3C standards or OpenAttestation standards, TrustVC handles the verification seamlessly. For ECDSA-signed documents, which normally require derivation before verification, TrustVC automatically handles this process internally - if a document is not derived, the `verifyDocument` function will automatically derive and verify the document in a single step.
+> TrustVC simplifies the verification process with a single function that supports both W3C Verifiable Credentials (VCs) and OpenAttestation Verifiable Documents (VDs). Whether you're working with W3C standards or OpenAttestation standards, TrustVC handles the verification seamlessly. For ECDSA-SD-2023 and BBS-2023 signed documents, which normally require derivation before verification, TrustVC automatically handles this process internally - if a document is not derived, the `verifyDocument` function will automatically derive and verify the document in a single step.
 
 ```ts
 import { verifyDocument } from '@trustvc/trustvc';

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

@@ -1,5 +1,5 @@
 import { PrivateKeyPair } from '@trustvc/w3c-issuer';
-import { VerifiableCredential, CryptoSuiteName, SignedVerifiableCredential, ContextDocument } from '@trustvc/w3c-vc';
+import { VerifiableCredential, CryptoSuiteName, SignedVerifiableCredential } from '@trustvc/w3c-vc';
 
 /**
  * Configuration for a W3C Verifiable Document using a Bitstring Status List.
@@ -79,7 +79,7 @@ declare class DocumentBuilder {
     renderMethod(method: RenderMethod): this;
     qrCode(method: qrCode): this;
     sign(privateKey: PrivateKeyPair, cryptoSuite?: CryptoSuiteName, options?: SignOptions): Promise<SignedVerifiableCredential>;
-    derive(revealedAttributes: ContextDocument | string[]): Promise<SignedVerifiableCredential>;
+    derive(revealedAttributes: string[]): Promise<SignedVerifiableCredential>;
     verify(): Promise<boolean>;
     toString(): string;
     private isTransferableRecordsConfig;

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

@@ -1,11 +1,11 @@
-import { SignedVerifiableCredential, ContextDocument, DerivedResult } from '@trustvc/w3c-vc';
+import { SignedVerifiableCredential, DerivedResult } from '@trustvc/w3c-vc';
 
 /**
  * Derives a credential with selective disclosure based on revealed attributes.
  * @param {object} credential - The verifiable credential to be selectively disclosed.
- * @param {object|string[]} revealedAttributes - For BBS+: The attributes from the credential that should be revealed. For ECDSA-SD-2023: Array of selective pointers.
+ * @param {string[]} revealedAttributes - Array of selective pointers.
  * @returns {Promise<DerivedResult>} A DerivedResult containing the derived proof or an error message.
  */
-declare const deriveW3C: (credential: SignedVerifiableCredential, revealedAttributes: ContextDocument | string[]) => Promise<DerivedResult>;
+declare const deriveW3C: (credential: SignedVerifiableCredential, revealedAttributes: string[]) => Promise<DerivedResult>;
 
 export { deriveW3C };

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

@@ -6,8 +6,8 @@ import { PrivateKeyPair } from '@trustvc/w3c-issuer';
  * @param {RawVerifiableCredential} credential - The verifiable credential object that needs to be signed.
  * @param {PrivateKeyPair} keyPair - The private and public key pair used for signing the credential.
  * @param {CryptoSuiteName} [cryptoSuite='ecdsa-sd-2023'] - The cryptographic suite to be used for signing (default is 'ecdsa-sd-2023').
- * @param {object} [options] - Optional parameters including mandatoryPointers for ECDSA-SD-2023.
- * @param {string[]} [options.mandatoryPointers] - Optional mandatory pointers for ECDSA-SD-2023.
+ * @param {object} [options] - Optional parameters including mandatoryPointers for both ECDSA-SD-2023 / BBS-2023.
+ * @param {string[]} [options.mandatoryPointers] - Optional mandatory pointers for both ECDSA-SD-2023 / BBS-2023.
  * @returns {Promise<SigningResult>} A promise that resolves to the result of the signing operation, which includes the signed credential.
  */
 declare const signW3C: (credential: RawVerifiableCredential, keyPair: PrivateKeyPair, cryptoSuite?: CryptoSuiteName, options?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "2.0.7",
+  "version": "2.1.0",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -122,11 +122,11 @@
     "@tradetrust-tt/tradetrust": "^6.10.2",
     "@tradetrust-tt/tradetrust-utils": "^2.4.2",
     "@tradetrust-tt/tt-verify": "^9.6.0",
-    "@trustvc/w3c": "^1.3.0-alpha.11",
-    "@trustvc/w3c-context": "^1.3.0-alpha.10",
-    "@trustvc/w3c-credential-status": "^1.3.0-alpha.10",
-    "@trustvc/w3c-issuer": "^1.3.0-alpha.8",
-    "@trustvc/w3c-vc": "^1.3.0-alpha.11",
+    "@trustvc/w3c": "^1.3.0-alpha.14",
+    "@trustvc/w3c-context": "^1.3.0-alpha.12",
+    "@trustvc/w3c-credential-status": "^1.3.0-alpha.12",
+    "@trustvc/w3c-issuer": "^1.3.0-alpha.10",
+    "@trustvc/w3c-vc": "^1.3.0-alpha.14",
     "ethers": "^5.8.0",
     "ethersV6": "npm:ethers@^6.14.4",
     "js-sha3": "^0.9.3",