Releases: openwallet-foundation/acapy
0.12.3
A patch release to add address a bug found in the Linked Data Verifiable Credential handling for multi-tenant holders. The bug was fixed in the main branch, PR 3391 - BREAKING: VCHolder multitenant binding, and with this release is backported to 0.12 Long Term Support branch. Prior to this release, holder credentials received into a tenant wallet were actually received into the multi-tenant admin wallet.
0.12.3 Breaking Changes
There are no breaking changes in this release.
What's Changed
- Patch PR 3391 - 0.12.lts by @jamshale in #3396
- 0.12.3rc0 by @swcurran in #3406
- Add legacy pypi token by @jamshale in #3408
- 0.12.3 by @swcurran in #3409
Full Changelog: 0.12.2...0.12.3
0.12.3rc0
A patch release to add address a bug found in the Linked Data Verifiable Credential handling for multi-tenant holders. The bug was fixed in the main branch, PR 3391 - BREAKING: VCHolder multitenant binding, and with this release is backported to 0.12 Long Term Support branch. Prior to this release, holders credentials received into a tenant wallet were actually received into the multitenant admin wallet.
0.12.3rc0 Breaking Changes
There are no breaking changes in this release.
What's Changed
Full Changelog: 0.12.2...0.12.3rc0
1.1.1rc0
Release 1.1.1 is a patch update to ACA-Py that contains a lengthy list of adjustments, improvements and fixes, with a focus on removing Technical Debt. The most visible change is the removal of the "in-memory wallet" implementation in favour of using the SQLite in-memory wallet (sqlite://:memory:
), including removing the logic for handling that extra wallet type. While arguably a breaking change (and we mention it below), we're confident no one is using the in-memory wallet (right?!?) any where other than in tests. In removing the in-memory wallet, all of the unit and integration tests that used the in-memory wallet were updated to use SQLite's in-memory wallet.
The first step to full support of did:webvh (for "did:web
+ Verifiable History" -- formerly called did:tdw
) has been added to ACA-Py -- a resolver. We're working on adding new DID Registration for it and other DID Methods, enabling ACA-Py to be used easily with a variety of DID Methods.
The move to the OpenWallet Foundation is now complete. For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please see latest in GitHub Issue #3250.
1.1.1 Deprecation Notices
The same deprecation notices from the 1.1.0 release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.1 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!
1.1.1 Breaking Changes
While there are no breaking changes in this release that might impact production deployments, the removal of the "in-memory" wallet implementation might be break some test scripts. Rather than using the in-memory wallet, tests should be updated to use SQLite's special sqlite://:memory:
database instead. This results in a better alignment between tests and a production environment.
What's Changed
- 📝 Fix links in README by @ff137 in #3295
- ⬆️ Update lock file by @ff137 in #3296
- chore(deps): Bump mkdocs-material from 9.5.39 to 9.5.41 by @dependabot in #3293
- chore(deps): Bump jsonpath-ng from 1.6.1 to 1.7.0 by @dependabot in #3288
- 🐛 Handle failure to resolve DIDComm services in DIDXManager by @ff137 in #3298
- chore(deps): Bump mkdocs-material from 9.5.41 to 9.5.42 by @dependabot in #3305
- chore(deps-dev): Bump ruff from 0.6.9 to 0.7.0 by @dependabot in #3304
- chore(deps): Bump marshmallow from 3.22.0 to 3.23.0 by @dependabot in #3303
- chore(deps): Update asyncpg requirement from ~=0.29.0 to ~=0.30.0 by @dependabot in #3302
- Fix endorsement setup with existing connection by @jamshale in #3309
- 🐛 Rearrange connection record deletion after hangup by @ff137 in #3310
- 🎨 Refactor string concatenation in model descriptions by @ff137 in #3313
- chore(deps-dev): Bump ruff from 0.7.0 to 0.7.1 by @dependabot in #3314
- Docs (devcontainer) Change folder names by @loneil in #3317
- 🔧 set default fixture scope for pytest-asyncio by @ff137 in #3318
- 🎨 Refactor the logging module monolith by @ff137 in #3319
- 🎨 Refactor Multitenant Manager errors and exception handling by @ff137 in #3323
- chore(deps): Bump marshmallow from 3.23.0 to 3.23.1 by @dependabot in #3325
- chore(deps-dev): Bump ruff from 0.7.1 to 0.7.2 by @dependabot in #3326
- chore(deps): Bump mkdocs-material from 9.5.42 to 9.5.43 by @dependabot in #3324
- Update accumulator value in wallet on repair by @jamshale in #3299
- ✨ Handle NotFound and UnprocessableEntity errors in middleware by @ff137 in #3327
- Remove in memory wallet by @jamshale in #3311
- ✅ Re-add ready_middleware unit tests by @ff137 in #3330
- 👷 Fix Nightly Publish to not run on forks by @ff137 in #3333
- chore(deps): Bump mkdocs-material from 9.5.43 to 9.5.44 by @dependabot in #3336
- Don't pass rekey to sub_wallet_profile by @jamshale in #3312
- chore(deps-dev): Bump ruff from 0.7.2 to 0.7.3 by @dependabot in #3334
- chore(deps-dev): Bump debugpy from 1.8.7 to 1.8.8 by @dependabot in #3335
- More robust verification method selection by did by @dbluhm in #3279
- 🎨 Fix current test warnings by @ff137 in #3338
- chore(deps-dev): Bump ruff from 0.7.3 to 0.7.4 by @dependabot in #3341
- chore(deps): Bump aiohttp from 3.11.0 to 3.11.2 by @dependabot in #3340
- chore(deps): Bump pyjwt from 2.9.0 to 2.10.0 by @dependabot in #3339
- did:tdw resolver by @jamshale in #3237
- chore(deps): Bump aiohttp from 3.10.5 to 3.10.11 in /scenarios in the pip group across 1 directory by @dependabot in #3342
- Fix tails upload for anoncreds multitenancy by @jamshale in #3346
- Add anoncreds issuance and presentation format by @jamshale in #3331
- Restore
--base-wallet-routes
flag functionality by @esune in #3344 - Fix subwallet anoncreds upgrade check by @jamshale in #3345
- Fix/universal resolver by @jamshale in #3354
- chore(deps-dev): Bump ruff from 0.7.4 to 0.8.0 by @dependabot in #3348
- chore(deps): Bump mkdocs-material from 9.5.44 to 9.5.46 by @dependabot in #3352
- chore(deps): Bump uuid-utils from 0.9.0 to 0.10.0 by @dependabot in #3351
- chore(deps-dev): Bump debugpy from 1.8.8 to 1.8.9 by @dependabot in #3350
- chore(deps): Bump aiohttp from 3.11.2 to 3.11.7 by @dependabot in #3349
- 🎨 Sync Ruff version in configs and apply formatting by @ff137 in #3358
- 🎨 Replace deprecated ABC decorators by @ff137 in #3357
- Add test wallet config option by @jamshale in #3355
- Week 49 Library upgrades by @jamshale in #3368
- ⚡ Add class caching to DeferLoad by @ff137 in #3361
- fix: check routing keys on indy_vdr endpoint refresh by @dbluhm in #3371
- Make vc libraries mandatory by @jamshale in #3356
- Repair release bdd tests by @jamshale in #3376
- 1.1.1rc0 by @swcurran in #3372
Full Changelog: 1.1.0...1.1.1rc0
1.1.0
Release 1.1.0 is the first release of ACA-Py from the OpenWallet Foundation (OWF). The only reason for the release is to test out all of the release publishing actions now that we have moved the repo to its new home (https://github.com/openwallet-foundation/acapy). Almost all of the changes in the release are related to the move.
The move triggered some big changes for those with existing ACA-Py deployments resulting from the change in the GitHub organization (from Hyperledger to OWF) and source code name (from aries_cloudagent
to acapy_agent
). See the Release 1.1.0 breaking changes for the details.
For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
1.1.0 Deprecation Notices
The same deprecation notices from the 1.0.1 release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!
1.1.0 Breaking Changes
The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:
- the renaming of the source code folder from
aries_cloudagent
toacapy_agent
, - the publication of the PyPi project under the new
acapy_agent
name, and - the use of the OWF organizational GitHub Container Registry (GHCR) and
acapy_agent
as the name for release container image artifacts.- The patterns for the image tags remain the same as before. So, for example, the new nightly artifact can be found here: [docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly](docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly).
Anyone deploying ACA-Py should use this release to update their existing deployments. Since there are no other changes to ACA-Py, any issues found should relate back to those changes.
- Deployments referencing the PyPi project (including those in custom plugins) MUST update their deployments to use the new name.
- Deployments sourcing the ACA-Py published container image artifacts to GHCR must update their deployments to use the new URLs.
Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the aries_cloudagent
source folder, the existing locations for the PyPi and GHCR container image artifacts.
What's Changed
- Update MDs and release publishing files to reflect the repo move to OWF by @swcurran in #3270
- General repo updates post OWF move. by @jamshale in #3267
- Fix interop test fork location replacement by @jamshale in #3280
- Update interop fork location after AATH update by @jamshale in #3282
- 1.1.0rc0 by @swcurran in #3284
- Change pypi upload workflow to use pypa/gh-action-pypi-publish by @jamshale in #3291
- 1.1.0rc1 by @swcurran in #3292
- 1.1.0 by @swcurran in #3294
Full Changelog: 1.0.1...1.1.0
1.1.0rc1
Release 1.1.0 is the first release of ACA-Py from the OpenWallet Foundation (OWF). The only reason for the release is to test out all of the release publishing actions now that we have moved the repo to its new home (https://github.com/openwallet-foundation/acapy). Almost all of the changes in the release are related to the move.
The move triggered some big changes for those with existing ACA-Py deployments resulting from the change in the GitHub organization (from Hyperledger to OWF) and source code name (from aries_cloudagent
to acapy_agent
). See the Release 1.1.0 breaking changes for the details.
For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
1.1.0rc0 Deprecation Notices
The same deprecation notices from the 1.0.1 release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!
1.1.0rc0 Breaking Changes
The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:
- the renaming of the source code folder from
aries_cloudagent
toacapy_agent
, - the publication of the PyPi project under the new
acapy_agent
name, and - the use of the OWF organizational GitHub Container Registry (GHCR) and
acapy_agent
as the name for release container image artifacts.- The patterns for the image tags remain the same as before. So, for example, the new nightly artifact can be found here: [docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly](docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly).
Anyone deploying ACA-Py should use this release to update their existing deployments. Since there are no other changes to ACA-Py, any issues found should relate back to those changes.
- Deployments referencing the PyPi project (including those in custom plugins) MUST update their deployments to use the new name.
- Deployments sourcing the ACA-Py published container image artifacts to GHCR must update their deployments to use the new URLs.
Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the aries_cloudagent
source folder, the existing locations for the PyPi and GHCR container image artifacts.
What's Changed
- Update MDs and release publishing files to reflect the repo move to OWF by @swcurran in #3270
- General repo updates post OWF move. by @jamshale in #3267
- Fix interop test fork location replacement by @jamshale in #3280
- Update interop fork location after AATH update by @jamshale in #3282
- 1.1.0rc0 by @swcurran in #3284
- Change pypi upload workflow to use pypa/gh-action-pypi-publish by @jamshale in #3291
- 1.1.0rc1 by @swcurran in #3292
Full Changelog: 1.0.1...1.1.0rc1
1.1.0rc0
Release 1.1.0 is the first release of ACA-Py from the OpenWallet Foundation (OWF). The only reason for the release is to test out all of the release publishing actions now that we have moved the repo to its new home (https://github.com/openwallet-foundation/acapy). Almost all of the changes in the release are related to the move.
The move triggered some big changes for those with existing ACA-Py deployments resulting from the change in the GitHub organization (from Hyperledger to OWF) and source code name (from aries_cloudagent
to acapy_agent
). See the Release 1.1.0 breaking changes for the details.
For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
1.1.0rc0 Deprecation Notices
The same deprecation notices from the 1.0.1 release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!
1.1.0rc0 Breaking Changes
The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:
- the renaming of the source code folder from
aries_cloudagent
toacapy_agent
, - the publication of the PyPi project under the new
acapy_agent
name, and - the use of the OWF organizational GitHub Container Registry (GHCR) and
acapy_agent
as the name for release container image artifacts.- The patterns for the image tags remain the same as before. So, for example, the new nightly artifact can be pulled by:
docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly
.
- The patterns for the image tags remain the same as before. So, for example, the new nightly artifact can be pulled by:
Anyone deploying ACA-Py should use this release to update their existing deployments. Since there are no other changes to ACA-Py, any issues found should relate back to those changes.
- Deployments referencing the PyPi project (including those in custom plugins) MUST update their deployments to use the new name.
- Deployments sourcing the ACA-Py published container image artifacts to GHCR must update their deployments to use the new URLs.
Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the aries_cloudagent
source folder, the existing locations for the PyPi and GHCR container image artifacts.
1.1.0rc0 Categorized List of Pull Requests
-
Updates related to the move and rename of the repository from the Hyperledger to OpenWallet Foundation GitHub organization
-
Release management pull requests:
-
Dependabot PRs
What's Changed
- Update MDs and release publishing files to reflect the repo move to OWF by @swcurran in #3270
- General repo updates post OWF move. by @jamshale in #3267
- Fix interop test fork location replacement by @jamshale in #3280
- Update interop fork location after AATH update by @jamshale in #3282
- 1.1.0rc0 by @swcurran in #3284
Full Changelog: 1.0.1...1.1.0rc0
1.0.1
Release 1.0.1 will be the last release of ACA-Py from the Hyperledger organization before the repository moves to the OpenWallet Foundation (OWF). Soon after this release, the ACA-Py project and this repository will move to the OWF's GitHub organization as the new "acapy" project.
For details on what this means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
The 1.0.1 release contains mostly internal clean ups, technical debt elimination, and a revision to the integration testing approach, incorporating the Aries Agent Test Harness tests in the ACA-Py continuous integration testing process. There are substantial enhancements in the management of keys and their use with VC-DI proofs, and web-based DID methods like did:web
. See the Wallet and Key Handling
updates in the categorized PR list below.
There are several important deprecation notices in this release in preparation for the next ACA-Py release. Please review these notifications carefully!
In an attempt to shorten the categorized list of PRs in the release, rather than listing all of the dependabot
PRs in the release, we've included a link to a list of those PRs.
Deprecation Notices
- ACA-Py will soon be moved from the Hyperledger GitHub organization to that of the OpenWallet Foundation. As such, there will be changes in the names and locations of the artifacts produced -- the PyPi project and the container images in the GitHub Container Registry. We will retain the ability to publish LTS releases of ACA-Py for the current LTS versions (0.11, 0.12) in the current locations. For details, guidance, timing, and progress on the move, please monitor the description of GitHub Issue #3250 that will be maintained throughout the process.
- In the next ACA-Py release, we will be dropping from the core ACA-Py repository the AIP 1.0 RFC 0160 Connections, [RFC 0037 Issue Credentials v1.0] and [RFC 0037 Present Proof v1.0] DIDComm protocols. Each of the protocols will be moved to the [ACA-Py Plugins] repo. All deployers that use those protocols SHOULD update to the AIP 2.0 versions of those protocols (RFC 0434 Out of Band+RFC 0023 DID Exchange, RFC 0453 Issue Credential v2.0 and RFC 0454 Present Proof v2.0, respectively). Once the protocols are removed from ACA-Py, anyone still using those protocols MUST adjust their configuration to load those protocols from the respective plugins.
1.0.1 Breaking Changes
There are no breaking changes in ACA-Py Release 1.0.1.
What's Changed
- 👷Publish
aries-cloudagent-bbs
Docker image by @rblaine95 in #3175 - chore(deps): Bump aiohttp from 3.10.3 to 3.10.4 by @dependabot in #3177
- chore(deps-dev): Bump ruff from 0.5.7 to 0.6.1 by @dependabot in #3180
- chore(deps): Bump markdown from 3.6 to 3.7 by @dependabot in #3176
- chore(deps): Bump mike from 2.1.2 to 2.1.3 by @dependabot in #3179
- chore(deps): Bump mkdocs-material from 9.5.31 to 9.5.32 by @dependabot in #3178
- fixes #3186: handler_timed_file_handler by @rngadam in #3187
- [ POST v1.0.0 ] Adjust message queue error handling by @jamshale in #3170
- issue #3182: replace deprecated ptvsd debugger by debugpy by @rngadam in #3183
- Fix logic to send verbose webhooks by @ianco in #3193
- chore(deps): Bump aiohttp from 3.10.4 to 3.10.5 by @dependabot in #3201
- chore(deps-dev): Bump ruff from 0.6.1 to 0.6.2 by @dependabot in #3198
- chore(deps-dev): Bump pytest-asyncio from 0.23.8 to 0.24.0 by @dependabot in #3200
- chore(deps): Bump mkdocs-material from 9.5.32 to 9.5.33 by @dependabot in #3199
- chore(deps): Bump marshmallow from 3.21.3 to 3.22.0 by @dependabot in #3197
- Change integration testing by @jamshale in #3194
- Change interop tests to critical on PRs by @jamshale in #3209
- Document the documentation site generation process by @swcurran in #3212
- Adjust nightly and release workflows by @jamshale in #3210
- chore(deps-dev): Bump ruff from 0.6.2 to 0.6.3 by @dependabot in #3214
- chore(deps): Bump mkdocs-material from 9.5.33 to 9.5.34 by @dependabot in #3215
- chore(deps): Bump cryptography from 43.0.0 to 43.0.1 in the pip group by @dependabot in #3216
- Only change interop testing fork on pull requests by @jamshale in #3218
- chore(deps-dev): Bump ruff from 0.6.3 to 0.6.4 by @dependabot in #3221
- chore(deps): Bump unflatten from 0.1.1 to 0.2.0 by @dependabot in #3222
- fix: anoncreds revocation notification when revoking by @thiagoromanos in #3226
- Fix scenario tests by @jamshale in #3231
- chore(deps-dev): Bump ruff from 0.6.4 to 0.6.5 by @dependabot in #3236
- chore(deps-dev): Bump pytest from 8.3.2 to 8.3.3 by @dependabot in #3235
- Only run integration tests on correct file changes by @jamshale in #3230
- Update docs for outstanding anoncreds work by @jamshale in #3229
- Add anoncreds profile basic scenario test by @jamshale in #3232
- 🎨 fix type hints for optional method parameters by @ff137 in #3234
- Removing padding from url invitations by @jamshale in #3238
- Ensure that DAP_PORT is always an int by @Gavinok in #3241
- chore: delete unused keypair storage manager by @dbluhm in #3245
- feat: verify creds signed with Ed25519VerificationKey2020 by @dbluhm in #3244
- chore(deps-dev): Bump ruff from 0.6.5 to 0.6.7 by @dependabot in #3248
- chore(deps): Bump mkdocs-material from 9.5.34 to 9.5.36 by @dependabot in #3249
- Feature multikey management by @PatStLouis in #3246
- 1.0.1rc0 by @swcurran in #3254
- [BUG] Handle get key operation when no tag has been set by @PatStLouis in #3256
- Adjust sonarcloud and integration test workflows by @jamshale in #3259
- fix: enable refreshing did endpoint using mediator info by @dbluhm in #3260
- chore(deps-dev): Bump ruff from 0.6.7 to 0.6.8 by @dependabot in #3266
- chore(deps): Bump mkdocs-material from 9.5.36 to 9.5.39 by @dependabot in https://github.com/hy...
1.0.1rc1
Release 1.0.1 might be the last release of ACA-Py from the Hyperledger organization before the repository moves to the OpenWallet Foundation (OWF). As noted in the repository README.md, the ACA-Py project will soon be moving soon to the OWF's GitHub organization as the new "acapy" project.
For details on what this means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
The release contains mostly internal clean ups, technical debt elimination, and a revision to the integration testing approach, incorporating the Aries Agent Test Harness tests in the ACA-Py continuous integration testing process. There are substantial enhancements in the management of keys and their use with VC-DI proofs, and web-based DID methods like did:web
. See the Wallet and Key Handling
updates in the categorized PR list below.
There are several important deprecation notices in this release in preparation for the next ACA-Py release. Please review these notifications carefully!
In an attempt to shorten the categorized list of PRs in the release, rather than listing all of the dependabot
PRs in the release, we've included a link to a list of those PRs.
Deprecation Notices
- ACA-Py will soon be moved from the Hyperledger GitHub organization to that of the OpenWallet Foundation. As such, there will be changes in the names and locations of the artifacts produced -- the PyPi project and the container images in the GitHub Container Registry. We will retain the ability to publish LTS releases of ACA-Py for the current LTS versions (0.11, 0.12) in the current locations. For details, guidance, timing, and progress on the move, please monitor the description of GitHub Issue #3250 that will be maintained throughout the process.
- In the next ACA-Py release, we will be dropping from the core ACA-Py repository the AIP 1.0 RFC 0160 Connections, [RFC 0037 Issue Credentials v1.0] and [RFC 0037 Present Proof v1.0] DIDComm protocols. Each of the protocols will be moved to the [ACA-Py Plugins] repo. All deployers that use those protocols SHOULD update to the AIP 2.0 versions of those protocols (RFC 0434 Out of Band+RFC 0023 DID Exchange, RFC 0453 Issue Credential v2.0 and RFC 0454 Present Proof v2.0, respectively). Once the protocols are removed from ACA-Py, anyone still using those protocols must adjust their configuration to load those protocols from the respective plugins.
1.0.1rc1 Breaking Changes
There are no breaking changes in ACA-Py Release 1.0.1.
What's Changed
- 👷Publish
aries-cloudagent-bbs
Docker image by @rblaine95 in #3175 - chore(deps): Bump aiohttp from 3.10.3 to 3.10.4 by @dependabot in #3177
- chore(deps-dev): Bump ruff from 0.5.7 to 0.6.1 by @dependabot in #3180
- chore(deps): Bump markdown from 3.6 to 3.7 by @dependabot in #3176
- chore(deps): Bump mike from 2.1.2 to 2.1.3 by @dependabot in #3179
- chore(deps): Bump mkdocs-material from 9.5.31 to 9.5.32 by @dependabot in #3178
- fixes #3186: handler_timed_file_handler by @rngadam in #3187
- [ POST v1.0.0 ] Adjust message queue error handling by @jamshale in #3170
- issue #3182: replace deprecated ptvsd debugger by debugpy by @rngadam in #3183
- Fix logic to send verbose webhooks by @ianco in #3193
- chore(deps): Bump aiohttp from 3.10.4 to 3.10.5 by @dependabot in #3201
- chore(deps-dev): Bump ruff from 0.6.1 to 0.6.2 by @dependabot in #3198
- chore(deps-dev): Bump pytest-asyncio from 0.23.8 to 0.24.0 by @dependabot in #3200
- chore(deps): Bump mkdocs-material from 9.5.32 to 9.5.33 by @dependabot in #3199
- chore(deps): Bump marshmallow from 3.21.3 to 3.22.0 by @dependabot in #3197
- Change integration testing by @jamshale in #3194
- Change interop tests to critical on PRs by @jamshale in #3209
- Document the documentation site generation process by @swcurran in #3212
- Adjust nightly and release workflows by @jamshale in #3210
- chore(deps-dev): Bump ruff from 0.6.2 to 0.6.3 by @dependabot in #3214
- chore(deps): Bump mkdocs-material from 9.5.33 to 9.5.34 by @dependabot in #3215
- chore(deps): Bump cryptography from 43.0.0 to 43.0.1 in the pip group by @dependabot in #3216
- Only change interop testing fork on pull requests by @jamshale in #3218
- chore(deps-dev): Bump ruff from 0.6.3 to 0.6.4 by @dependabot in #3221
- chore(deps): Bump unflatten from 0.1.1 to 0.2.0 by @dependabot in #3222
- fix: anoncreds revocation notification when revoking by @thiagoromanos in #3226
- Fix scenario tests by @jamshale in #3231
- chore(deps-dev): Bump ruff from 0.6.4 to 0.6.5 by @dependabot in #3236
- chore(deps-dev): Bump pytest from 8.3.2 to 8.3.3 by @dependabot in #3235
- Only run integration tests on correct file changes by @jamshale in #3230
- Update docs for outstanding anoncreds work by @jamshale in #3229
- Add anoncreds profile basic scenario test by @jamshale in #3232
- 🎨 fix type hints for optional method parameters by @ff137 in #3234
- Removing padding from url invitations by @jamshale in #3238
- Ensure that DAP_PORT is always an int by @Gavinok in #3241
- chore: delete unused keypair storage manager by @dbluhm in #3245
- feat: verify creds signed with Ed25519VerificationKey2020 by @dbluhm in #3244
- chore(deps-dev): Bump ruff from 0.6.5 to 0.6.7 by @dependabot in #3248
- chore(deps): Bump mkdocs-material from 9.5.34 to 9.5.36 by @dependabot in #3249
- Feature multikey management by @PatStLouis in #3246
- 1.0.1rc0 by @swcurran in #3254
- [BUG] Handle get key operation when no tag has been set by @PatStLouis in #3256
- Adjust sonarcloud and integration test workflows by @jamshale in #3259
- fix: enable refreshing did endpoint using mediator info by @dbluhm in #3260
- chore(deps-dev): Bump ruff from 0.6.7 to 0.6.8 by @dependabot in #3266
- chore(deps): Bump mkdocs-material from 9.5.36 to 9.5.39 by @dependabot in https://github.com/hype...
1.0.1rc0
Release 1.0.1 might be the last release of ACA-Py from the Hyperledger organization before the repository moves to the OpenWallet Foundation (OWF). As noted in the repository README.md, the ACA-Py project will soon be
moving soon to the OWF's GitHub organization as the new "acapy" project.
For details on what this means for ACA-Py users, including steps for updating deployments, please follow the updates in GitHub Issue #3250. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
The release contains mostly internal clean ups, technical debt elimination, and a revision to the integration testing approach, incorporating the Aries Agent Test Harness tests in the ACA-Py continuous integration testing process.
There are several important deprecation notices in this release in preparation for the next ACA-Py release. Please review these notifications carefully!
In an attempt to shorten the categorized list of PRs in the release, rather than listing all of the dependabot
PRs in the release, we've included a link to a list of those PRs.
Deprecation Notices
- ACA-Py will soon be moved from the Hyperledger GitHub organization to that of the OpenWallet Foundation. As such, there will be changes in the names and locations of the artifacts produced -- the PyPi project and the container images in the GitHub Container Registry. We will retain the ability to publish LTS releases of ACA-Py for the current LTS versions (0.11, 0.12) in the current locations. For details, guidance, timing, and progress on the move, please monitor the description of GitHub Issue #3250 that will be maintained throughout the process.
- In the next ACA-Py release, we will be dropping from the core ACA-Py repository the AIP 1.0 RFC 0160 Connections, [RFC 0037 Issue Credentials v1.0] and [RFC 0037 Present Proof v1.0] DIDComm protocols. Each of the protocols will be moved to the [ACA-Py Plugins] repo. All deployers that use those protocols SHOULD update to the AIP 2.0 versions of those protocols (RFC 0434 Out of Band+RFC 0023 DID Exchange, RFC 0453 Issue Credential v2.0 and RFC 0454 Present Proof v2.0, respectively). Once the protocols are removed from ACA-Py, anyone still using those protocols must adjust their configuration to load those protocols from the respective plugins.
1.0.1rc0 Breaking Changes
There are no breaking changes in ACA-Py Release 1.0.1.
What's Changed
- 👷Publish
aries-cloudagent-bbs
Docker image by @rblaine95 in #3175 - chore(deps): Bump aiohttp from 3.10.3 to 3.10.4 by @dependabot in #3177
- chore(deps-dev): Bump ruff from 0.5.7 to 0.6.1 by @dependabot in #3180
- chore(deps): Bump markdown from 3.6 to 3.7 by @dependabot in #3176
- chore(deps): Bump mike from 2.1.2 to 2.1.3 by @dependabot in #3179
- chore(deps): Bump mkdocs-material from 9.5.31 to 9.5.32 by @dependabot in #3178
- fixes #3186: handler_timed_file_handler by @rngadam in #3187
- [ POST v1.0.0 ] Adjust message queue error handling by @jamshale in #3170
- issue #3182: replace deprecated ptvsd debugger by debugpy by @rngadam in #3183
- Fix logic to send verbose webhooks by @ianco in #3193
- chore(deps): Bump aiohttp from 3.10.4 to 3.10.5 by @dependabot in #3201
- chore(deps-dev): Bump ruff from 0.6.1 to 0.6.2 by @dependabot in #3198
- chore(deps-dev): Bump pytest-asyncio from 0.23.8 to 0.24.0 by @dependabot in #3200
- chore(deps): Bump mkdocs-material from 9.5.32 to 9.5.33 by @dependabot in #3199
- chore(deps): Bump marshmallow from 3.21.3 to 3.22.0 by @dependabot in #3197
- Change integration testing by @jamshale in #3194
- Change interop tests to critical on PRs by @jamshale in #3209
- Document the documentation site generation process by @swcurran in #3212
- Adjust nightly and release workflows by @jamshale in #3210
- chore(deps-dev): Bump ruff from 0.6.2 to 0.6.3 by @dependabot in #3214
- chore(deps): Bump mkdocs-material from 9.5.33 to 9.5.34 by @dependabot in #3215
- chore(deps): Bump cryptography from 43.0.0 to 43.0.1 in the pip group by @dependabot in #3216
- Only change interop testing fork on pull requests by @jamshale in #3218
- chore(deps-dev): Bump ruff from 0.6.3 to 0.6.4 by @dependabot in #3221
- chore(deps): Bump unflatten from 0.1.1 to 0.2.0 by @dependabot in #3222
- fix: anoncreds revocation notification when revoking by @thiagoromanos in #3226
- Fix scenario tests by @jamshale in #3231
- chore(deps-dev): Bump ruff from 0.6.4 to 0.6.5 by @dependabot in #3236
- chore(deps-dev): Bump pytest from 8.3.2 to 8.3.3 by @dependabot in #3235
- Only run integration tests on correct file changes by @jamshale in #3230
- Update docs for outstanding anoncreds work by @jamshale in #3229
- Add anoncreds profile basic scenario test by @jamshale in #3232
- 🎨 fix type hints for optional method parameters by @ff137 in #3234
- Removing padding from url invitations by @jamshale in #3238
- Ensure that DAP_PORT is always an int by @Gavinok in #3241
- chore: delete unused keypair storage manager by @dbluhm in #3245
- feat: verify creds signed with Ed25519VerificationKey2020 by @dbluhm in #3244
- chore(deps-dev): Bump ruff from 0.6.5 to 0.6.7 by @dependabot in #3248
- chore(deps): Bump mkdocs-material from 9.5.34 to 9.5.36 by @dependabot in #3249
- Feature multikey management by @PatStLouis in #3246
- 1.0.1rc0 by @swcurran in #3254
New Contributors
- @thiagoromanos made their first contribution in #3226
Full Changelog: 1.0.0...1.0.1rc0
1.0.0
Release 1.0.0 is finally here! While Aries Cloud Agent Python has been used in production for several years, the maintainers have decided it is finally time to put a "1.0" tag on the project. The 1.0.0 release itself includes well over 100 PRs merged since Release 0.12.1. 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 and a new Long Term Support (LTS) policy, the majority of the focus has been on eliminating technical debt and improving the underlying implementation. Here are the highlights of the release:
- A formal ACA-Py Long Term Support (LTS) policy has been documented and is being followed.
- 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.
- A new ACA-Py Plugins Store at https://plugins.aca-py.org. Check out the plugins that have been published by ACA-Py contributors, and learn how to add your own plugins!
- We've improved the developer experience by enabling support in ACA-Py artifacts for the ARM Architecture (and notably, Mac M1 and later systems). To do so, we have removed default support for BBS Signatures. BBS Signatures are still supported in the codebase, and guidance is provided for how to enable the support in artifacts (Docker images, etc.) for those needing it. We look forward to updating the BBS support in ACA-Py based on libraries that include multi-architecture support.
- 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.
- 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.
- The start of a DIDComm v2 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 for guidance.
- Support added for using AnonCreds in W3C VCDM format.
1.0.0 Breaking Changes
With the focus of the pull requests for this release on stabilizing the implementation, there were just a few breaking changes:
- The default underlying Python version has been upgraded to 3.12.
- ACA-Py has supported BBS Signatures for some time. However, the dependency that is used (
bbs
) does not support the ARM architecture, and its inclusion in the default ACA-Py artifacts mean that developers using ARM-based hardware (such as Apple M1 Macs or later) cannot run ACA-Py "out-of-the-box". We feel that providing a better developer experience by supporting the ARM architecture is more important than BBS Signature support at this time. As such, we have removed the BBS dependency from the base ACA-Py artifacts and made it an add-on that those using ACA-Py with BBS must take extra steps to build into their own artifacts, as documented here. - Support for the Indy SDK has been dropped. It had been previously deprecated. See this Indy SDK to Askar migration documentation for guidance. Hyperledger Indy is still fully supported - it's just the Indy SDK client-side library that has been removed.
- 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 for additional details.
- A fix to an obscure bug includes a change to the data sent to the controller after publishing multiple, endorsed credential definition revocation registries in a single call. The bug fix was to properly process the publishing. The breaking change is that when the process (now successfully) completes, the controller is sent the list of published credential definitions. Previously only a single value was being sent. See PR #3107 for additional details.
- The configuration settings around whether a multitenant wallet uses a single database vs. a database per tenant has been made more explicit. The previous settings were not clear, resulting in some deployments that were intended to be a database per tenant actually result in all tenants being in the same database. For details about the change, see #3105.
What's Changed
- Update README.md by @KPCOFGS in #2927
- chore(deps): Bump ecdsa from 0.16.1 to 0.19.0 in the pip group across 1 directory by @dependabot in #2933
- feat: Integrate AnonCreds with W3C VCDI Format Support in ACA-Py by @sarthakvijayvergiya in #2861
- Upgrade to anoncreds via api endpoint by @jamshale in #2922
- Feature: use decorators for admin api authentication by @esune in #2860
- Anoncreds - Send full registry list when getting revocation states by @jamshale in #2946
- Example integration test issuing 2 credentials under the same schema by @ianco in #2948
- Fix Snyk Container scanning workflow by @WadeBarnes in #2951
- ⬆️ Upgrade pydid (pydantic v2) by @ff137 in #2919
- Switch Snyk Container scan back to on push. by @WadeBarnes in #2953
- Add OpenSSF Scorecard GHA - weekly by @swcurran in #2955
- ⬆️ Upgrade test and lint dependencies by @ff137 in #2939
- BREAKING feat: drop indy sdk by @dbluhm in #2892
- fix(interop): overly strict validation by @dbluhm in #2943
- Fix clear revocation logic by @jamshale in #2956
- Fix Snyk sarif file by @pradeepp88 in #2961
- Add anoncreds migration guide by @jamshale in #2881
- chore: updating dependabot to support gha, python, docker and dev container packages by @rajpalc7 in #2945
- Fix issue with requested to revoke before registry creation by @jamshale in #2995
- Sonarcloud with code coverage by @jamshale in #2968
- Manage integration tests with GitHub Actions (#2952) by @jamshale in #2996
- ⬆️ Upgrade
aiohttp-apispec
andapispec
by @ff137 in #2920 - chore(deps): Bump untergeek/curator from 8.0.2 to 8.0.15 in /demo/elk-stack/extensions/curator by @dependabot in #2969
- feat: inject profile and session by @dbluhm in #2997
- ✨ Faster uuid generation by @ff137 in #2994
- chore(deps): Bump sphinx-rtd-theme from 1.1.1 to 1.3.0 in /docs by @dependabot in #2970
- chore(deps): Bump hyperledger/aries-cloudagent-python from py3.9-0.9.0 to py3.9-0.12.1 in /demo/docker-agent by @dependabot in #2973
- chore(deps): Bump hyperledger/aries-cloudagent-python from py3.9-0.10.4 to py3.9-0.12.1 in /demo/playground by @dependabot in https://github.com/hyperledger/aries-cloudag...