chore: trying to merge json ld changes with current 0.5.6

ryankoch13 · ryankoch13 · commit 4107aeea2eb0 · 2024-07-16T11:43:22.000-04:00
Signed-off-by: ryankoch13 &lt;ryan.koch13@gmail.com&gt;
diff --git a/packages/anoncreds/package.json b/packages/anoncreds/package.json
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@astronautlabs/jsonpath": "^1.1.2",
-    "@credo-ts/core": "workspace:*",
+    "@credo-ts/core": "file:./../core",
     "@sphereon/pex-models": "^2.2.4",
     "big-integer": "^1.6.51",
     "bn.js": "^5.2.1",
diff --git a/packages/anoncreds/src/utils/w3cAnonCredsUtils.ts b/packages/anoncreds/src/utils/w3cAnonCredsUtils.ts
@@ -222,7 +222,7 @@ export function getW3cRecordAnonCredsTags(options: {
     ...((isIndyDid(issuerId) || isUnqualifiedIndyDid(issuerId)) && {
       anonCredsUnqualifiedIssuerId: getUnQualifiedDidIndyDid(issuerId),
       anonCredsUnqualifiedCredentialDefinitionId: getUnQualifiedDidIndyDid(credentialDefinitionId),
-      anonCredsUnqualifiedSchemaId: getUnQualifiedDidIndyDid(schemaId),
+      anonCredsUnqualifiedSchemaId: getUnQualifiedDidIndyDid(issuerId),
       anonCredsUnqualifiedSchemaIssuerId: getUnQualifiedDidIndyDid(schema.issuerId),
       anonCredsUnqualifiedRevocationRegistryId: revocationRegistryId
         ? getUnQualifiedDidIndyDid(revocationRegistryId)
diff --git a/packages/core/src/modules/connections/DidExchangeProtocol.ts b/packages/core/src/modules/connections/DidExchangeProtocol.ts
@@ -504,10 +504,13 @@ export class DidExchangeProtocol {
     message: DidExchangeRequestMessage | DidExchangeResponseMessage,
     invitationKeysBase58: string[] = []
   ) {
-    // The only supported case where we expect to receive a did-document attachment is did:peer algo 1
-    return isDid(message.did, 'peer') && getNumAlgoFromPeerDid(message.did) === PeerDidNumAlgo.GenesisDoc
-      ? this.extractAttachedDidDocument(agentContext, message, invitationKeysBase58)
-      : this.extractResolvableDidDocument(agentContext, message, invitationKeysBase58)
+    // Not all agents use didRotate yet, some may still send a didDoc attach with various did types
+    // we should check if the didDoc attach is there and if not require that the didRotate be present
+    if (message.didDoc) {
+      return this.extractAttachedDidDocument(agentContext, message, invitationKeysBase58)
+    } else {
+      return this.extractResolvableDidDocument(agentContext, message, invitationKeysBase58)
+    }
   }
 
   /**
@@ -522,11 +525,11 @@ export class DidExchangeProtocol {
     // Validate did-rotate attachment in case of DID Exchange response
     if (message instanceof DidExchangeResponseMessage) {
       const didRotateAttachment = message.didRotate
-
       if (!didRotateAttachment) {
-        throw new DidExchangeProblemReportError('DID Rotate attachment is missing.', {
-          problemCode: DidExchangeProblemReportReason.ResponseNotAccepted,
-        })
+        throw new DidExchangeProblemReportError(
+          'Either a DID Rotate attachment or a didDoc attachment must be provided to make a secure connection',
+          { problemCode: DidExchangeProblemReportReason.ResponseNotAccepted }
+        )
       }
 
       const jws = didRotateAttachment.data.jws
diff --git a/packages/core/src/modules/credentials/protocol/v2/messages/V2OfferCredentialMessage.ts b/packages/core/src/modules/credentials/protocol/v2/messages/V2OfferCredentialMessage.ts
@@ -58,6 +58,7 @@ export class V2OfferCredentialMessage extends AgentMessage {
 
   @Expose({ name: 'credential_preview' })
   @Type(() => V2CredentialPreview)
+  @IsOptional()
   @ValidateNested()
   @IsInstance(V2CredentialPreview)
   public credentialPreview?: V2CredentialPreview
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/Bls12381G1Key2020.ts b/packages/core/src/modules/dids/domain/verificationMethod/Bls12381G1Key2020.ts
@@ -32,9 +32,9 @@ export function isBls12381G1Key2020(verificationMethod: VerificationMethod): ver
  * Get a key from a Bls12381G1Key2020 verification method.
  */
 export function getKeyFromBls12381G1Key2020(verificationMethod: Bls12381G1Key2020) {
-  if (!verificationMethod.publicKeyBase58) {
-    throw new CredoError('verification method is missing publicKeyBase58')
+  if (verificationMethod.publicKeyBase58) {
+    return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g1)
   }
 
-  return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g1)
+  throw new CredoError('verification method is missing publicKeyBase58')
 }
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/Bls12381G2Key2020.ts b/packages/core/src/modules/dids/domain/verificationMethod/Bls12381G2Key2020.ts
@@ -32,9 +32,9 @@ export function isBls12381G2Key2020(verificationMethod: VerificationMethod): ver
  * Get a key from a Bls12381G2Key2020 verification method.
  */
 export function getKeyFromBls12381G2Key2020(verificationMethod: Bls12381G2Key2020) {
-  if (!verificationMethod.publicKeyBase58) {
-    throw new CredoError('verification method is missing publicKeyBase58')
+  if (verificationMethod.publicKeyBase58) {
+    return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g2)
   }
 
-  return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g2)
+  throw new CredoError('verification method is missing publicKeyBase58')
 }
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/EcdsaSecp256k1VerificationKey2019.ts b/packages/core/src/modules/dids/domain/verificationMethod/EcdsaSecp256k1VerificationKey2019.ts
@@ -43,9 +43,9 @@ export function isEcdsaSecp256k1VerificationKey2019(
  * Get a key from a EcdsaSecp256k1VerificationKey2019 verification method.
  */
 export function getKeyFromEcdsaSecp256k1VerificationKey2019(verificationMethod: EcdsaSecp256k1VerificationKey2019) {
-  if (!verificationMethod.publicKeyBase58) {
-    throw new CredoError('verification method is missing publicKeyBase58')
+  if (verificationMethod.publicKeyBase58) {
+    return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.K256)
   }
 
-  return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.K256)
+  throw new CredoError('verification method is missing publicKeyBase58')
 }
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/Ed25519VerificationKey2018.ts b/packages/core/src/modules/dids/domain/verificationMethod/Ed25519VerificationKey2018.ts
@@ -34,9 +34,9 @@ export function isEd25519VerificationKey2018(
  * Get a key from a Ed25519VerificationKey2018 verification method.
  */
 export function getKeyFromEd25519VerificationKey2018(verificationMethod: Ed25519VerificationKey2018) {
-  if (!verificationMethod.publicKeyBase58) {
-    throw new CredoError('verification method is missing publicKeyBase58')
+  if (verificationMethod.publicKeyBase58) {
+    return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Ed25519)
   }
 
-  return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Ed25519)
+  throw new CredoError('verification method is missing publicKeyBase58')
 }
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/Multikey.ts b/packages/core/src/modules/dids/domain/verificationMethod/Multikey.ts
@@ -32,14 +32,20 @@ export function getMultikey({ did, key, verificationMethodId }: GetMultikeyOptio
  */
 export function isMultikey(
   verificationMethod: VerificationMethod
-): verificationMethod is VerificationMethod & { type: 'Multikey' } {
+): verificationMethod is
+  | (VerificationMethod & { type: 'Multikey' })
+  | (VerificationMethod & { publicKeyMultibase: string }) {
   return verificationMethod.type === VERIFICATION_METHOD_TYPE_MULTIKEY
 }
 
 /**
  * Get a key from a Multikey verification method.
  */
-export function getKeyFromMultikey(verificationMethod: VerificationMethod & { type: 'Multikey' }) {
+export function getKeyFromMultikey(
+  verificationMethod:
+    | (VerificationMethod & { type: 'Multikey' })
+    | (VerificationMethod & { publicKeyMultibase: string })
+) {
   if (!verificationMethod.publicKeyMultibase) {
     throw new CredoError(
       `Missing publicKeyMultibase on verification method with type ${VERIFICATION_METHOD_TYPE_MULTIKEY}`
diff --git a/packages/core/src/modules/dids/domain/verificationMethod/X25519KeyAgreementKey2019.ts b/packages/core/src/modules/dids/domain/verificationMethod/X25519KeyAgreementKey2019.ts
@@ -34,9 +34,17 @@ export function isX25519KeyAgreementKey2019(
  * Get a key from a X25519KeyAgreementKey2019 verification method.
  */
 export function getKeyFromX25519KeyAgreementKey2019(verificationMethod: X25519KeyAgreementKey2019) {
-  if (!verificationMethod.publicKeyBase58) {
-    throw new CredoError('verification method is missing publicKeyBase58')
+  if (verificationMethod.publicKeyBase58) {
+    return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.X25519)
+  }
+  if (verificationMethod.publicKeyMultibase) {
+    const key = Key.fromFingerprint(verificationMethod.publicKeyMultibase)
+    if (key.keyType === KeyType.X25519) return key
+    else
+      throw new CredoError(
+        `Unexpected key type from resolving multibase encoding, key type was ${key.keyType} but expected ${KeyType.X25519}`
+      )
   }
 
-  return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.X25519)
+  throw new CredoError('verification method is missing publicKeyBase58 or publicKeyMultibase')
 }
diff --git a/packages/core/src/modules/vc/data-integrity/W3cJsonLdCredentialService.ts b/packages/core/src/modules/vc/data-integrity/W3cJsonLdCredentialService.ts
@@ -15,7 +15,7 @@ import { createWalletKeyPairClass } from '../../../crypto/WalletKeyPair'
 import { CredoError } from '../../../error'
 import { injectable } from '../../../plugins'
 import { asArray, JsonTransformer } from '../../../utils'
-import { VerificationMethod } from '../../dids'
+import { DidsApi, VerificationMethod } from '../../dids'
 import { getKeyFromVerificationMethod } from '../../dids/domain/key-type'
 import { W3cCredentialsModuleConfig } from '../W3cCredentialsModuleConfig'
 import { w3cDate } from '../util'
@@ -339,12 +339,23 @@ export class W3cJsonLdCredentialService {
     agentContext: AgentContext,
     verificationMethod: string
   ): Promise<Key> {
-    const documentLoader = this.w3cCredentialsModuleConfig.documentLoader(agentContext)
-    const verificationMethodObject = await documentLoader(verificationMethod)
-    const verificationMethodClass = JsonTransformer.fromJSON(verificationMethodObject.document, VerificationMethod)
-
-    const key = getKeyFromVerificationMethod(verificationMethodClass)
-    return key
+    if (!verificationMethod.startsWith('did:')) {
+      const documentLoader = this.w3cCredentialsModuleConfig.documentLoader(agentContext)
+      const verificationMethodObject = await documentLoader(verificationMethod)
+      const verificationMethodClass = JsonTransformer.fromJSON(verificationMethodObject.document, VerificationMethod)
+
+      const key = getKeyFromVerificationMethod(verificationMethodClass)
+      return key
+    } else {
+      const [did, keyid] = verificationMethod.split('#')
+      const didsApi = agentContext.dependencyManager.resolve(DidsApi)
+      const doc = await didsApi.resolve(did)
+      if (doc.didDocument) {
+        const verificationMethodClass = doc.didDocument.dereferenceKey(keyid)
+        return getKeyFromVerificationMethod(verificationMethodClass)
+      }
+      throw new CredoError(`Could not resolve verification method with id ${verificationMethod}`)
+    }
   }
 
   private getSignatureSuitesForCredential(agentContext: AgentContext, credential: W3cJsonLdVerifiableCredential) {
diff --git a/packages/indy-vdr/package.json b/packages/indy-vdr/package.json
@@ -26,12 +26,12 @@
     "test": "jest"
   },
   "dependencies": {
-    "@credo-ts/anoncreds": "workspace:*",
-    "@credo-ts/core": "workspace:*"
+    "@credo-ts/anoncreds": "file:./../anoncreds",
+    "@credo-ts/core": "file:./../core"
   },
   "devDependencies": {
     "@hyperledger/indy-vdr-nodejs": "^0.2.2",
-    "@hyperledger/indy-vdr-shared": "^0.2.2",
+    "@hyperledger/indy-vdr-shared": "^0.2.2", 
     "@stablelib/ed25519": "^1.0.2",
     "@types/ref-array-di": "^1.2.6",
     "@types/ref-struct-di": "^1.1.10",
diff --git a/packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts b/packages/indy-vdr/src/anoncreds/IndyVdrAnonCredsRegistry.ts
@@ -1196,4 +1196,4 @@ export type IndyVdrRegisterRevocationStatusList =
   | IndyVdrRegisterRevocationStatusListExternalCreateOptions
   | IndyVdrRegisterRevocationStatusListExternalSubmitOptions
 
-export type IndyVdrRegisterRevocationStatusListOptions = IndyVdrRegisterRevocationStatusList['options']
+export type IndyVdrRegisterRevocationStatusListOptions = IndyVdrRegisterRevocationStatusList['options']
diff --git a/packages/indy-vdr/src/dids/didSovUtil.ts b/packages/indy-vdr/src/dids/didSovUtil.ts
@@ -3,15 +3,13 @@ import {
   DidDocumentService,
   DidDocumentBuilder,
   DidCommV1Service,
-  NewDidCommV2Service,
+  DidCommV2Service,
   convertPublicKeyToX25519,
   CredoError,
   Buffer,
-  NewDidCommV2ServiceEndpoint,
-  DidCommV2Service,
 } from '@credo-ts/core'
 
-export type CommEndpointType = 'endpoint' | 'did-communication' | 'DIDComm' | 'DIDCommMessaging'
+export type CommEndpointType = 'endpoint' | 'did-communication' | 'DIDComm'
 
 export interface IndyEndpointAttrib {
   endpoint?: string
@@ -91,7 +89,7 @@ export function sovDidDocumentFromDid(fullDid: string, verkey: string) {
 
 // Process Indy Attrib Endpoint Types according to: https://sovrin-foundation.github.io/sovrin/spec/did-method-spec-template.html > Read (Resolve) > DID Service Endpoint
 function processEndpointTypes(types?: string[]) {
-  const expectedTypes = ['endpoint', 'did-communication', 'DIDComm', 'DIDCommMessaging']
+  const expectedTypes = ['endpoint', 'did-communication', 'DIDComm']
   const defaultTypes = ['endpoint', 'did-communication']
 
   // Return default types if types "is NOT present [or] empty"
@@ -111,26 +109,11 @@ function processEndpointTypes(types?: string[]) {
 }
 
 export function endpointsAttribFromServices(services: DidDocumentService[]): IndyEndpointAttrib {
-  const commTypes: CommEndpointType[] = ['endpoint', 'did-communication', 'DIDComm', 'DIDCommMessaging']
+  const commTypes: CommEndpointType[] = ['endpoint', 'did-communication', 'DIDComm']
   const commServices = services.filter((item) => commTypes.includes(item.type as CommEndpointType))
 
-  const endpoint =
-    commServices[0] instanceof NewDidCommV2Service
-      ? commServices[0].firstServiceEndpointUri
-      : commServices[0].serviceEndpoint
-
-  if (typeof endpoint !== 'string') {
-    throw new CredoError(
-      `For unknown service endpoint types (${commServices[0].type}) the 'serviceEndpoint' needs to be of type 'string'`
-    )
-  }
-
   // Check that all services use the same endpoint, as only one is accepted
-  if (
-    !commServices.every(
-      (item) => (item instanceof NewDidCommV2Service ? item.firstServiceEndpointUri : item.serviceEndpoint) === endpoint
-    )
-  ) {
+  if (!commServices.every((item) => item.serviceEndpoint === services[0].serviceEndpoint)) {
     throw new CredoError('serviceEndpoint for all services must match')
   }
 
@@ -150,16 +133,10 @@ export function endpointsAttribFromServices(services: DidDocumentService[]): Ind
       commService.routingKeys
     ) {
       commService.routingKeys.forEach((item) => routingKeys.add(item))
-    } else if (commService instanceof NewDidCommV2Service) {
-      const firstServiceEndpoint = Array.isArray(commService.serviceEndpoint)
-        ? commService.serviceEndpoint[0]
-        : commService.serviceEndpoint
-
-      firstServiceEndpoint.routingKeys?.forEach((item) => routingKeys.add(item))
     }
   }
 
-  return { endpoint, types, routingKeys: Array.from(routingKeys) }
+  return { endpoint: services[0].serviceEndpoint as any, types, routingKeys: Array.from(routingKeys) }
 }
 
 export function addServicesFromEndpointsAttrib(
@@ -196,36 +173,21 @@ export function addServicesFromEndpointsAttrib(
           accept: ['didcomm/aip2;env=rfc19'],
         })
       )
-    }
 
-    // If 'DIDCommMessaging' included in types, add DIDComm v2 entry
-    if (processedTypes.includes('DIDCommMessaging')) {
-      builder
-        .addService(
-          new NewDidCommV2Service({
-            id: `${did}#didcomm-messaging-1`,
-            serviceEndpoint: new NewDidCommV2ServiceEndpoint({
-              uri: endpoint,
-              routingKeys: routingKeys,
+      // If 'DIDComm' included in types, add DIDComm v2 entry
+      // TODO: should it be DIDComm or DIDCommMessaging? (see https://github.com/sovrin-foundation/sovrin/issues/343)
+      if (processedTypes.includes('DIDComm')) {
+        builder
+          .addService(
+            new DidCommV2Service({
+              id: `${did}#didcomm-1`,
+              serviceEndpoint: endpoint,
+              routingKeys: routingKeys ?? [],
               accept: ['didcomm/v2'],
-            }),
-          })
-        )
-        .addContext('https://didcomm.org/messaging/contexts/v2')
-    }
-
-    // If 'DIDComm' included in types, add legacy DIDComm v2 entry
-    if (processedTypes.includes('DIDComm')) {
-      builder
-        .addService(
-          new DidCommV2Service({
-            id: `${did}#didcomm-1`,
-            routingKeys: routingKeys,
-            accept: ['didcomm/v2'],
-            serviceEndpoint: endpoint,
-          })
-        )
-        .addContext('https://didcomm.org/messaging/contexts/v2')
+            })
+          )
+          .addContext('https://didcomm.org/messaging/contexts/v2')
+      }
     }
   }
 
@@ -239,4 +201,4 @@ export function addServicesFromEndpointsAttrib(
       })
     )
   }
-}
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -32,9 +32,9 @@ export function isBls12381G1Key2020(verificationMethod: VerificationMethod): ver`
`32`	`32`	`* Get a key from a Bls12381G1Key2020 verification method.`
`33`	`33`	`*/`
`34`	`34`	`export function getKeyFromBls12381G1Key2020(verificationMethod: Bls12381G1Key2020) {`
`35`		`- if (!verificationMethod.publicKeyBase58) {`
`36`		`- throw new CredoError('verification method is missing publicKeyBase58')`
	`35`	`+ if (verificationMethod.publicKeyBase58) {`
	`36`	`+ return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g1)`
`37`	`37`	`}`
`38`	`38`
`39`		`- return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Bls12381g1)`
	`39`	`+ throw new CredoError('verification method is missing publicKeyBase58')`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,9 +43,9 @@ export function isEcdsaSecp256k1VerificationKey2019(`
`43`	`43`	`* Get a key from a EcdsaSecp256k1VerificationKey2019 verification method.`
`44`	`44`	`*/`
`45`	`45`	`export function getKeyFromEcdsaSecp256k1VerificationKey2019(verificationMethod: EcdsaSecp256k1VerificationKey2019) {`
`46`		`- if (!verificationMethod.publicKeyBase58) {`
`47`		`- throw new CredoError('verification method is missing publicKeyBase58')`
	`46`	`+ if (verificationMethod.publicKeyBase58) {`
	`47`	`+ return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.K256)`
`48`	`48`	`}`
`49`	`49`
`50`		`- return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.K256)`
	`50`	`+ throw new CredoError('verification method is missing publicKeyBase58')`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,9 @@ export function isEd25519VerificationKey2018(`
`34`	`34`	`* Get a key from a Ed25519VerificationKey2018 verification method.`
`35`	`35`	`*/`
`36`	`36`	`export function getKeyFromEd25519VerificationKey2018(verificationMethod: Ed25519VerificationKey2018) {`
`37`		`- if (!verificationMethod.publicKeyBase58) {`
`38`		`- throw new CredoError('verification method is missing publicKeyBase58')`
	`37`	`+ if (verificationMethod.publicKeyBase58) {`
	`38`	`+ return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Ed25519)`
`39`	`39`	`}`
`40`	`40`
`41`		`- return Key.fromPublicKeyBase58(verificationMethod.publicKeyBase58, KeyType.Ed25519)`
	`41`	`+ throw new CredoError('verification method is missing publicKeyBase58')`
`42`	`42`	`}`