feat: Add support for jsonLd issuance [DEV-4877]

packages/credo/package.json

@@ -38,6 +38,7 @@
     "@hyperledger/aries-askar-nodejs": "^0.2.3",
     "@modelcontextprotocol/sdk": "^1.10.2",
     "qrcode": "^1.5.4",
+    "uuid": "^11.1.0",
     "zod": "^3.24.3"
   },
   "devDependencies": {

packages/credo/src/agent.ts

@@ -7,10 +7,13 @@ import {
 	ConnectionsModule,
 	CredentialsModule,
 	DidsModule,
+	DifPresentationExchangeProofFormatService,
 	HttpOutboundTransport,
+	JsonLdCredentialFormatService,
 	ProofsModule,
 	V2CredentialProtocol,
 	V2ProofProtocol,
+	W3cCredentialsModule,
 } from '@credo-ts/core';
 import { AskarModule } from '@credo-ts/askar';
 import { HttpInboundTransport, agentDependencies } from '@credo-ts/node';
@@ -153,15 +156,16 @@ function getAskarAnonCredsModules(mnemonic: string) {
 			autoAcceptCredentials: AutoAcceptCredential.Always,
 			credentialProtocols: [
 				new V2CredentialProtocol({
-					credentialFormats: [new AnonCredsCredentialFormatService()],
+					credentialFormats: [new AnonCredsCredentialFormatService(), new JsonLdCredentialFormatService()],
 				}),
 			],
 		}),
+		w3cCredentials: new W3cCredentialsModule(),
 		proofs: new ProofsModule({
 			autoAcceptProofs: AutoAcceptProof.Always,
 			proofProtocols: [
 				new V2ProofProtocol({
-					proofFormats: [new AnonCredsProofFormatService()],
+					proofFormats: [new AnonCredsProofFormatService(), new DifPresentationExchangeProofFormatService()],
 				}),
 			],
 		}),

packages/credo/src/index.ts

