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

refactor: remove ICv1, PPv1 #3252

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dbluhm
Copy link
Contributor

@dbluhm dbluhm commented Sep 24, 2024

This PR removes Issue Credential v1 and Present Proof v1.

This is a rough cut of these changes that will need to be further refined.

Notes on sharp edges to be added.

Change Notes

Issue Credential v1

To enable ICv1 to continue to exist as a plugin, the following changes are/were necessary:

  • Credential revocation status on the cred ex record updated via event handler
  • Attaching a credential offer to an OOB invitation through some plugable means

Present Proof v1

To enable PPv1 to continue to exist as a plugin, the following changes are/were necessary:

  • Abstract proof request extraction to a protocol
  • Attaching a presentation request to an OOB invitaiton through some plugable means

@dbluhm
Copy link
Contributor Author

dbluhm commented Sep 27, 2024

I stewed on how best to handle the OOB invitation attachments for these v1 protocols when they're no longer in the core repo. I think the way I would approach this is:

  • Subclass InvitationCreator from OOB package and override the create_attachment or add a method that handles creating an OOB attachment for a v1 cred issuance or proof presentation.
  • Create a new endpoint in each of the respective plugins that does the OOB invite generation. I think the InvitationCreator should encapsulate enough of the hard stuff that having multiple endpoints for OOB invite generation shouldn't be too bad.

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
3.0% Duplication on New Code (required ≤ 3%)
C Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@dbluhm dbluhm force-pushed the refactor/remove-icv1-ppv1 branch from ae8c5a6 to 1ae4429 Compare February 12, 2025 17:27
@dbluhm dbluhm force-pushed the refactor/remove-icv1-ppv1 branch from 1ae4429 to 5c3d9a2 Compare February 12, 2025 17:28
Signed-off-by: Daniel Bluhm <[email protected]>
@dbluhm
Copy link
Contributor Author

dbluhm commented Feb 12, 2025

I've rebased this PR on current main and resolved merge conflicts. My last comment about restoring the ability to attach v1 credential offers or presentation requests to OOB are still relevant. This would need to be done from the plugin side. I'll make sure my comment is present on the corresponding PR in acapy-plugins.

I believe this is otherwise ready for review. cc @swcurran @jamshale

edit: minus the test failures that I need to take care of 😄

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.

2 participants