fix(cheqd): handle string serviceEndpoint for DidCommV1Service.type (#2484)

Signed-off-by: Sownak Roy <sownak@cheqd.io>

Author: sownak

.changeset/chubby-rockets-grow.md

@@ -0,0 +1,5 @@
+---
+"@credo-ts/cheqd": minor
+---
+
+fix: handle string serviceEndpoint for DidCommV1Service.type

packages/cheqd/package.json

@@ -34,7 +34,7 @@
     "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@cheqd/sdk": "npm:@cheqd/sdk-esm@^5.3.4",
+    "@cheqd/sdk": "npm:@cheqd/sdk-esm@^5.3.6",
     "@cheqd/ts-proto": "^4.1.1",
     "@cosmjs/crypto": "^0.33.1",
     "@cosmjs/proto-signing": "^0.33.1",

packages/cheqd/src/dids/didCheqdUtil.ts

@@ -13,6 +13,7 @@ import { DirectSecp256k1HdWallet, DirectSecp256k1Wallet } from '@cosmjs/proto-si
 import {
   type AnyUint8Array,
   CredoError,
+  DidCommV1Service,
   DidDocument,
   JsonEncoder,
   JsonTransformer,
@@ -64,7 +65,14 @@ export async function createMsgCreateDidDocPayloadToSign(didPayload: DIDDocument
   didPayload.service = didPayload.service?.map((e) => {
     return {
       ...e,
-      serviceEndpoint: Array.isArray(e.serviceEndpoint) ? e.serviceEndpoint : [e.serviceEndpoint],
+      // For DIDComm V1 services (V2 already supports array), keep serviceEndpoint as string
+      // For other services, convert to array if not already
+      serviceEndpoint:
+        e.type === DidCommV1Service.type
+          ? e.serviceEndpoint
+          : Array.isArray(e.serviceEndpoint)
+            ? e.serviceEndpoint
+            : [e.serviceEndpoint],
     }
   })
   const { protobufVerificationMethod, protobufService } = await DIDModule.validateSpecCompliantPayload(didPayload)

packages/cheqd/tests/cheqd-did-registrar.e2e.test.ts

@@ -1,6 +1,7 @@
 import type { DidDocument } from '@credo-ts/core'
 import {
   Agent,
+  DidCommV1Service,
   DidDocumentBuilder,
   getEd25519VerificationKey2018,
   getJsonWebKey2020,
@@ -84,7 +85,7 @@ describe('Cheqd DID registrar', () => {
     expect(did.didState).toMatchObject({ state: 'finished' })
   })
 
-  it('should create a did:cheqd using JsonWebKey2020', async () => {
+  it('should create a did:cheqd using JsonWebKey2020 and update with serviceEndpoint as array', async () => {
     const createResult = await agent.dids.create<CheqdDidCreateOptions>({
       method: 'cheqd',
 
@@ -135,6 +136,54 @@ describe('Cheqd DID registrar', () => {
     expect(resolvedDocument.didDocumentMetadata.deactivated).toBe(true)
   })
 
+  it('should create a did:cheqd using JsonWebKey2020 and update with DidCommV1Service', async () => {
+    const createResult = await agent.dids.create<CheqdDidCreateOptions>({
+      method: 'cheqd',
+      options: {
+        createKey: {
+          type: {
+            crv: 'Ed25519',
+            kty: 'OKP',
+          },
+          keyId: 'another-key-id',
+        },
+        network: 'testnet',
+        methodSpecificIdAlgo: 'uuid',
+      },
+    })
+    expect(createResult).toMatchObject({
+      didState: {
+        state: 'finished',
+        didDocument: {
+          verificationMethod: [{ type: 'JsonWebKey2020' }],
+        },
+      },
+    })
+    expect(createResult.didState.did).toBeDefined()
+    const did = createResult.didState.did as string
+    const didDocument = createResult.didState.didDocument as DidDocument
+    const verificationMethodId = didDocument.verificationMethod?.[0]?.id
+    const service1 = new DidCommV1Service({
+      id: `${did}#didcomm-1`,
+      serviceEndpoint: 'https://this.endpoint.io',
+      recipientKeys: [verificationMethodId ?? ''],
+      accept: ['didcomm/aip2;env=rfc19'],
+      priority: 0,
+    })
+    didDocument.service = [service1]
+    const updateResult = await agent.dids.update({
+      did,
+      didDocument,
+    })
+    expect(updateResult).toMatchObject({
+      didState: {
+        state: 'finished',
+        didDocument,
+      },
+    })
+    expect(updateResult.didState.didDocument?.toJSON()).toMatchObject(didDocument.toJSON())
+  })
+
   it('should create a did:cheqd did using custom did document containing Ed25519 key', async () => {
     const did = `did:cheqd:testnet:${utils.uuid()}`