@@ -86,6 +86,7 @@ export class CredoToolKit {
 			new CredentialToolHandler(this.credo).listCredentialsTool(),
 			new CredentialToolHandler(this.credo).getCredentialRecordTool(),
 			new CredentialToolHandler(this.credo).listCredentialExchangeRecordsTool(),
+			new CredentialToolHandler(this.credo).acceptCredentialRequestTool(),
 			new CredentialToolHandler(this.credo).importCredentialTool(),
 			new ProofToolHandler(this.credo).connectionlessProofRequestTool(),
 			new ProofToolHandler(this.credo).connectionProofRequestTool(),

packages/credo/src/tools/credential.ts

@@ -1,14 +1,22 @@
-import { AutoAcceptCredential, Jwt, V2CredentialPreview, W3cJwtVerifiableCredential } from '@credo-ts/core';
+import {
+	AutoAcceptCredential,
+	JsonLdCredentialDetailFormat,
+	Jwt,
+	V2CredentialPreview,
+    W3cJwtVerifiableCredential,
+} from '@credo-ts/core';
 import QRCode from 'qrcode';
 import { CredoAgent } from '../agent.js';
 import {
 	AcceptCredentialOfferParams,
 	ConnectionlessCredentialOfferParams,
-	CredentialOfferParams,
 	GetCredentialRecordParams,
 	ListCredentialParams,
 	StoreCredentialParams,
 	ToolDefinition,
+	CredentialOfferParams,
+	VC_CONTEXT,
+	VC_TYPE,
 } from '../types.js';
 
 /**
@@ -32,49 +40,59 @@ export class CredentialToolHandler {
 			description:
 				'Creates a connectionless credential offer that can be accepted by any holder. Generates a QR code containing the offer URL, which can be scanned to initiate credential issuance. The response includes the QR code image, outOfBand record, and invitation details.',
 			schema: ConnectionlessCredentialOfferParams,
-			handler: async ({ attributes, credentialDefinitionId }) => {
-				let { message, credentialRecord } = await this.credo.agent.credentials.createOffer({
-					comment: 'V2 Out of Band offer',
-					credentialFormats: {
-						anoncreds: {
-							attributes: V2CredentialPreview.fromRecord(attributes).attributes,
-							credentialDefinitionId,
-						},
-					},
-					protocolVersion: 'v2',
-				});
+			handler: async ({ jsonld, anoncreds }) => {
+				try {
+					const credentialFormats = await this.constructCredentialFormats({ anoncreds, jsonld });
 
-				const { invitationUrl, outOfBandRecord } =
-					await this.credo.agent.oob.createLegacyConnectionlessInvitation({
-						recordId: credentialRecord.id,
-						message,
-						domain: this.credo.domain,
+					const { message, credentialRecord } = await this.credo.agent.credentials.createOffer({
+						comment: 'V2 Out of Band offer',
+						credentialFormats,
+						protocolVersion: 'v2',
+						autoAcceptCredential: AutoAcceptCredential.Always,
 					});
-				// Generate QR code as a data URL (png format)
-				const qrCodeBuffer = await QRCode.toBuffer(invitationUrl, {
-					type: 'png',
-					margin: 2,
-					errorCorrectionLevel: 'H',
-					scale: 8,
-				});
 
-				return {
-					content: [
-						{
-							type: 'image',
-							data: qrCodeBuffer.toString('base64'),
-							mimeType: 'image/png',
-						},
-						{
-							type: 'text',
-							text: JSON.stringify(outOfBandRecord),
-						},
-						{
-							type: 'text',
-							text: `Invitation created successfully.\n\nConnection URL: ${invitationUrl}\n\nScan this QR code with another agent to establish a connection:`,
-						},
-					],
-				};
+					const { invitationUrl, outOfBandRecord } =
+						await this.credo.agent.oob.createLegacyConnectionlessInvitation({
+							recordId: credentialRecord.id,
+							message,
+							domain: this.credo.domain,
+						});
+
+					// Generate QR code as a data URL (png format)
+					const qrCodeBuffer = await QRCode.toBuffer(invitationUrl, {
+						type: 'png',
+						margin: 2,
+						errorCorrectionLevel: 'H',
+						scale: 8,
+					});
+
+					return {
+						content: [
+							{
+								type: 'image',
+								data: qrCodeBuffer.toString('base64'),
+								mimeType: 'image/png',
+							},
+							{
+								type: 'text',
+								text: JSON.stringify(outOfBandRecord),
+							},
+							{
+								type: 'text',
+								text: `Invitation created successfully.\n\nConnection URL: ${invitationUrl}\n\nScan this QR code with another agent to establish a connection:`,
+							},
+						],
+					};
+				} catch (error: any) {
+					return {
+						content: [
+							{
+								type: 'text',
+								text: error.message,
+							},
+						],
+					};
+				}
 			},
 		};
 	}
@@ -89,28 +107,36 @@ export class CredentialToolHandler {
 			description:
 				'Creates a credential offer for an existing DIDComm connection. The offer is automatically sent to the connected agent, who can accept it to receive the credential. Returns the credential record with details about the offer status.',
 			schema: CredentialOfferParams,
-			handler: async ({ attributes, credentialDefinitionId, connectionId }) => {
-				let credentialRecord = await this.credo.agent.credentials.offerCredential({
-					comment: 'V2 Out of Band offer',
-					credentialFormats: {
-						anoncreds: {
-							attributes: V2CredentialPreview.fromRecord(attributes).attributes,
-							credentialDefinitionId,
-						},
-					},
-					protocolVersion: 'v2',
-					connectionId,
-					autoAcceptCredential: AutoAcceptCredential.Always,
-				});
+			handler: async ({ anoncreds, jsonld, connectionId }) => {
+				try {
+					const credentialFormats = await this.constructCredentialFormats({ anoncreds, jsonld });
 
-				return {
-					content: [
-						{
-							type: 'text',
-							text: JSON.stringify(credentialRecord),
-						},
-					],
-				};
+					let credentialRecord = await this.credo.agent.credentials.offerCredential({
+						comment: 'V2 Out of Band offer',
+						credentialFormats,
+						protocolVersion: 'v2',
+						connectionId,
+						autoAcceptCredential: AutoAcceptCredential.Always,
+					});
+
+					return {
+						content: [
+							{
+								type: 'text',
+								text: JSON.stringify(credentialRecord),
+							},
+						],
+					};
+				} catch (error: any) {
+					return {
+						content: [
+							{
+								type: 'text',
+								text: error.message,
+							},
+						],
+					};
+				}
 			},
 		};
 	}
@@ -254,6 +280,32 @@ export class CredentialToolHandler {
 	}
 
 	/**
+	 * Accepts a credential request from an holder to continue credential issuance.
+	 * Completes the credential exchange process and returns the credential record.
+	 */
+	acceptCredentialRequestTool(): ToolDefinition<typeof AcceptCredentialOfferParams> {
+		return {
+			name: 'accept-credential-request',
+			description: 'Accepts a credential request from an holder using the provided credential record ID.',
+			schema: AcceptCredentialOfferParams,
+			handler: async ({ credentialRecordId }) => {
+				const credential = await this.credo.agent.credentials.acceptRequest({
+					credentialRecordId,
+                    				});
+
+				return {
+					content: [
+						{
+							type: 'text',
+							text: JSON.stringify(credential),
+						},
+					],
+				};
+			},
+		};
+	}
+
+    /**
 	 * Imports a credential provided by the user.
 	 */
 	importCredentialTool(): ToolDefinition<typeof StoreCredentialParams> {
@@ -279,4 +331,67 @@ export class CredentialToolHandler {
 			},
 		};
 	}
