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.

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

Update docs for outstanding anoncreds work #3229

Merged
merged 3 commits into from
Sep 16, 2024
Merged

Update docs for outstanding anoncreds work #3229

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f86ef5
Update docs for outstanding anoncreds work
jamshale Sep 12, 2024
7799372
Merge branch 'main' into feat/3192
jamshale Sep 12, 2024
f3e43ce
Merge branch 'main' into feat/3192
jamshale Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions docs/deploying/AnonCredsWalletType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When Aca-Py is run with this wallet type it will run with an Askar format wallet

There is a new package under `aries_cloudagent/anoncreds` with code that supports the new library.

There are new endpoints (under `/anoncreds`) for creating a Schema and Credential Definition. However the new anoncreds code is integrated into the existing Credential and Presentation endpoints (V2.0 endpoints only).
There are new endpoints (under `/anoncreds`) for managing schemas, cred defs and revocation objects. However the new anoncreds code is integrated into the existing Credential and Presentation endpoints (V2.0 endpoints only).

Within the protocols, there are new `handler` libraries to support the new `anoncreds` format (these are in parallel to the existing `indy` libraries).

Expand Down Expand Up @@ -61,7 +61,7 @@ There are no anoncreds-specific integration tests, for the new anoncreds functio

Everything should just work!!!

Theoretically ATH should work with anoncreds as well, by setting the wallet type (see [https://github.com/hyperledger/aries-agent-test-harness#extra-backchannel-specific-parameters](https://github.com/hyperledger/aries-agent-test-harness#extra-backchannel-specific-parameters)).
Theoretically AATH should work with anoncreds as well, by setting the wallet type (see [https://github.com/hyperledger/aries-agent-test-harness#extra-backchannel-specific-parameters](https://github.com/hyperledger/aries-agent-test-harness#extra-backchannel-specific-parameters)).

## Revocation (new in anoncreds)

Expand All @@ -78,16 +78,8 @@ The Tails File changes are minimal -- nothing about the file itself changed. Wh

## Outstanding work

- revocation notifications (not sure if they're included in `anoncreds-rs` updates, haven't tested them ...)
- revocation support - complete the revocation implementation (support for unhappy path scenarios)
- testing - various scenarios like mediation, multitenancy etc.

- unit tests (in the new anoncreds package) (see [https://github.com/hyperledger/aries-cloudagent-python/pull/2596/commits/229ffbba209aff0ea7def5bad6556d93057f3c2a](https://github.com/hyperledger/aries-cloudagent-python/pull/2596/commits/229ffbba209aff0ea7def5bad6556d93057f3c2a))
- more testing - various scenarios like mediation, multitenancy etc.
- unit tests (review and possibly update unit tests for the credential and presentation integration)
- endorsement (not implemented with new anoncreds code)
- wallet upgrade (askar to askar-anoncreds)
- update V1.0 versions of the Credential and Presentation endpoints to use anoncreds
- any other anoncreds issues - [https://github.com/hyperledger/aries-cloudagent-python/issues?q=is%3Aopen+is%3Aissue+label%3AAnonCreds](https://github.com/hyperledger/aries-cloudagent-python/issues?q=is%3Aopen+is%3Aissue+label%3AAnonCreds)

## Retiring old Indy and Askar (credx) Code

Expand Down