What is the best way to add custom columns to Claims and Credentials

[Muhammad-Altabba]

Hello,
We are using the Web DID method. And we need to have custom columns to save for example the relevant id of the claim that exists in our centralized system. And another column to indicate if the credential is supposed to be publicly available through an endpoint that will list all public credentials (like the official website of the company for example).
What do you suggest for us to do? And are those columns are this the best to be added to Claims or to Credentials?
Thanks in advance,

[mirceanis]

Hi @Muhammad-Altabba,
Are these custom claims embedded in the credentials? If they are, you don't need any modification to the database layout. They can be matched using the existing @veramo/data-store API.

Also, the DID method that you use should not matter for this.

[Muhammad-Altabba]

Many Thanks @mirceanis ,
Yes, I think those could be embedded in the credentials.
However, could you please give me more hints about the @veramo/data-store API that I can use?
I checked for example createVerifiableCredential but it does not save the provided custom attributes for the credential object. And I could not find what I should call to add a custom column. It would be great if you give me a link to a code snippet or documentation...

Or do you direct me to save this custom attribute inside the credentialSubject of the credential? In that case, how to query for example based on a specific value of the custom column?

[Muhammad-Altabba]

Hello @mirceanis
If you could please give us some of your valuable hints 😊
Many thanks,

[mirceanis]

Hi @Muhammad-Altabba,
You can try to embed the extra attributes as claims in credentialSubject when you create credentials:

const credential = await agent.createVerifiableCredential({
  credential: {
    issuer: { id: issuer.did },
    type: ['VerifiableCredential'],
    credentialSubject: {
      id: subject.did,
      hello: "world" // add custom properties as claims here
    },
  },
  proofFormat: 'jwt',
  save: true,
})

Then, when you need to get the credentials that have these custom claims, you can try something like this:

const filteredCredentials = await agent.dataStoreORMGetVerifiableCredentialsByClaims({
  where: [
    { column: 'type', value: ['hello'] },
    { column: 'value', value: ['world'] },
  ],
})

I hope this helps

[martijndebruijn]

What if the additional attributes are not part of the Credential (o not part of the proof)? I need to store some additional attrbutes. It would be helpful if I could store them with the Credential.

[mirceanis]

Then I suppose a metadata property for a credential would be helpful.

We don't have this now, but it can technically be added.

Can you share an example of how you would use this?

[martijndebruijn]

A meta data property would help a lot. Currently we store some internal state (status, exteralKey) which is not part of the VC schema. We use the additional internal state in the Android/iOS app to provide some additional functionality. Op zo 21 nov. 2021 om 15:31 schreef Mircea Nistor ***@***.***

…

: Then I suppose a metadata property for a credential would be helpful. We don't have this now, but it can technically be added. Can you share an example of how you would use this? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#647 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABKLAQFSOYXBUIDHIQQNRMTUND7EJANCNFSM5BH2FOFA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.