Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit bc00b55

Browse files
authored
Merge pull request #124 from swcurran/0.11.2
0.11.2
2 parents 1b24fdb + 5d1e92e commit bc00b55

19 files changed

+84
-67
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In addition to this documentation site, the ACA-Py community also maintains an
1818
ACA-Py internals documentation site. The internals documentation consists of the
1919
`docstrings` extracted from the ACA-Py Python code and covers all of the
2020
(non-test) modules in the codebase. Check it out on the [Aries Cloud
21-
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/0.11.1).
21+
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/0.11.2).
2222
As with this site, the ReadTheDocs documentation is version specific.
2323

2424
Got questions?

docs/contributing/PUBLISHING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Once ready to do a release, create a local branch that includes the following up
2222
- Use a command like the following, adjusting the tag parameters as
2323
appropriate. `docker run -it --rm -v "$(pwd)":/usr/local/src/your-app
2424
githubchangeloggenerator/github-changelog-generator --user hyperledger
25-
--project aries-cloudagent-python --output 0.11.1.md --since-tag 0.11.0
26-
--future-release 0.11.1rc2 --release-branch main --token <your-token>`
25+
--project aries-cloudagent-python --output 0.11.2.md --since-tag 0.11.0
26+
--future-release 0.11.2 --release-branch main --token <your-token>`
2727
- In the generated file, use only the PR list -- we don't include the list of
2828
closed issues in the Change Log.
2929

@@ -101,8 +101,8 @@ Once you have the list of PRs:
101101

102102
5. Update the version number listed in
103103
[pyproject.toml](pyproject.toml) and, prefixed with
104-
a "v" in [open-api/openapi.json](https://github.com/hyperledger/open-api/tree/0.11.1/openapi.json) and
105-
[open-api/swagger.json](https://github.com/hyperledger/open-api/tree/0.11.1/swagger.json) (e.g. "0.7.2" in the
104+
a "v" in [open-api/openapi.json](https://github.com/hyperledger/open-api/tree/0.11.2/openapi.json) and
105+
[open-api/swagger.json](https://github.com/hyperledger/open-api/tree/0.11.2/swagger.json) (e.g. "0.7.2" in the
106106
version.py file and "v0.7.2" in the openapi.json file). The incremented
107107
version number should adhere to the [Semantic Versioning
108108
Specification](https://semver.org/#semantic-versioning-specification-semver)
@@ -144,9 +144,9 @@ Once you have the list of PRs:
144144
Additional information about the container image publication process can be
145145
found in the document [Container Images and Github Actions]().
146146

147-
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/.github/workflows/publish.yml
148-
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/.github/workflows/publish-indy.yml
149-
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/ContainerImagesAndGithubActions.md
147+
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/.github/workflows/publish.yml
148+
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/.github/workflows/publish-indy.yml
149+
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/ContainerImagesAndGithubActions.md
150150

151151
11. Update the ACA-Py Read The Docs site by building the new "latest" (main
152152
branch) and activating and building the new release. Appropriate permissions

docs/demo/Endorser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This approach runs Faber as an un-privileged agent, and starts a dedicated Endor
88

99
Start a VON Network instance and a Tails server:
1010

11-
- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.1/docs/UsingVONNetwork.md#building-and-starting) section of the VON Network Tutorial to get ledger started. You can leave off the `--logs` option if you want to use the same terminal for running both VON Network and the Tails server. When you are finished with VON Network, follow the [Stopping And Removing a VON Network](https://github.com/bcgov/von-network/blob/main/docs/UsingVONNetwork.md#stopping-and-removing-a-von-network) instructions.
11+
- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.2/docs/UsingVONNetwork.md#building-and-starting) section of the VON Network Tutorial to get ledger started. You can leave off the `--logs` option if you want to use the same terminal for running both VON Network and the Tails server. When you are finished with VON Network, follow the [Stopping And Removing a VON Network](https://github.com/bcgov/von-network/blob/main/docs/UsingVONNetwork.md#stopping-and-removing-a-von-network) instructions.
1212
- Run an AnonCreds revocation registry tails server in order to support revocation by following the instructions in the [Alice gets a Phone](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/AliceGetsAPhone.md#run-an-instance-of-indy-tails-server) demo.
1313

1414
Start up Faber as Author (note the tails file size override, to allow testing of the revocation registry roll-over):

docs/demo/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ Jump to the [Follow the Script](#follow-the-script) section below for further in
5959

6060
### Running in Docker
6161

62-
Running the demo in docker requires having a `von-network` (a Hyperledger Indy public ledger sandbox) instance running in docker locally. See the [VON Network Tutorial](https://github.com/bcgov/von-network/blob/0.11.1/docs/UsingVONNetwork.md) for guidance
62+
Running the demo in docker requires having a `von-network` (a Hyperledger Indy public ledger sandbox) instance running in docker locally. See the [VON Network Tutorial](https://github.com/bcgov/von-network/blob/0.11.2/docs/UsingVONNetwork.md) for guidance
6363
on starting and stopping your own local Hyperledger Indy instance.
6464

6565
Open three `bash` shells. For Windows users, `git-bash` is highly recommended. bash is the default shell in Linux and Mac terminal sessions.
6666

67-
In the first terminal window, start `von-network` by following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.1/docs/UsingVONNetwork.md#building-and-starting) instructions.
67+
In the first terminal window, start `von-network` by following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.2/docs/UsingVONNetwork.md#building-and-starting) instructions.
6868

6969
In the second terminal, change directory into `demo` directory of your clone of the Aries Cloud Agent Python repository. Start the `faber` agent by issuing the following command:
7070

@@ -98,7 +98,7 @@ While that process will include the installation of the Indy python prerequisite
9898

9999
#### Start a local Indy ledger
100100

101-
Start a local `von-network` Hyperledger Indy network running in Docker by following the VON Network [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.1/docs/UsingVONNetwork.md#building-and-starting) instructions.
101+
Start a local `von-network` Hyperledger Indy network running in Docker by following the VON Network [Building and Starting](https://github.com/bcgov/von-network/blob/0.11.2/docs/UsingVONNetwork.md#building-and-starting) instructions.
102102

103103
We strongly recommend you use Docker for the local Indy network until you really, really need to know the details of running an Indy Node instance on a bare machine.
104104

@@ -376,9 +376,9 @@ You can inspect the additional multi-tenancy admin API's (i.e. the "agency API"
376376
Note that with multi-tenancy enabled:
377377

378378
- The "base" wallet will have access to this new "agency API" - the agent's admin key, if enabled, must be provided in a header
379-
- "Base wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/support/agent.py#L606)
380-
- The "sub-wallets" will have access to the "normal" ACA-Py admin API - to identify the sub-wallet, a JWT token must be provided, this token is created upon creation of the new wallet (see: [this code here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/support/agent.py#L378))
381-
- "Sub-wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/support/agent.py#L632)
379+
- "Base wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/support/agent.py#L606)
380+
- The "sub-wallets" will have access to the "normal" ACA-Py admin API - to identify the sub-wallet, a JWT token must be provided, this token is created upon creation of the new wallet (see: [this code here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/support/agent.py#L378))
381+
- "Sub-wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/support/agent.py#L632)
382382

383383
Documentation on ACA-Py's multi-tenancy support can be found [here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/Multitenancy.md).
384384

@@ -400,15 +400,15 @@ This works exactly as the *vanilla* multi-tenancy, except that all connections a
400400

401401
These Alice and Faber scripts (in the `demo/runners` folder) implement the controller and run the agent as a sub-process (see the documentation for `aca-py`). The controller publishes a REST service to receive web hook callbacks from their agent. Note that this architecture, running the agent as a sub-process, is a variation on the documented architecture of running the controller and agent as separate processes/containers.
402402

403-
The controllers for this demo can be found in the [alice.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/alice.py) and [faber.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/faber.py) files. Alice and Faber are instances of the agent class found in [agent.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/support/agent.py).
403+
The controllers for this demo can be found in the [alice.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/alice.py) and [faber.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/faber.py) files. Alice and Faber are instances of the agent class found in [agent.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/support/agent.py).
404404

405405
## OpenAPI (Swagger) Demo
406406

407407
Developing an ACA-Py controller is much like developing a web app that uses a REST API. As you develop, you will want an easy way to test out the behaviour of the API. That's where the industry-standard OpenAPI (aka Swagger) UI comes in. ACA-Py (optionally) exposes an OpenAPI UI in ACA-Py that you can use to learn the ins and outs of the API. This [Aries OpenAPI demo](AriesOpenAPIDemo.md) shows how you can use the OpenAPI UI with an ACA-Py agent by walking through the connectiing, issuing a credential, and presenting a proof sequence.
408408

409409
## Performance Demo
410410

411-
Another example in the `demo/runners` folder is [performance.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/performance.py), that is used to test out the performance of interacting agents. The script starts up agents for Alice and Faber, initializes them, and then runs through an interaction some number of times. In this case, Faber issues a credential to Alice 300 times.
411+
Another example in the `demo/runners` folder is [performance.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/performance.py), that is used to test out the performance of interacting agents. The script starts up agents for Alice and Faber, initializes them, and then runs through an interaction some number of times. In this case, Faber issues a credential to Alice 300 times.
412412

413413
To run the demo, make sure that you shut down any running Alice/Faber agents. Then, follow the same steps to start the Alice/Faber demo, but:
414414

@@ -449,7 +449,7 @@ Now that you have a solid foundation in using ACA-Py, time for a coding challeng
449449
* ACME requesting a proof of her College degree
450450
* ACME issuing Alice a credential after she is hired.
451451

452-
The framework for the code is in the [acme.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/runners/acme.py) file, but the code is incomplete. Using the knowledge you gained from running demo and viewing the alice.py and faber.py code, fill in the blanks for the code. When you are ready to test your work:
452+
The framework for the code is in the [acme.py](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/runners/acme.py) file, but the code is incomplete. Using the knowledge you gained from running demo and viewing the alice.py and faber.py code, fill in the blanks for the code. When you are ready to test your work:
453453

454454
* Use the instructions above to start the Alice/Faber demo (above).
455455
* Start another terminal session and run the same commands as for "Alice", but replace "alice" with "acme".

docs/deploying/Databases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The wallet supports 2 different databases to store data, SQLite and PostgreSQL.
66

77
## SQLite
88

9-
If the wallet is configured the default way in eg. [demo-args.yaml](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/demo/demo-args.yaml), without explicit wallet-storage, a sqlite database file is used.
9+
If the wallet is configured the default way in eg. [demo-args.yaml](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/demo/demo-args.yaml), without explicit wallet-storage, a sqlite database file is used.
1010

1111
```yaml
1212
# demo-args.yaml

