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

Commit

Permalink
Merge pull request #101 from swcurran/0.12.0rc3
Browse files Browse the repository at this point in the history
0.12.0rc3
  • Loading branch information
swcurran authored Apr 9, 2024
2 parents fe79c02 + d0d0246 commit 2f1685a
Show file tree
Hide file tree
Showing 29 changed files with 105 additions and 105 deletions.
12 changes: 6 additions & 6 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Release 0.12.0 is a relatively large release with many new capabilities, feature

Much progress has been made on `did:peer` support in this release, with the handling of inbound [DID Peer] 1 added, and inbound and outbound support for DID Peer 2 and 4. Much attention was also paid to making sure that the Peer DID and DID Exchange capabilities match those of [Credo-TS] (formerly Aries Framework JavaScript). The completion of that work eliminates the remaining places where "unqualified" DIDs are being used, and to enable the "connection reuse" in the Out of Band protocol when using DID Peer 2 and 4 DIDs. See the document [Qualified DIDs] for details about how to control the use of DID Peer 2 or 4 in an ACA-Py deployment, and how to eliminate the use of unqualified DIDs. Support for DID Exchange v1.1 has been added to ACA-Py, with support for DID Exchange v1.0 retained, and we've added support for DID Rotation.

[Qualified DIDs]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/./features/QualifiedDIDs.md
[Qualified DIDs]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/./features/QualifiedDIDs.md
[Credo-TS]: https://github.com/openwallet-foundation/credo-ts

Work continues towards supporting ledger agnostic [AnonCreds], and the new [Hyperledger AnonCreds Rust] library. Some of that work is in this release, the rest will be in the next release.
Expand Down Expand Up @@ -876,9 +876,9 @@ those published to the [Hyperledger Package Repository under
aries-cloudagent-python].

[Hyperledger Package Repository under aries-cloudagent-python]: https://github.com/orgs/hyperledger/packages?repo_name=aries-cloudagent-python
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish.yml
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish-indy.yml
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/ContainerImagesAndGithubActions.md
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/.github/workflows/publish.yml
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/.github/workflows/publish-indy.yml
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/ContainerImagesAndGithubActions.md

### Breaking Changes and Upgrades