+
+	private async constructCredentialFormats({ anoncreds, jsonld }) {
+		if (anoncreds) {
+			return {
+				anoncreds: {
+					attributes: V2CredentialPreview.fromRecord(anoncreds.attributes).attributes,
+					credentialDefinitionId: anoncreds.credentialDefinitionId,
+				},
+			};
+		} else if (jsonld) {
+			const {
+				attributes,
+				credentialName,
+				credentialSummary,
+				credentialSchema,
+				issuerDid,
+				subjectDid,
+				type,
+				expirationDate,
+				credentialStatus,
+				context,
+				format,
+				connector,
+				credentialId,
+				...additionalData
+			} = jsonld;
+
+			// validate issuer DID
+			const didDocument = await this.credo.agent.dids.resolveDidDocument(issuerDid);
+			if (!didDocument || !didDocument.assertionMethod?.length) {
+				throw new Error(`Issuer DID ${issuerDid} does not exist with an assertionMethod`);
+			}
+
+			return {
+				jsonld: {
+					credential: {
+						'@context': [...(context || []), ...VC_CONTEXT],
+						type: [...(type || []), VC_TYPE],
+						credentialSubject: {
+							id: subjectDid,
+							...attributes,
+						},
+						issuer: issuerDid,
+						issuanceDate: new Date().toISOString(),
+						expirationDate: expirationDate instanceof Date ? expirationDate.toISOString() : expirationDate,
+						credentialStatus: credentialStatus
+							? {
+									id: credentialStatus.statusListName,
+									type: credentialStatus.statusPurpose,
+								}
+							: undefined,
+						...additionalData,
+					},
+					options: {
+						proofType: 'Ed25519Signature2018',
+						proofPurpose: 'assertionMethod',
+					},
+				} satisfies JsonLdCredentialDetailFormat,
+			};
+		}
+
+		throw new Error('Error credential format jsonld, anoncreds with arguments must be provided');
+	}
 }

packages/credo/src/tools/did.ts

@@ -56,13 +56,13 @@ export class DidToolHandler {
 			description:
 				'Creates and publishes a new DID document to the specified cheqd network (testnet or mainnet). Generates a new DID with default verification methods and returns the complete DID document.',
 			schema: CreateDidDocumentParams,
-			handler: async ({ network }) => {
+			handler: async ({ network, verificationMethodType, verificationMethodId }) => {
 				const result = await this.credo.agent.dids.create({
 					method: 'cheqd',
 					secret: {
 						verificationMethod: {
-							id: 'key-1', // can be a param
-							type: 'Ed25519VerificationKey2020', // can be a param
+							id: verificationMethodId || 'key-1',
+							type: verificationMethodType || 'Ed25519VerificationKey2020',
 						},
 					},
 					options: {