diff --git a/CHANGELOG.md b/CHANGELOG.md index bdee88dd48..efa74e5e9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,158 @@ # Aries Cloud Agent Python Changelog +## 1.0.0rc4 + +### July 8, 2024 + +This time we mean it! Release 1.0.0rc4 is, despite the non-zero RC number, the first Release Candidate for what will soon be the official ACA-Py 1.0.0. We started to do a 1.0.0 sequence (releasing several RCs) a long time ago, and decided to gate the transition on some requirements that were not as important as we thought at the time. Now we are **really** ready to publish ACA-Py Release 1.0.0. This release is again pulling from the `main` branch. The previous 1.0.0 RC, `rc3`, was approximately equal to [ACA_Py Release 0.8.2](#082). As such, this RC is a **MAJOR** change from that last one. + +Release 1.0.0rc4 includes just over 100 PRs merged since [Release 0.12.1](#0121). The vast majority of that work was in hardening the product in preparation for this 1.0.0 release. While there are a number of new features, the majority of the focus has been on eliminating technical debt and improving the underlying implementation. The full list of PRs in this release can be [found below](#100rc4-categorized-list-of-pull-requests). here are the highlights of the release: + +- The default underlying Python version has been upgraded to 3.12. Happily, there were minimal code changes to enable the upgrade to 3.12 from the previous Python 3.9. +- Pagination support has been added to a number of Admin API queries for object lists, enabling the development of better user interfaces for large deployments. +- Cleanup in the ACA-Py AnonCreds Revocation Registry handling to prevent errors that were found occurring under certain specific conditions. +- Upgraded pull request and release pipeline, including: + - Enabling a much more aggressive approach to dependabot notifications, beyond just those for security vulnerabilities. Along with those upgrades, we've moved to newer/better build pipeline tooling, such as switching from Black to Ruff, and re-enable per pull request code coverage notifications. + - Many of the PRs in this release are related to dependency updates from dependabot or applied directly. + - A switch to more used tooling, such as a switch from black to ruff. + - Improvements in coverage monitoring of pull requests. +- The start of a [DIDComm v2](https://identity.foundation/didcomm-messaging/spec/) implementation in ACA-Py. The work is not complete, as we are taking an incremental approach to adding DIDComm v2 support. +- A decorator has been added for enabling direct support for Admin API authentication. Previously, the only option to enable (the necessary) Admin API was to put the API behind a proxy that could manage authentication. With this update, ACA-Py deployments can handle authentication directly, without a proxy. +- We have dropped support for the old, archived [Indy SDK]. If you have not migrated your deployment off of the Indy SDK, you must do so now. See this [Indy SDK to Askar migration documentation](#https://aca-py.org/latest/deploying/IndySDKtoAskarMigration/) for guidance. +- Support added for using AnonCreds in [W3C VCDM](https://www.w3.org/TR/vc-data-model-1.1/) format. The support is not fully completed, but on the way. + +### 1.0.0rc4 Breaking Changes + +With the focus of the pull requests for this release on stabilizing the implementation, there were a few breaking changes: + +- The default underlying Python version has been upgraded to 3.12. +- Support for the Indy SDK has been dropped. It had been previously deprecated. See this [Indy SDK to Askar migration documentation](#https://aca-py.org/latest/deploying/IndySDKtoAskarMigration/) for guidance. +- The webhook sent after receipt of presentation by a verifier has been updated to include all of the information needed by the verifier so that the controller does not have to call the "Verify Presentation" endpoint. The issue with calling that endpoint after the presentation has been received is that there is a race condition between the controller and the ACA-Py cleanup process deleting completed Present Proof protocol instances. See [\##3081](https://github.com/hyperledger/aries-cloudagent-python/pull/#3081) for additional details. + +#### 1.0.0rc4 Categorized List of Pull Requests + +- DIDComm and Connection Establishment updates/fixes: + - fix: didexchange manager not checking the did-rotate content correctly [\##3057](https://github.com/hyperledger/aries-cloudagent-python/pull/#3057) [gmulhearn-anonyome](https://github.com/gmulhearn-anonyome) + - fix: respond to did:peer:1 with did:peer:4 [\##3050](https://github.com/hyperledger/aries-cloudagent-python/pull/#3050) [dbluhm](https://github.com/dbluhm) + - DIDComm V2 Initial Implementation [\##2959](https://github.com/hyperledger/aries-cloudagent-python/pull/#2959) [TheTechmage](https://github.com/TheTechmage) + - Feature: use decorators for admin api authentication [\##2860](https://github.com/hyperledger/aries-cloudagent-python/pull/#2860) [esune](https://github.com/esune) + +- Admin API, Startup, OpenAPI/Swagger Updates and Improvements: + - 🐛 fix IndyAttrValue bad reference in OpenAPI spec [\##3090](https://github.com/hyperledger/aries-cloudagent-python/pull/#3090) [ff137](https://github.com/ff137) + - 🎨 improve record querying logic [\##3083](https://github.com/hyperledger/aries-cloudagent-python/pull/#3083) [ff137](https://github.com/ff137) + - 🐛 fix storage record pagination with post-filter query params [\##3082](https://github.com/hyperledger/aries-cloudagent-python/pull/#3082) [ff137](https://github.com/ff137) + - ✨ Add pagination support for listing Connection, Cred Ex, and Pres Ex records [\##3033](https://github.com/hyperledger/aries-cloudagent-python/pull/#3033) [ff137](https://github.com/ff137) + - ✨ Adds support for paginated storage queries, and implements pagination for the wallets_list endpoint [\##3000](https://github.com/hyperledger/aries-cloudagent-python/pull/#3000) [ff137](https://github.com/ff137) + - Enable no-transport mode as startup parameter [\##2990](https://github.com/hyperledger/aries-cloudagent-python/pull/#2990) [PatStLouis](https://github.com/PatStLouis) + +- Test and Demo updates: + - Postgres Demo - Upgrade postgres and change entrypoint file [\##3004](https://github.com/hyperledger/aries-cloudagent-python/pull/#3004) [jamshale](https://github.com/jamshale) + - Example integration test issuing 2 credentials under the same schema [\##2948](https://github.com/hyperledger/aries-cloudagent-python/pull/#2948) [ianco](https://github.com/ianco) + +- Credential Exchange updates and fixes: + - Add by_format to terse webhook for presentations [\##3081](https://github.com/hyperledger/aries-cloudagent-python/pull/#3081) [ianco](https://github.com/ianco) + - Use anoncreds registry for holder credential endpoints [\##3063](https://github.com/hyperledger/aries-cloudagent-python/pull/#3063) [jamshale](https://github.com/jamshale) + - For proof problem handler, allow no connection record (OOB cases), prevent unhandled exception [\##3068](https://github.com/hyperledger/aries-cloudagent-python/pull/#3068) [loneil](https://github.com/loneil) + - Handle failed tails server issuance [Anoncreds] [\##3049](https://github.com/hyperledger/aries-cloudagent-python/pull/#3049) [jamshale](https://github.com/jamshale) + - Prevent getting stuck with no active registry [\##3032](https://github.com/hyperledger/aries-cloudagent-python/pull/#3032) [jamshale](https://github.com/jamshale) + - Fix and refactor anoncreds revocation recovery [\##3029](https://github.com/hyperledger/aries-cloudagent-python/pull/#3029) [jamshale](https://github.com/jamshale) + - Fix issue with requested to revoke before registry creation [\##2995](https://github.com/hyperledger/aries-cloudagent-python/pull/#2995) [jamshale](https://github.com/jamshale) + - Add support for revocable credentials in vc_di handler [\##2967](https://github.com/hyperledger/aries-cloudagent-python/pull/#2967) [EmadAnwer](https://github.com/EmadAnwer) + - Fix clear revocation logic [\##2956](https://github.com/hyperledger/aries-cloudagent-python/pull/#2956) [jamshale](https://github.com/jamshale) + - Anoncreds - Send full registry list when getting revocation states [\##2946](https://github.com/hyperledger/aries-cloudagent-python/pull/#2946) [jamshale](https://github.com/jamshale) + - Add missing VC-DI/LD-Proof verification method option [\##2867](https://github.com/hyperledger/aries-cloudagent-python/pull/#2867) [PatStLouis](https://github.com/PatStLouis) + - feat: Integrate AnonCreds with W3C VCDI Format Support in ACA-Py [\##2861](https://github.com/hyperledger/aries-cloudagent-python/pull/#2861) [sarthakvijayvergiya](https://github.com/sarthakvijayvergiya) + - Correct the response type in send_rev_reg_def [\##2355](https://github.com/hyperledger/aries-cloudagent-python/pull/#2355) [ff137](https://github.com/ff137) + +- Upgrade Updates and Improvements: + - Re-enable ledger plugin when --no-legder is set [\##3070](https://github.com/hyperledger/aries-cloudagent-python/pull/#3070) [PatStLouis](https://github.com/PatStLouis) + - 🐛 fix wallet_update when only extra_settings requested [\##2612](https://github.com/hyperledger/aries-cloudagent-python/pull/#2612) [ff137](https://github.com/ff137) + - Upgrade to anoncreds via api endpoint [\##2922](https://github.com/hyperledger/aries-cloudagent-python/pull/#2922) [jamshale](https://github.com/jamshale) + +- Release management pull requests: + - 1.0.0rc4 [\#3092](https://github.com/hyperledger/aries-cloudagent-python/pull/3092) [swcurran](https://github.com/swcurran) + +- Documentation, publishing process updates: + - fix: print provision messages when auto-provision is triggered [\##3077](https://github.com/hyperledger/aries-cloudagent-python/pull/#3077) [TheTechmage](https://github.com/TheTechmage) + - Rule D417 [\##3072](https://github.com/hyperledger/aries-cloudagent-python/pull/#3072) [jamshale](https://github.com/jamshale) + - Fix - only run integration tests on opened PR's [\##3042](https://github.com/hyperledger/aries-cloudagent-python/pull/#3042) [jamshale](https://github.com/jamshale) + - docs: added section on environment variables [\##3028](https://github.com/hyperledger/aries-cloudagent-python/pull/#3028) [Executioner1939](https://github.com/Executioner1939) + - Fix deprecation warnings [\##2756](https://github.com/hyperledger/aries-cloudagent-python/pull/#2756) [ff137](https://github.com/ff137) + - 🎨 clarify LedgerError message when TAA is required and not accepted [\##2545](https://github.com/hyperledger/aries-cloudagent-python/pull/#2545) [ff137](https://github.com/ff137) + - Chore: fix marshmallow warnings [\##2398](https://github.com/hyperledger/aries-cloudagent-python/pull/#2398) [ff137](https://github.com/ff137) + - Fix formatting and grammatical errors in different readme's [\##2222](https://github.com/hyperledger/aries-cloudagent-python/pull/#2222) [ff137](https://github.com/ff137) + - Fix broken link in README [\##2221](https://github.com/hyperledger/aries-cloudagent-python/pull/#2221) [ff137](https://github.com/ff137) + - Manage integration tests with GitHub Actions (#2952) [\##2996](https://github.com/hyperledger/aries-cloudagent-python/pull/#2996) [jamshale](https://github.com/jamshale) + - Update README.md [\##2927](https://github.com/hyperledger/aries-cloudagent-python/pull/#2927) [KPCOFGS](https://github.com/KPCOFGS) + - Add anoncreds migration guide [\##2881](https://github.com/hyperledger/aries-cloudagent-python/pull/#2881) [jamshale](https://github.com/jamshale) + - Fix formatting and grammatical errors in different readme's [\##2222](https://github.com/hyperledger/aries-cloudagent-python/pull/#2222) [ff137](https://github.com/ff137) + - Fix broken link in README [\##2221](https://github.com/hyperledger/aries-cloudagent-python/pull/#2221) [ff137](https://github.com/ff137) + +- Dependencies and Internal Updates: + - Switch from black to ruff [\##3080](https://github.com/hyperledger/aries-cloudagent-python/pull/#3080) [jamshale](https://github.com/jamshale) + - Upgrade python to version 3.12 [\##3067](https://github.com/hyperledger/aries-cloudagent-python/pull/#3067) [jamshale](https://github.com/jamshale) + - Use a published version of aiohttp-apispec [\##3019](https://github.com/hyperledger/aries-cloudagent-python/pull/#3019) [jamshale](https://github.com/jamshale) + - Add sonarcloud badges [\##3014](https://github.com/hyperledger/aries-cloudagent-python/pull/#3014) [jamshale](https://github.com/jamshale) + - Switch from pytz to dateutil [\##3012](https://github.com/hyperledger/aries-cloudagent-python/pull/#3012) [jamshale](https://github.com/jamshale) + - feat: soft binding for plugin flexibility [\##3010](https://github.com/hyperledger/aries-cloudagent-python/pull/#3010) [dbluhm](https://github.com/dbluhm) + - feat: inject profile and session [\##2997](https://github.com/hyperledger/aries-cloudagent-python/pull/#2997) [dbluhm](https://github.com/dbluhm) + - ✨ Faster uuid generation [\##2994](https://github.com/hyperledger/aries-cloudagent-python/pull/#2994) [ff137](https://github.com/ff137) + - Sonarcloud with code coverage [\##2968](https://github.com/hyperledger/aries-cloudagent-python/pull/#2968) [jamshale](https://github.com/jamshale) + - Fix Snyk sarif file [\##2961](https://github.com/hyperledger/aries-cloudagent-python/pull/#2961) [pradeepp88](https://github.com/pradeepp88) + - Add OpenSSF Scorecard GHA - weekly [\##2955](https://github.com/hyperledger/aries-cloudagent-python/pull/#2955) [swcurran](https://github.com/swcurran) + - Fix Snyk Container scanning workflow [\##2951](https://github.com/hyperledger/aries-cloudagent-python/pull/#2951) [WadeBarnes](https://github.com/WadeBarnes) + - chore: updating dependabot to support gha, python, docker and dev container packages [\##2945](https://github.com/hyperledger/aries-cloudagent-python/pull/#2945) [rajpalc7](https://github.com/rajpalc7) + - fix(interop): overly strict validation [\##2943](https://github.com/hyperledger/aries-cloudagent-python/pull/#2943) [dbluhm](https://github.com/dbluhm) + - ⬆️ Upgrade test and lint dependencies [\##2939](https://github.com/hyperledger/aries-cloudagent-python/pull/#2939) [ff137](https://github.com/ff137) + - ⬆️ Upgrade aiohttp-apispec [\##2920](https://github.com/hyperledger/aries-cloudagent-python/pull/#2920) [ff137](https://github.com/ff137) + - ⬆️ Upgrade pydid (pydantic v2) [\##2919](https://github.com/hyperledger/aries-cloudagent-python/pull/#2919) [ff137](https://github.com/ff137) + - feat: drop indy sdk [\##2892](https://github.com/hyperledger/aries-cloudagent-python/pull/#2892) [dbluhm](https://github.com/dbluhm) + - Change middleware registration order [\##2796](https://github.com/hyperledger/aries-cloudagent-python/pull/#2796) [PatStLouis](https://github.com/PatStLouis) + - ⬆️ Upgrade pytest to 8.0 [\##2773](https://github.com/hyperledger/aries-cloudagent-python/pull/#2773) [ff137](https://github.com/ff137) + - ⬆️ Update pytest-asyncio to 0.23.4 [\##2764](https://github.com/hyperledger/aries-cloudagent-python/pull/#2764) [ff137](https://github.com/ff137) + - Upgrade pre-commit and flake8 dependencies; fix flake8 warnings [\##2399](https://github.com/hyperledger/aries-cloudagent-python/pull/#2399) [ff137](https://github.com/ff137) + - ⬆️ upgrade requests to latest [\##2336](https://github.com/hyperledger/aries-cloudagent-python/pull/#2336) [ff137](https://github.com/ff137) + - ⬆️ upgrade pyjwt to latest; introduce leeway to jwt.decode [\##2335](https://github.com/hyperledger/aries-cloudagent-python/pull/#2335) [ff137](https://github.com/ff137) + - ⬆️ upgrade packaging to latest [\##2334](https://github.com/hyperledger/aries-cloudagent-python/pull/#2334) [ff137](https://github.com/ff137) + - ⬆️ upgrade marshmallow to latest [\##2322](https://github.com/hyperledger/aries-cloudagent-python/pull/#2322) [ff137](https://github.com/ff137) + - Upgrade codegen tools in scripts/generate-open-api-spec and publish Swagger 2.0 and OpenAPI 3.0 specs [\##2246](https://github.com/hyperledger/aries-cloudagent-python/pull/#2246) [ff137](https://github.com/ff137) + +- Dependabot PRs: + - chore(deps): Bump certifi from 2024.6.2 to 2024.7.4 in /demo/playground/examples in the pip group [\##3084](https://github.com/hyperledger/aries-cloudagent-python/pull/#3084) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump aries-askar from 0.3.1 to 0.3.2 [\##3088](https://github.com/hyperledger/aries-cloudagent-python/pull/#3088) [dependabot bot](https://github.com/dependabot bot) + - chore(deps-dev): Bump ruff from 0.5.0 to 0.5.1 [\##3087](https://github.com/hyperledger/aries-cloudagent-python/pull/#3087) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump mkdocs-material from 9.5.27 to 9.5.28 [\##3089](https://github.com/hyperledger/aries-cloudagent-python/pull/#3089) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump certifi from 2024.6.2 to 2024.7.4 in the pip group [\##3085](https://github.com/hyperledger/aries-cloudagent-python/pull/#3085) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump requests from 2.32.2 to 2.32.3 [\##3076](https://github.com/hyperledger/aries-cloudagent-python/pull/#3076) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump uuid-utils from 0.8.0 to 0.9.0 [\##3075](https://github.com/hyperledger/aries-cloudagent-python/pull/#3075) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump mike from 2.0.0 to 2.1.2 [\##3074](https://github.com/hyperledger/aries-cloudagent-python/pull/#3074) [dependabot bot](https://github.com/dependabot bot) + - chore(deps-dev): Bump ruff from 0.4.10 to 0.5.0 [\##3073](https://github.com/hyperledger/aries-cloudagent-python/pull/#3073) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump dawidd6/action-download-artifact from 5 to 6 in the all-actions group [\##3064](https://github.com/hyperledger/aries-cloudagent-python/pull/#3064) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump markupsafe from 2.0.1 to 2.1.5 [\##3062](https://github.com/hyperledger/aries-cloudagent-python/pull/#3062) [dependabot bot](https://github.com/dependabot bot) + - chore(deps-dev): Bump pydevd-pycharm from 193.6015.41 to 193.7288.30 [\##3060](https://github.com/hyperledger/aries-cloudagent-python/pull/#3060) [dependabot bot](https://github.com/dependabot bot) + - chore(deps-dev): Bump ruff from 0.4.4 to 0.4.10 [\##3058](https://github.com/hyperledger/aries-cloudagent-python/pull/#3058) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump the pip group with 2 updates [\##3046](https://github.com/hyperledger/aries-cloudagent-python/pull/#3046) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump urllib3 from 2.2.1 to 2.2.2 in /demo/playground/examples in the pip group [\##3045](https://github.com/hyperledger/aries-cloudagent-python/pull/#3045) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump marshmallow from 3.20.2 to 3.21.3 [\##3038](https://github.com/hyperledger/aries-cloudagent-python/pull/#3038) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump packaging from 23.1 to 23.2 [\##3037](https://github.com/hyperledger/aries-cloudagent-python/pull/#3037) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump mkdocs-material from 9.5.10 to 9.5.27 [\##3036](https://github.com/hyperledger/aries-cloudagent-python/pull/#3036) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump configargparse from 1.5.5 to 1.7 [\##3035](https://github.com/hyperledger/aries-cloudagent-python/pull/#3035) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump uuid-utils from 0.7.0 to 0.8.0 [\##3034](https://github.com/hyperledger/aries-cloudagent-python/pull/#3034) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump dawidd6/action-download-artifact from 3 to 5 in the all-actions group [\##3027](https://github.com/hyperledger/aries-cloudagent-python/pull/#3027) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Update prompt-toolkit requirement from ~=2.0.9 to ~=2.0.10 in /demo [\##3026](https://github.com/hyperledger/aries-cloudagent-python/pull/#3026) [dependabot bot](https://github.com/dependabot bot) + - chore(deps-dev): Bump pytest from 8.2.1 to 8.2.2 [\##3025](https://github.com/hyperledger/aries-cloudagent-python/pull/#3025) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump pydid from 0.5.0 to 0.5.1 [\##3024](https://github.com/hyperledger/aries-cloudagent-python/pull/#3024) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump sphinx from 1.8.4 to 1.8.6 [\##3021](https://github.com/hyperledger/aries-cloudagent-python/pull/#3021) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump actions/checkout from 3 to 4 in the all-actions group [\##3011](https://github.com/hyperledger/aries-cloudagent-python/pull/#3011) [dependabot bot](https://github.com/dependabot bot) + - Merge all demo dependabot PRs [\##3008](https://github.com/hyperledger/aries-cloudagent-python/pull/#3008) [PatStLouis](https://github.com/PatStLouis) + - Merge all poetry dependabot PRs [\##3007](https://github.com/hyperledger/aries-cloudagent-python/pull/#3007) [PatStLouis](https://github.com/PatStLouis) + - chore(deps): Bump hyperledger/aries-cloudagent-python from py3.9-0.9.0 to py3.9-0.12.1 in /demo/multi-demo [\##2976](https://github.com/hyperledger/aries-cloudagent-python/pull/#2976) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump hyperledger/aries-cloudagent-python from py3.9-0.10.4 to py3.9-0.12.1 in /demo/playground [\##2975](https://github.com/hyperledger/aries-cloudagent-python/pull/#2975) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump hyperledger/aries-cloudagent-python from py3.9-0.9.0 to py3.9-0.12.1 in /demo/docker-agent [\##2973](https://github.com/hyperledger/aries-cloudagent-python/pull/#2973) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump sphinx-rtd-theme from 1.1.1 to 1.3.0 in /docs [\##2970](https://github.com/hyperledger/aries-cloudagent-python/pull/#2970) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump untergeek/curator from 8.0.2 to 8.0.15 in /demo/elk-stack/extensions/curator [\##2969](https://github.com/hyperledger/aries-cloudagent-python/pull/#2969) [dependabot bot](https://github.com/dependabot bot) + - chore(deps): Bump ecdsa from 0.16.1 to 0.19.0 in the pip group across 1 directory [\##2933](https://github.com/hyperledger/aries-cloudagent-python/pull/#2933) [dependabot bot](https://github.com/dependabot bot) + ## 0.12.1 ### April 26, 2024 diff --git a/docs/conf.py b/docs/conf.py index c07343c1a2..c5ead40f54 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,6 +59,7 @@ "typing_extensions", "unflatten", "yaml", + "uuid_utils", ] # "aries_cloudagent.tests.test_conductor", diff --git a/docs/features/SupportedRFCs.md b/docs/features/SupportedRFCs.md index 2e6048858e..c0dff61bd4 100644 --- a/docs/features/SupportedRFCs.md +++ b/docs/features/SupportedRFCs.md @@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page welcome! If you have any questions, please contact us on the #aries channel on [Hyperledger Discord](https://discord.gg/hyperledger) or through an issue in this repo. -**Last Update**: 2024-05-01, Release 0.12.1 +**Last Update**: 2024-07-08, Release 1.0.0rc4 > The checklist version of this document was created as a joint effort > between [Northern Block](https://northernblock.io/), [Animo Solutions](https://animo.id/) and the Ontario government, on behalf of the Ontario government. @@ -22,7 +22,7 @@ ACA-Py and other Aries Frameworks and Agents. | AIP Version | Supported | Notes | | - | :-------: | -------- | | AIP 1.0 | :white_check_mark: | Fully supported. | -| AIP 2.0 | :white_check_mark: | Fully supported, with a couple of very minor exceptions noted [below](#aip-20). | +| AIP 2.0 | :white_check_mark: | Fully supported. | A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can be found [later in this document](#supported-rfcs). @@ -77,9 +77,9 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b | --- | :--: | -- | | [Aries Askar] | :white_check_mark: | Recommended - Aries Askar provides equivalent/evolved secure storage and cryptography support to the "indy-wallet" part of the Indy SDK. When using Askar (via the `--wallet-type askar` startup parameter), other functionality is handled by [CredX](https://github.com/hyperledger/indy-shared-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions). | | [Aries Askar]-AnonCreds | :white_check_mark: | Recommended - When using Askar/AnonCreds (via the `--wallet-type askar-anoncreds` startup parameter), other functionality is handled by [AnonCreds RS](https://github.com/hyperledger/anoncreds-rs) (AnonCreds) and [Indy VDR](https://github.com/hyperledger/indy-vdr) (Indy ledger interactions).