Expand All @@ -892,7 +892,7 @@ case is that an ACA-Py instance publishes a public DID on a ledger with a
DIDComm `service` in the DIDDoc. Other agents resolve that DID, and attempt to
establish a connection with the ACA-Py instance using the `service` endpoint.
This is called an "implicit" connection in [RFC 0023 DID
Exchange](https://github.com/hyperledger/aries-rfcs/blob/main/features/0023-did-exchange/README.md).
Exchange](https://github.com/hyperledger/aries-rfcs/blob/0.12.0rc3/features/0023-did-exchange/README.md).

#### PR [\#1913](https://github.com/hyperledger/aries-cloudagent-python/pull/1913) -- Unrevealed attributes in presentations

Expand Down Expand Up @@ -1338,7 +1338,7 @@ However, anyone else using an external queue should be aware of the impact of th
included in the release.

For those that have an existing deployment of ACA-Py with long-lasting connection records, an upgrade is needed to use
[RFC 434 Out of Band](https://github.com/hyperledger/aries-rfcs/tree/main/features/0434-outofband) and the "reuse connection" as the invitee. In PR #1453
[RFC 434 Out of Band](https://github.com/hyperledger/aries-rfcs/tree/0.12.0rc3/features/0434-outofband) and the "reuse connection" as the invitee. In PR #1453
(details below) a performance improvement was made when finding a connection for reuse. The new approach
(adding a tag to the connection to enable searching) applies only to connections made using this ACA-Py
release and later, and "as-is" connections made using earlier releases of ACA-Py will not be found as reuse
Expand Down
6 changes: 3 additions & 3 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Once you have the list of PRs:

9. Immediately after it is merged, create a new GitHub tag representing the
version. The tag name and title of the release should be the same as the
version in [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/main/pyproject.toml). Use
version in [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/0.12.0rc3/pyproject.toml). Use
the "Generate Release Notes" capability to get a sequential listing of the
PRs in the release, to complement the manually curated Changelog. Verify on
PyPi that the version is published.
Expand All @@ -141,8 +141,8 @@ Once you have the list of PRs:
Additional information about the container image publication process can be
found in the document [Container Images and Github Actions](./deploying/ContainerImagesAndGithubActions.md).

[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish.yml
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish-indy.yml
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/.github/workflows/publish.yml
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/.github/workflows/publish-indy.yml

11. Update the ACA-Py Read The Docs site by building the new "latest" (main
branch) and activating and building the new release. Appropriate permissions
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Check it out! It's much easier to navigate than this GitHub repo for reading the

## Overview

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building Verifiable Credential (VC) ecosystems. It operates in the second and third layers of the [Trust Over IP framework (PDF)](https://trustoverip.org/wp-content/uploads/2020/05/toip_050520_primer.pdf) using [DIDComm messaging](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0005-didcomm) and [Hyperledger Aries](https://www.hyperledger.org/use/aries) protocols. The "cloud" in the name means that ACA-Py runs on servers (cloud, enterprise, IoT devices, and so forth), and is not designed to run on mobile devices.
Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building Verifiable Credential (VC) ecosystems. It operates in the second and third layers of the [Trust Over IP framework (PDF)](https://trustoverip.org/wp-content/uploads/2020/05/toip_050520_primer.pdf) using [DIDComm messaging](https://github.com/hyperledger/aries-rfcs/tree/0.12.0rc3/concepts/0005-didcomm) and [Hyperledger Aries](https://www.hyperledger.org/use/aries) protocols. The "cloud" in the name means that ACA-Py runs on servers (cloud, enterprise, IoT devices, and so forth), and is not designed to run on mobile devices.

ACA-Py is built on the Aries concepts and features that make up [Aries Interop Profile (AIP) 2.0](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0302-aries-interop-profile#aries-interop-profile-version-20). [ACA-Py’s supported Aries protocols](./features/SupportedRFCs.md) include, most importantly, protocols for issuing, verifying, and holding verifiable credentials using both [Hyperledger AnonCreds] verifiable credential format, and the [W3C Standard Verifiable Credential Data Model] format using JSON-LD with LD-Signatures and BBS+ Signatures. Coming soon -- issuing and presenting [Hyperledger AnonCreds] verifiable credentials using the [W3C Standard Verifiable Credential Data Model] format.
ACA-Py is built on the Aries concepts and features that make up [Aries Interop Profile (AIP) 2.0](https://github.com/hyperledger/aries-rfcs/tree/0.12.0rc3/concepts/0302-aries-interop-profile#aries-interop-profile-version-20). [ACA-Py’s supported Aries protocols](./features/SupportedRFCs.md) include, most importantly, protocols for issuing, verifying, and holding verifiable credentials using both [Hyperledger AnonCreds] verifiable credential format, and the [W3C Standard Verifiable Credential Data Model] format using JSON-LD with LD-Signatures and BBS+ Signatures. Coming soon -- issuing and presenting [Hyperledger AnonCreds] verifiable credentials using the [W3C Standard Verifiable Credential Data Model] format.

[Hyperledger AnonCreds]: https://www.hyperledger.org/use/anoncreds
[W3C Standard Verifiable Credential Data Model]: https://www.w3.org/TR/vc-data-model/
Expand All @@ -30,7 +30,7 @@ ACA-Py supports "multi-tenant" scenarios. In these scenarios, one (scalable) ins

### Mediator Service

Startup options allow the use of an ACA-Py as an Aries [mediator](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0046-mediators-and-relays#summary) using core Aries protocols to coordinate its mediation role. Such an ACA-Py instance receives, stores and forwards messages to Aries agents that (for example) lack an addressable endpoint on the Internet such as a mobile wallet. A live instance of a public mediator based on ACA-Py is available [here](https://indicio-tech.github.io/mediator/) from Indicio Technologies. Learn more about deploying a mediator [here](./features/Mediation.md). See the [Aries Mediator Service](https://github.com/hyperledger/aries-mediator-service) for a "best practices" configuration of an Aries mediator.
Startup options allow the use of an ACA-Py as an Aries [mediator](https://github.com/hyperledger/aries-rfcs/tree/0.12.0rc3/concepts/0046-mediators-and-relays#summary) using core Aries protocols to coordinate its mediation role. Such an ACA-Py instance receives, stores and forwards messages to Aries agents that (for example) lack an addressable endpoint on the Internet such as a mobile wallet. A live instance of a public mediator based on ACA-Py is available [here](https://indicio-tech.github.io/mediator/) from Indicio Technologies. Learn more about deploying a mediator [here](./features/Mediation.md). See the [Aries Mediator Service](https://github.com/hyperledger/aries-mediator-service) for a "best practices" configuration of an Aries mediator.

### Indy Transaction Endorsing

Expand Down
2 changes: 1 addition & 1 deletion docs/aca-py.org.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In addition to this documentation site, the ACA-Py community also maintains an
ACA-Py internals documentation site. The internals documentation consists of the
`docstrings` extracted from the ACA-Py Python code and covers all of the
(non-test) modules in the codebase. Check it out on the [Aries Cloud
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/latest/).
Agent-Python ReadTheDocs site](https://aries-cloud-agent-python.readthedocs.io/en/0.12.0rc3).
As with this site, the ReadTheDocs documentation is version specific.

Got questions?
Expand Down
2 changes: 1 addition & 1 deletion docs/demo/Aries-Workshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,4 +266,4 @@ yourself, with your Sandbox tenant. Once you review the code, you should have an
excellent idea of how you can add these same capabilities to your line of
business application.

[Traction Issuance Demo]: https://github.com/hyperledger/aries-acapy-controllers/tree/main/TractionIssuanceDemo
[Traction Issuance Demo]: https://github.com/hyperledger/aries-acapy-controllers/tree/0.12.0rc3/TractionIssuanceDemo
2 changes: 1 addition & 1 deletion docs/demo/AriesPostmanDemo.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Create a new postman workspace labeled "acapy-demo".

### Importing the environment

In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) which is the [environment file](https://github.com/hyperledger/aries-cloudagent-python/blob/main/demo/postman/environment.json) in the ACA-Py repository.
In the environment tab from the left, click the import button. You can paste this [link](https://raw.githubusercontent.com/hyperledger/aries-cloudagent-python/main/demo/postman/environment.json) which is the [environment file](https://github.com/hyperledger/aries-cloudagent-python/blob/0.12.0rc3/demo/postman/environment.json) in the ACA-Py repository.

Make sure you have the environment set as your active environment.

Expand Down
2 changes: 1 addition & 1 deletion docs/demo/Endorser.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This approach runs Faber as an un-privileged agent, and starts a dedicated Endor

Start a VON Network instance and a Tails server:

- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/main/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.
- Following the [Building and Starting](https://github.com/bcgov/von-network/blob/0.12.0rc3/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.
- 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.

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

0 comments on commit 2f1685a

Please sign in to comment.