docs/deploying/RedisPlugins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,14 +191,14 @@ Regardless of the options above, you will need to startup `deliverer` and `relay
191191
192192
Both relay and mediator [demos](https://github.com/bcgov/aries-acapy-plugin-redis-events/tree/master/demo) are also available.
193193
194-
# [aries-acapy-cache-redis](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.1/README.md) [`redis_cache`]
194+
# [aries-acapy-cache-redis](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.2/README.md) [`redis_cache`]
195195
196196
<!-- Adopted from aries-acapy-cache-redis/README.md -->
197197
ACA-Py uses a modular cache layer to story key-value pairs of data. The purpose
198198
of this plugin is to allow ACA-Py to use Redis as the storage medium for it's
199199
caching needs.
200200
201-
More details can be found [here](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.1/README.md).
201+
More details can be found [here](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.2/README.md).
202202
203203
### <b>Plugin configuration</b> [`yaml`]
204204
```
@@ -221,15 +221,15 @@ redis_cache:
221221
222222
#### <b>With Docker</b>
223223
- Running the plugin with docker is simple and straight-forward. There is an
224-
example [docker-compose.yml](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.1/docker-compose.yml) file in the root of the
224+
example [docker-compose.yml](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.2/docker-compose.yml) file in the root of the
225225
project that launches both ACA-Py and an accompanying Redis instance. Running
226226
it is as simple as:
227227
228228
```sh
229229
$ docker-compose up --build -d
230230
```
231231
232-
- To launch ACA-Py with an accompanying redis cluster of 6 nodes [3 primaries and 3 replicas], please refer to example [docker-compose.cluster.yml](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.1/docker-compose.cluster.yml) and run the following:
232+
- To launch ACA-Py with an accompanying redis cluster of 6 nodes [3 primaries and 3 replicas], please refer to example [docker-compose.cluster.yml](https://github.com/Indicio-tech/aries-acapy-cache-redis/blob/0.11.2/docker-compose.cluster.yml) and run the following:
233233
234234
Note: Cluster requires external docker network with specified subnet
235235

docs/deploying/UpgradingACA-Py.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,6 @@ storage](#no-version-in-secure-storage)" handling, it is unlikely this
124124
capability will ever be needed. We expect to deprecate and remove these
125125
options in future (post-0.8.1) ACA-Py versions.
126126

127-
[CHANGELOG.md]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/CHANGELOG.md
128-
[version.py]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/aries_cloudagent/version.py
129-
[Upgrade Definition YML file]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/aries_cloudagent/commands/default_version_upgrade_config.yml
127+
[CHANGELOG.md]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/CHANGELOG.md
128+
[version.py]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/aries_cloudagent/version.py
129+
[Upgrade Definition YML file]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/aries_cloudagent/commands/default_version_upgrade_config.yml

docs/features/AnoncredsProofValidation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
ACA-Py performs pre-validation when verifying Anoncreds presentations (proofs). Some scenarios are rejected (such as those indicative of tampering), while some attributes are removed before running the anoncreds validation (e.g., removing superfluous non-revocation timestamps). Any ACA-Py validations or presentation modifications are indicated by the "verify_msgs" attribute in the final presentation exchange object.
44

5-
The list of possible verification messages can be found [here](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/aries_cloudagent/indy/verifier.py#L24), and consists of:
5+
The list of possible verification messages can be found [here](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/aries_cloudagent/indy/verifier.py#L24), and consists of:
66

77
```python
88
class PresVerifyMsg(str, Enum):
@@ -61,7 +61,7 @@ The following pre-verification checks are performed, which will cause the proof
6161
VALUE_ERROR::<description of the failed validation>
6262
```
6363

64-
These validations are all performed within the [Indy verifier class](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/aries_cloudagent/indy/verifier.py) - to see the detailed validation, look for any occurrences of `raise ValueError(...)` in the code.
64+
These validations are all performed within the [Indy verifier class](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/aries_cloudagent/indy/verifier.py) - to see the detailed validation, look for any occurrences of `raise ValueError(...)` in the code.
6565

6666
A summary of the possible errors includes:
6767

docs/features/DevReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ aca-py start --inbound-transport http 0.0.0.0 8000 \
104104
--outbound-transport http
105105
```
106106

107-
ACA-Py ships with both inbound and outbound transport drivers for `http` and `ws` (websockets). Additional transport drivers can be added as pluggable implementations. See the existing implementations in the [transports module](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.1/aries_cloudagent/transport) for getting started on adding a new transport.
107+
ACA-Py ships with both inbound and outbound transport drivers for `http` and `ws` (websockets). Additional transport drivers can be added as pluggable implementations. See the existing implementations in the [transports module](https://github.com/hyperledger/aries-cloudagent-python/tree/0.11.2/aries_cloudagent/transport) for getting started on adding a new transport.
108108

109109
Most configuration parameters are provided to the agent at startup. Refer to the `Running` sections above for details on listing the available command line parameters.
110110

@@ -227,7 +227,7 @@ Please also refer to the [contributing guidelines](../../contributing/CONTRIBUTI
227227

228228
## Publishing Releases
229229

230-
The [publishing](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.1/PUBLISHING.md) document provides information on tagging a release and publishing the release artifacts to PyPi.
230+
The [publishing](https://github.com/hyperledger/aries-cloudagent-python/blob/0.11.2/PUBLISHING.md) document provides information on tagging a release and publishing the release artifacts to PyPi.
231231

232232
## Dynamic Injection of Services
233233

0 commit comments

Comments
 (0)