Skip to content

Add queries and update credential examples for retail VCs. #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 17 commits into from
Sep 3, 2025
Merged

Add queries and update credential examples for retail VCs. #100

merged 17 commits into from
Sep 3, 2025

Conversation

bparth24
Copy link
Contributor

@bparth24 bparth24 commented Aug 18, 2025 •
edited
Loading

  • Adds queries.json and credential.json files for CouponBundle, LoyaltyCard, PaymentToken, and AgeVerification credentials

@bparth24
Copy link
Contributor Author

@BigBlueHat, ready for review.

BigBlueHat
BigBlueHat requested changes Aug 19, 2025
View reviewed changes
Copy link
Contributor

@BigBlueHat BigBlueHat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some initial feedback. More to review, but some things here you can address sooner than later, I think.

credentials/age-verification/credential.json Outdated
Comment on lines 19 to 22
"anchoredResource": {
"id": "urn:uuid:abc12345-6789-def0-1234-56789abcdef0",
"digestMultibase": "zQmYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYjYj"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be more real? Are we building anything around it?

Also, while I see that term in the https://w3id.org/age/v1 context, I don't see it in the vocabulary document that URL dereferences to:
https://www.w3.org/2025/credentials/vcdi/vocab/v2/vocabulary.html#anchoredResource

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BigBlueHat, I'm not sure about it. Good catch, I thought that was accurate. I might need to rely on @msporny @mandyvenables

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for the selfie of the person in the credential, if it is real the digestMultibase is very large.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The digestMultibase shouldn't be large, but if we were to include the full image in the id (as a data: URL), then that would be large. Is that what you meant @mandyvenables?

@bparth24 bparth24 requested a review from BigBlueHat August 19, 2025 14:47
BigBlueHat
BigBlueHat reviewed Aug 20, 2025
View reviewed changes
Copy link
Contributor

@BigBlueHat BigBlueHat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some more comments at this point.

We may want to break these into separate commits to make reviewing more targeted.

My main questions--probably for @msporny and @mandyvenables--center around how "real" all this plumbing needs to be (refresh service, etc.). The VC Playground currently won't care, but if the intent is for the Playground to be its usual jumping off point to other issuer, verifiers, and wallets then we'll want the data to be more real/usable by those downstream consumers. /me thinks.

@bparth24 bparth24 requested a review from BigBlueHat August 21, 2025 12:38
@bparth24 bparth24 force-pushed the bparth24-new-retail-credentials branch from b76c320 to 1cd7bcc Compare August 22, 2025 17:35
@bparth24
Copy link
Contributor Author

@BigBlueHat addressed the final newline in all files in this commit - 0f3c38e

msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
davidlehn
davidlehn reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
msporny
msporny reviewed Aug 28, 2025
View reviewed changes
@bparth24 bparth24 requested a review from msporny August 29, 2025 16:13
@bparth24
Copy link
Contributor Author

@BigBlueHat @msporny

Addressed all requested changes. I intentionally pushed single commits to maintain a clean record and ensure no requested updates were missed.

Additionally, you may notice some formatting updates due to enabling editorconfig, which applies formatOnSave settings from the editorconfig file.

msporny
msporny reviewed Aug 30, 2025
View reviewed changes
msporny
msporny reviewed Aug 30, 2025
View reviewed changes
msporny
msporny reviewed Aug 30, 2025
View reviewed changes
@bparth24
Copy link
Contributor Author

bparth24 commented Aug 30, 2025 •
edited
Loading

@BigBlueHat cc: @msporny @tminard

All requested changes are addressed. @tminard Once this PR is merged, I need your help to publish new context URLs to make it available to the VC playground.

@msporny
Copy link
Contributor

msporny commented Aug 30, 2025

@tminard Once this PR is merged, I need your help to publish new context URLs to make it available to the VC playground.

We should get rid of this requirement. If not in this dev cycle, in a close-by future one.

What we should probably be doing at this point is either using the VCDM v2.0 Examples context or real ones that are out there. We shouldn't be packaging up and releasing contexts for the VC Playground anymore.

@bparth24
Add .DS_store in gitignore
0960934
@bparth24
Add queries and update credential examples for retail VCs.
80c697c 
- Adds queries.json and credential.json files for CouponBundle, LoyaltyCard, PaymentToken, and AgeVerification credentials.
@bparth24
correct image urls
c8477b7
bparth24 and others added 14 commits August 31, 2025 10:53
@bparth24
Correct svg image and mediaType in renderMethod
c9b94d3
@bparth24
Placeholder issuer did value
760fb23
@bparth24
Add digestMultibase property
c2ef557
@bparth24
Add final newline
7ea2658
@msporny @bparth24
Revise age verification credential example.
53c9c92 
- Updates anchoredResource id and digestMultibase values.
- Updates refreshService id and refreshToken.
@msporny @bparth24
Update coupon credential and assets.
06b813f 
- Updates credential type and query to use Coupon instead of CouponBundle.
- Recreates SVG images for coupon card and issuer logo.
- Removes unnecessary icon elements from SVG assets.
- Updates credential and query files to use Coupon instead of CouponBundle.
- Adds digestMultibase property.
- Removes "Ed25519Signature2020" from acceptedCryptosuites in queries.
@msporny @bparth24
Update loyalty card credential and assets.
5641851 
- Updates credential type and query to use RetailCredential and LoyaltyCard.
- Recreates SVG images for loyalty card and issuer logo.
- Removes unnecessary icon elements from SVG assets.
- Adds digestMultibase property to renderMethod.
- Removes "Ed25519Signature2020" from acceptedCryptosuites in queries.
- Removes id and image property from the credentialSubject.
@msporny @bparth24
Update payment token credential and assets.
5bf6d5a 
- Updates credential type and query to use RetailCredential and PaymentToken.
- Recreates SVG images for payment card and issuer logo.
- Removes unnecessary icon elements from SVG assets.
- Adds digestMultibase property to renderMethod.
- Removes "Ed25519Signature2020" from acceptedCryptosuites in queries.
- Removes id property from the credentialSubject.
@bparth24
Update renderMethod SVG template for dynamic credential display.
996ba78 
- Replaces static SVG with dynamic template using credential fields.
- Improves visual rendering and adaptability for coupon credentials.
@bparth24
Add renderMethod context URLs
a0e526d
@bparth24
Clean up svg images - remove number and token
a6757fb
@bparth24
Update renderMethod templates - remove number, token, and icon
83312b0
@bparth24
Add png logo format
9a7922a
@bparth24
Correct naming for image file instead of custom name
ec2866e
@bparth24 bparth24 force-pushed the bparth24-new-retail-credentials branch from 0e4ba7e to ec2866e Compare August 31, 2025 17:54
@BigBlueHat
Copy link
Contributor

@tminard Once this PR is merged, I need your help to publish new context URLs to make it available to the VC playground.

We should get rid of this requirement. If not in this dev cycle, in a close-by future one.

There might have been some wires crossed here. There are no new contexts added to the examples in this PR. However, there are context URLs which were not yet used in other examples--and therefore Veres (and any other implementer) will need to update their systems to support those contexts and those context identifiers/URIs.

That last bit is just par for the course.

I added an npm run extract script last year to help see which context URLs are referenced by the examples which is what @bparth24 used to find the URLs to add to Veres. There's a whole world of context "sync" services we should explore here, but this is how we (have to) do it now.

@BigBlueHat BigBlueHat merged commit 48c57bd into credential-handler:main Sep 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidlehn davidlehn davidlehn left review comments

@mandyvenables mandyvenables mandyvenables left review comments

@BigBlueHat BigBlueHat BigBlueHat approved these changes

@msporny msporny msporny approved these changes

@tminard tminard Awaiting requested review from tminard

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bparth24 @msporny @BigBlueHat @davidlehn @mandyvenables