This `wallet-type` will eventually be the same as `askar` when we have fully integrated the AnonCreds RS library into ACA-Py. | -| [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage) | :warning: Deprecated | **To be removed in the next Major/Minor release of ACA-Py** Full support for the features of the "indy-wallet" secure storage capabilities found in the Indy SDK. | +| [Indy SDK](https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage) | :x: | **Removed in ACA-Py Release 1.0.0rc4** | -> New installations of ACA-Py should **NOT** use the [Indy SDK]. Existing deployments using the [Indy SDK] should transition to [Aries Askar] and related components as soon as possible. +> Existing deployments using the [Indy SDK] **MUST** transition to [Aries Askar] and related components as soon as possible. See the [Indy SDK to Askar Migration Guide] for guidance. [Aries Askar]: https://github.com/hyperledger/aries-askar [Indy SDK]: https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage diff --git a/docs/generated/aries_cloudagent.admin.rst b/docs/generated/aries_cloudagent.admin.rst index efcb59a1cb..11359d190b 100644 --- a/docs/generated/aries_cloudagent.admin.rst +++ b/docs/generated/aries_cloudagent.admin.rst @@ -33,6 +33,14 @@ aries\_cloudagent.admin.request\_context module :undoc-members: :show-inheritance: +aries\_cloudagent.admin.routes module +------------------------------------- + +.. automodule:: aries_cloudagent.admin.routes + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.admin.server module ------------------------------------- diff --git a/docs/generated/aries_cloudagent.anoncreds.default.legacy_indy.rst b/docs/generated/aries_cloudagent.anoncreds.default.legacy_indy.rst index 19e6affe08..c145d2620f 100644 --- a/docs/generated/aries_cloudagent.anoncreds.default.legacy_indy.rst +++ b/docs/generated/aries_cloudagent.anoncreds.default.legacy_indy.rst @@ -17,6 +17,14 @@ aries\_cloudagent.anoncreds.default.legacy\_indy.author module :undoc-members: :show-inheritance: +aries\_cloudagent.anoncreds.default.legacy\_indy.recover module +--------------------------------------------------------------- + +.. automodule:: aries_cloudagent.anoncreds.default.legacy_indy.recover + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.anoncreds.default.legacy\_indy.registry module ---------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.didcomm_v2.rst b/docs/generated/aries_cloudagent.didcomm_v2.rst new file mode 100644 index 0000000000..023604b818 --- /dev/null +++ b/docs/generated/aries_cloudagent.didcomm_v2.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.didcomm\_v2 package +===================================== + +.. automodule:: aries_cloudagent.didcomm_v2 + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.didcomm\_v2.adapters module +--------------------------------------------- + +.. automodule:: aries_cloudagent.didcomm_v2.adapters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.indy.rst b/docs/generated/aries_cloudagent.indy.rst index 0e5c50f637..6d354b0892 100644 --- a/docs/generated/aries_cloudagent.indy.rst +++ b/docs/generated/aries_cloudagent.indy.rst @@ -14,7 +14,6 @@ Subpackages aries_cloudagent.indy.credx aries_cloudagent.indy.models - aries_cloudagent.indy.sdk Submodules ---------- diff --git a/docs/generated/aries_cloudagent.indy.sdk.rst b/docs/generated/aries_cloudagent.indy.sdk.rst deleted file mode 100644 index be5adbf5ae..0000000000 --- a/docs/generated/aries_cloudagent.indy.sdk.rst +++ /dev/null @@ -1,74 +0,0 @@ -aries\_cloudagent.indy.sdk package -================================== - -.. automodule:: aries_cloudagent.indy.sdk - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -aries\_cloudagent.indy.sdk.error module ---------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.error - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.holder module ----------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.holder - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.issuer module ----------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.issuer - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.profile module ------------------------------------------ - -.. automodule:: aries_cloudagent.indy.sdk.profile - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.util module --------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.util - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.verifier module ------------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.verifier - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.wallet\_plugin module ------------------------------------------------- - -.. automodule:: aries_cloudagent.indy.sdk.wallet_plugin - :members: - :undoc-members: - :show-inheritance: - -aries\_cloudagent.indy.sdk.wallet\_setup module ------------------------------------------------ - -.. automodule:: aries_cloudagent.indy.sdk.wallet_setup - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst b/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst index ed257bc7cf..d6b4152e26 100644 --- a/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst +++ b/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst @@ -17,14 +17,6 @@ aries\_cloudagent.ledger.multiple\_ledger.base\_manager module :undoc-members: :show-inheritance: -aries\_cloudagent.ledger.multiple\_ledger.indy\_manager module --------------------------------------------------------------- - -.. automodule:: aries_cloudagent.ledger.multiple_ledger.indy_manager - :members: - :undoc-members: - :show-inheritance: - aries\_cloudagent.ledger.multiple\_ledger.indy\_vdr\_manager module ------------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.ledger.rst b/docs/generated/aries_cloudagent.ledger.rst index aff0574fef..b5296d3be4 100644 --- a/docs/generated/aries_cloudagent.ledger.rst +++ b/docs/generated/aries_cloudagent.ledger.rst @@ -42,14 +42,6 @@ aries\_cloudagent.ledger.error module :undoc-members: :show-inheritance: -aries\_cloudagent.ledger.indy module ------------------------------------- - -.. automodule:: aries_cloudagent.ledger.indy - :members: - :undoc-members: - :show-inheritance: - aries\_cloudagent.ledger.indy\_vdr module ----------------------------------------- diff --git a/docs/generated/aries_cloudagent.messaging.models.rst b/docs/generated/aries_cloudagent.messaging.models.rst index cc951ac8e0..37dcdc8638 100644 --- a/docs/generated/aries_cloudagent.messaging.models.rst +++ b/docs/generated/aries_cloudagent.messaging.models.rst @@ -32,3 +32,11 @@ aries\_cloudagent.messaging.models.openapi module :members: :undoc-members: :show-inheritance: + +aries\_cloudagent.messaging.models.paginated\_query module +---------------------------------------------------------- + +.. automodule:: aries_cloudagent.messaging.models.paginated_query + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.messaging.rst b/docs/generated/aries_cloudagent.messaging.rst index ef1d420b33..33d9dc2f7f 100644 --- a/docs/generated/aries_cloudagent.messaging.rst +++ b/docs/generated/aries_cloudagent.messaging.rst @@ -85,6 +85,14 @@ aries\_cloudagent.messaging.util module :undoc-members: :show-inheritance: +aries\_cloudagent.messaging.v2\_agent\_message module +----------------------------------------------------- + +.. automodule:: aries_cloudagent.messaging.v2_agent_message + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.messaging.valid module ---------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.rst b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.rst index 6324119ace..e73146bae2 100644 --- a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.rst +++ b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.rst @@ -15,6 +15,7 @@ Subpackages aries_cloudagent.protocols.issue_credential.v2_0.formats.anoncreds aries_cloudagent.protocols.issue_credential.v2_0.formats.indy aries_cloudagent.protocols.issue_credential.v2_0.formats.ld_proof + aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di Submodules ---------- diff --git a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.rst b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.rst new file mode 100644 index 0000000000..62f87e5eef --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.rst @@ -0,0 +1,34 @@ +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di.models package +================================================================================= + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di.models.cred module +------------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.cred + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di.models.cred\_offer module +-------------------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.cred_offer + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di.models.cred\_request module +---------------------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models.cred_request + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.rst b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.rst new file mode 100644 index 0000000000..dbe32bad96 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.rst @@ -0,0 +1,26 @@ +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di package +========================================================================== + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.models + +Submodules +---------- + +aries\_cloudagent.protocols.issue\_credential.v2\_0.formats.vc\_di.handler module +--------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.formats.vc_di.handler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.rst b/docs/generated/aries_cloudagent.rst index b3d1a7de7b..20f1181431 100644 --- a/docs/generated/aries_cloudagent.rst +++ b/docs/generated/aries_cloudagent.rst @@ -21,6 +21,7 @@ Subpackages aries_cloudagent.connections aries_cloudagent.core aries_cloudagent.did + aries_cloudagent.didcomm_v2 aries_cloudagent.holder aries_cloudagent.indy aries_cloudagent.ledger diff --git a/docs/generated/aries_cloudagent.storage.rst b/docs/generated/aries_cloudagent.storage.rst index b38e0fbb92..814c817f80 100644 --- a/docs/generated/aries_cloudagent.storage.rst +++ b/docs/generated/aries_cloudagent.storage.rst @@ -49,14 +49,6 @@ aries\_cloudagent.storage.in\_memory module :undoc-members: :show-inheritance: -aries\_cloudagent.storage.indy module -------------------------------------- - -.. automodule:: aries_cloudagent.storage.indy - :members: - :undoc-members: - :show-inheritance: - aries\_cloudagent.storage.record module --------------------------------------- diff --git a/docs/generated/aries_cloudagent.storage.vc_holder.rst b/docs/generated/aries_cloudagent.storage.vc_holder.rst index 7bd5098aff..d08fac3cf6 100644 --- a/docs/generated/aries_cloudagent.storage.vc_holder.rst +++ b/docs/generated/aries_cloudagent.storage.vc_holder.rst @@ -33,14 +33,6 @@ aries\_cloudagent.storage.vc\_holder.in\_memory module :undoc-members: :show-inheritance: -aries\_cloudagent.storage.vc\_holder.indy module ------------------------------------------------- - -.. automodule:: aries_cloudagent.storage.vc_holder.indy - :members: - :undoc-members: - :show-inheritance: - aries\_cloudagent.storage.vc\_holder.vc\_record module ------------------------------------------------------ diff --git a/docs/generated/aries_cloudagent.transport.rst b/docs/generated/aries_cloudagent.transport.rst index 33aed946ad..0bc9d508a0 100644 --- a/docs/generated/aries_cloudagent.transport.rst +++ b/docs/generated/aries_cloudagent.transport.rst @@ -43,6 +43,14 @@ aries\_cloudagent.transport.stats module :undoc-members: :show-inheritance: +aries\_cloudagent.transport.v2\_pack\_format module +--------------------------------------------------- + +.. automodule:: aries_cloudagent.transport.v2_pack_format + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.transport.wire\_format module ----------------------------------------------- diff --git a/docs/generated/aries_cloudagent.utils.rst b/docs/generated/aries_cloudagent.utils.rst index 0cb4042147..b1c0bb8aed 100644 --- a/docs/generated/aries_cloudagent.utils.rst +++ b/docs/generated/aries_cloudagent.utils.rst @@ -49,6 +49,14 @@ aries\_cloudagent.utils.env module :undoc-members: :show-inheritance: +aries\_cloudagent.utils.general module +-------------------------------------- + +.. automodule:: aries_cloudagent.utils.general + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.utils.http module ----------------------------------- diff --git a/docs/generated/aries_cloudagent.wallet.rst b/docs/generated/aries_cloudagent.wallet.rst index f62c10b649..32dad82f81 100644 --- a/docs/generated/aries_cloudagent.wallet.rst +++ b/docs/generated/aries_cloudagent.wallet.rst @@ -17,6 +17,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.wallet.anoncreds\_upgrade module +-------------------------------------------------- + +.. automodule:: aries_cloudagent.wallet.anoncreds_upgrade + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.wallet.askar module ------------------------------------- @@ -105,14 +113,6 @@ aries\_cloudagent.wallet.in\_memory module :undoc-members: :show-inheritance: -aries\_cloudagent.wallet.indy module ------------------------------------- - -.. automodule:: aries_cloudagent.wallet.indy - :members: - :undoc-members: - :show-inheritance: - aries\_cloudagent.wallet.jwt module ----------------------------------- @@ -153,6 +153,14 @@ aries\_cloudagent.wallet.sd\_jwt module :undoc-members: :show-inheritance: +aries\_cloudagent.wallet.singletons module +------------------------------------------ + +.. automodule:: aries_cloudagent.wallet.singletons + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.wallet.util module ------------------------------------ diff --git a/open-api/openapi.json b/open-api/openapi.json index b0ed647f71..cde7a06f0a 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -2,7 +2,7 @@ "openapi" : "3.0.1", "info" : { "title" : "Aries Cloud Agent", - "version" : "v0.12.1" + "version" : "v1.0.0rc4" }, "servers" : [ { "url" : "/" diff --git a/open-api/swagger.json b/open-api/swagger.json index 33b4e1842a..4a6715caff 100644 --- a/open-api/swagger.json +++ b/open-api/swagger.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "version" : "v0.12.1", + "version" : "v1.0.0rc4", "title" : "Aries Cloud Agent" }, "tags" : [ { diff --git a/pyproject.toml b/pyproject.toml index 0214be0362..b62130d4ed 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "aries_cloudagent" -version = "0.12.1" +version = "1.0.0rc4" description = "Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments. " authors = ["Hyperledger Aries "] license = "Apache-2.0"