Merge pull request openwallet-foundation#2414 from swcurran/0.10.0-rc0

0.10.0-rc0

CHANGELOG.md

@@ -1,3 +1,75 @@
+# 0.10.1-rc0
+
+## August 11, 2023
+
+Release 0.10.1 contains a breaking change, an important fix for a regression
+introduced in 0.8.2 that impacts certain deployments, and a number of fixes and
+updates.
+
+The regression fix is for ACA-Py deployments that use multi-use invitations but
+do **NOT** use the `--auto-accept-connection-requests` flag/processing. A change
+in [0.8.2](#082) (PR [\#2223]) suppressed an extra webhook event firing during
+the processing after receiving a connection request. An unexpected side effect
+of that change was that the subsequent webhook event also did not fire, and as a
+result, the controller did not get any event signalling a new connection request
+had been received via the multi-use invitation. The update in this release
+ensures the proper event fires and the controller receives the webhook.
+
+[\#2413]: https://github.com/hyperledger/aries-cloudagent-python/pull/2413
+[\#2223]: https://github.com/hyperledger/aries-cloudagent-python/pull/2223
+
+See below for the breaking changes and a categorized list of the pull requests
+included in this release.
+
+## 0.10.1 Breaking Changes
+
+[\#2352] is a breaking change related to the storage of presentation exchange
+records in ACA-Py. In previous releases, presentation exchange protocol state
+data records were retained in ACA-Py secure storage after the completion of
+protocol instances. With this release the default behavior changes to **deleting
+those records by default**, unless the `----preserve-exchange-records` flag is
+set in the configuration. This extends the use of that flag that previously
+applied only to issue credential records. The extension matches the initial
+intention of the flag--that it cover both issue credential and present proof
+exchanges. The "best practices" for ACA-Py is that the controller (business
+logic) store any long-lasting business information needed for the service that
+is using the Aries Agent, and ACA-Py storage should be used only for data
+necessary for the operation of the agent. In particular, protocol state data
+should be held in ACA-Py only as long as the protocol is running (as it is
+needed by ACA-Py), and once a protocol instance completes, the controller should
+extract and store the business information from the protocol state before it is
+deleted from ACA-Py storage.
+
+[\#2352]: https://github.com/hyperledger/aries-cloudagent-python/pull/2352
+
+### 0.10.1 Categorized List of Pull Requests
+
+- DIDComm Messaging Improvements/Fixes
+  - fix: outbound send status missing on path [\#2393](https://github.com/hyperledger/aries-cloudagent-python/pull/2393) [dbluhm](https://github.com/dbluhm)
+  - fix: keylist update response race condition [\#2391](https://github.com/hyperledger/aries-cloudagent-python/pull/2391) [dbluhm](https://github.com/dbluhm)
+- DID Handling and Connection Establishment Updates/Fixes
+  - Fix: Ensure event/webhook is emitted for multi-use invitations [\#2413](https://github.com/hyperledger/aries-cloudagent-python/pull/2413) [esune](https://github.com/esune)
+  - feat: add DID Exchange specific problem reports and reject endpoint [\#2394](https://github.com/hyperledger/aries-cloudagent-python/pull/2394) [dbluhm](https://github.com/dbluhm)
+  - fix: additional tweaks for did:web and other methods as public DIDs [\#2392](https://github.com/hyperledger/aries-cloudagent-python/pull/2392) [dbluhm](https://github.com/dbluhm)
+  - Fix empty ServiceDecorator in OobRecord causing 422 Unprocessable Entity Error [\#2362](https://github.com/hyperledger/aries-cloudagent-python/pull/2362) [ff137](https://github.com/ff137)
+  - Feat: Added support for Ed25519Signature2020 signature type and Ed25519VerificationKey2020 [\#2241](https://github.com/hyperledger/aries-cloudagent-python/pull/2241) [dkulic](https://github.com/dkulic)
+- Credential Exchange (Issue, Present) Updates
+  - BREAKING Extend --preserve-exchange-records to include Presentation Exchange. [\#2352](https://github.com/hyperledger/aries-cloudagent-python/pull/2352) [usingtechnology](https://github.com/usingtechnology)
+  - Correct the response type in send_rev_reg_def [\#2355](https://github.com/hyperledger/aries-cloudagent-python/pull/2355) [ff137](https://github.com/ff137)
+- Multitenancy Updates and Fixes
+  - Multitenant check endorser_info before saving [\#2395](https://github.com/hyperledger/aries-cloudagent-python/pull/2395) [usingtechnology](https://github.com/usingtechnology)
+  - Feat: Support Selectable Write Ledger [\#2339](https://github.com/hyperledger/aries-cloudagent-python/pull/2339) [shaangill025](https://github.com/shaangill025)
+- Other Fixes, Demo, and Documentation Fixes
+  - Redis Plugins [redis_cache & redis_queue] documentation and docker related updates [\#1937](https://github.com/hyperledger/aries-cloudagent-python/pull/1937) [shaangill025](https://github.com/shaangill025)
+  - Chore: fix marshmallow warnings [\#2398](https://github.com/hyperledger/aries-cloudagent-python/pull/2398) [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)
+  - Corrected typo on mediator invitation configuration argument [\#2365](https://github.com/hyperledger/aries-cloudagent-python/pull/2365) [jorgefl0](https://github.com/jorgefl0)
+  - Add workaround for ARM based macs [\#2313](https://github.com/hyperledger/aries-cloudagent-python/pull/2313) [finnformica](https://github.com/finnformica)
+- Dependencies and Internal Updates
+  - chore(deps): Bump certifi from 2023.5.7 to 2023.7.22 in /demo/playground/scripts dependencies [\#2354](https://github.com/hyperledger/aries-cloudagent-python/pull/2354) [dependabot bot](https://github.com/dependabot bot)
+- Release management pull requests
+  - 0.10.0-rc0 [\#2414](https://github.com/hyperledger/aries-cloudagent-python/pull/2414) [swcurran](https://github.com/swcurran)
+
 # 0.9.0
 
 ## July 24, 2023

aries_cloudagent/version.py

@@ -1,4 +1,4 @@
 """Library version information."""
 
-__version__ = "0.9.0"
+__version__ = "0.10.0-rc0"
 RECORD_TYPE_ACAPY_VERSION = "acapy_version"

docs/README.md

@@ -22,13 +22,27 @@ To test generate and view the RTD documentation locally, you must install [Sphin
 [Sphinx RTD theme](https://pypi.org/project/sphinx-rtd-theme/). Follow the instructions on the respective pages to install
 and verify the installation on your system.
 
+**NOTE** In the latest release, the version of Sphinx installed on my Linux
+system failed to run because of a dependency change (import error from
+`jinja2`), and an update to Sphinx has (so far) not worked. As a result, I am
+now using the Sphinx docker image to do the `sphinx-apidoc` step. I've not yet
+been able to get the build step working with docker, but will update the notes
+when I've done that.
+
 ### Generate Module Files
 
 To rebuild the project and settings from scratch (you'll need to move the generated index file up a level):
 
+See the **NOTE** above for the need for the use of docker in these steps.
+
 ``` bash
+alias sphinx-apidoc='docker run -it --rm -v ${PWD}:/docs sphinxdoc/sphinx sphinx-apidoc'
+cp -r ../aries_cloudagent .
 rm -rf generated
-sphinx-apidoc -f -M -o  ./generated ../aries_cloudagent/ $(find ../aries_cloudagent/ -name '*tests*')
+# sphinx-apidoc -f -M -o  ./generated ../aries_cloudagent/ $(find ../aries_cloudagent/ -name '*tests*')
+sphinx-apidoc -f -M -o  ./generated ./aries_cloudagent/ $(find ./aries_cloudagent/ -name '*tests*')
+rm -rf ./aries_cloudagent
+unalias sphinx-apidoc
 ```
 
 Note that the `find` command that is used to exclude any of the `test` python files from the RTD documentation.

docs/generated/aries_cloudagent.protocols.didexchange.v1_0.handlers.rst

@@ -25,6 +25,14 @@ aries\_cloudagent.protocols.didexchange.v1\_0.handlers.invitation\_handler modul
    :undoc-members:
    :show-inheritance:
 
+aries\_cloudagent.protocols.didexchange.v1\_0.handlers.problem\_report\_handler module
+--------------------------------------------------------------------------------------
+
+.. automodule:: aries_cloudagent.protocols.didexchange.v1_0.handlers.problem_report_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 aries\_cloudagent.protocols.didexchange.v1\_0.handlers.request\_handler module
 ------------------------------------------------------------------------------
 

docs/generated/aries_cloudagent.protocols.didexchange.v1_0.messages.rst

@@ -17,10 +17,10 @@ aries\_cloudagent.protocols.didexchange.v1\_0.messages.complete module
    :undoc-members:
    :show-inheritance:
 
-aries\_cloudagent.protocols.didexchange.v1\_0.messages.problem\_report\_reason module
--------------------------------------------------------------------------------------
+aries\_cloudagent.protocols.didexchange.v1\_0.messages.problem\_report module
+-----------------------------------------------------------------------------
 
-.. automodule:: aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report_reason
+.. automodule:: aries_cloudagent.protocols.didexchange.v1_0.messages.problem_report
    :members:
    :undoc-members:
    :show-inheritance:

docs/generated/aries_cloudagent.utils.rst

@@ -49,6 +49,14 @@ aries\_cloudagent.utils.jwe module
    :undoc-members:
    :show-inheritance:
 
+aries\_cloudagent.utils.multi\_ledger module
+--------------------------------------------
+
+.. automodule:: aries_cloudagent.utils.multi_ledger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 aries\_cloudagent.utils.outofband module
 ----------------------------------------
 

open-api/openapi.json

@@ -2,7 +2,7 @@
   "openapi" : "3.0.1",
   "info" : {
     "title" : "Aries Cloud Agent",
-    "version" : "v0.9.0"
+    "version" : "v0.10.0-rc0"
   },
   "servers" : [ {
     "url" : "/"

open-api/swagger.json

@@ -1,7 +1,7 @@
 {
   "swagger" : "2.0",
   "info" : {
-    "version" : "v0.9.0",
+    "version" : "v0.10.0-rc0",
     "title" : "Aries Cloud Agent"
   },
   "tags" : [ {