Skip to content
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.

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

Design: AnonCreds Credentials using the W3C Standard #266

Merged
merged 13 commits into from
Dec 6, 2023

Conversation

Artemkaaas
Copy link
Contributor

@Artemkaaas Artemkaaas commented Nov 2, 2023

This PR contains the very first DRAFT working version of the design documents connected to adoption of AnonCreds Verifiable Credentials and Presentations for the W3C Verifiable Credentials Data Model Standard.
The main goal of this PR is starting the discussion on the proposed format and implementation path / API.

Currently, the PR contains two main documents:

  • spec.md - document describing how AnonCreds credentials and presentations should be represented in the W3C Data Model
    • this document should not be merged into this repository
    • It should be moved and included into AnonCreds specification (I believe)
    • I put it here to have a single place for discussions
  • w3c-representation.md - document describing proposed anoncreds-rs API changes and implementation path.

@Artemkaaas Artemkaaas marked this pull request as draft November 2, 2023 14:39
@Artemkaaas Artemkaaas force-pushed the design/w3c-support branch 7 times, most recently from ccd9c3d to 60d5079 Compare November 3, 2023 05:47
@Artemkaaas Artemkaaas changed the title [WIP] Design: AnonCreds Verifiable Credentials and Presentations using the W3C Verifiable Credentials Data Model Standard Draft: Design: AnonCreds Verifiable Credentials and Presentations using the W3C Verifiable Credentials Data Model Standard Nov 3, 2023
Copy link
Member

@TimoGlastra TimoGlastra left a comment

Choose a reason for hiding this comment

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

Nice, this looks good. I've left some comments and questions, also to get a better understanding of how the result of this work can be integrated into AFJ (and ACA-Py)

docs/design/w3c/encoding.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
Copy link
Contributor

@berendsliedrecht berendsliedrecht left a comment

Choose a reason for hiding this comment

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

I am not very up to date with the intricate details of the w3c vc data model 1.1 and data integrity proof so if I mentioned something that does not make sense, feel free to ignore it.

docs/design/w3c/encoding.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
docs/design/w3c/w3c-representation.md Outdated Show resolved Hide resolved
@Artemkaaas Artemkaaas force-pushed the design/w3c-support branch 2 times, most recently from bf813a5 to d7e3206 Compare November 3, 2023 18:10
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
docs/design/w3c/spec.md Outdated Show resolved Hide resolved
@ashcherbakov
Copy link

A list of open questions (some with proposed answers) in one place (to be extended / updated): link

Signed-off-by: artem.ivanov <[email protected]>
@Artemkaaas Artemkaaas force-pushed the design/w3c-support branch 2 times, most recently from 326ede2 to 21589e7 Compare November 9, 2023 13:31
Signed-off-by: artem.ivanov <[email protected]>
@Artemkaaas Artemkaaas marked this pull request as ready for review November 10, 2023 08:49
@Artemkaaas Artemkaaas changed the title Draft: Design: AnonCreds Verifiable Credentials and Presentations using the W3C Verifiable Credentials Data Model Standard Design: AnonCreds Verifiable Credentials and Presentations using the W3C Verifiable Credentials Data Model Standard Nov 10, 2023
Signed-off-by: artem.ivanov <[email protected]>
@Artemkaaas Artemkaaas changed the title Design: AnonCreds Verifiable Credentials and Presentations using the W3C Verifiable Credentials Data Model Standard Design: AnonCreds Credentials using the W3C Standard Nov 14, 2023
@Artemkaaas
Copy link
Contributor Author

I opened PR in anoncreds-spec repository which add W3C section into AnonCreds credentials specification.

I'm going to exclude context.json and spec.md files from this PR (anoncreds-rs) as these files included into mentioned above PR to anoncreds-spec repository

@vortex-hue
Copy link

Nice documents. Do you have a design [E-R Diagram or anything related to that] explaining how this all adds up?

@Artemkaaas
Copy link
Contributor Author

Artemkaaas commented Nov 25, 2023

#266 (comment)

@vortex-hue what do you mean? The flow itself keeps the same as before (Spec). Now you have a set of parallel methods to get the data in a different format.

@swcurran
Copy link
Member

swcurran commented Dec 6, 2023

Anyone know why a test is failing here? Re-ran the failed test and got it in Ubuntu GHA (Windows the previous time). We can merge this documentation only PR with this, but didn't want the error to be ignored.

@Artemkaaas
Copy link
Contributor Author

@swcurran Should I clean the section with questions before merge?

…on for updating revocation state

Signed-off-by: artem.ivanov <[email protected]>
@swcurran
Copy link
Member

swcurran commented Dec 6, 2023

@swcurran Should I clean the section with questions before merge?

It would be appreciated. Nice to have as well changing the “in the future” items to be now. For example, the for example, the first line that says (more or less) “Currently we don’t support W3C VC Format”. It should say something like “Here is how we support W3C VC Format…”.

Not crucial, but this will be long lived docs, so clean up is good.

@swcurran swcurran merged commit 3c2991b into hyperledger:main Dec 6, 2023
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants