Skip to content

Commit

Permalink
Merge pull request #3092 from swcurran/1.0.0rc4
Browse files Browse the repository at this point in the history
1.0.0rc4
  • Loading branch information
swcurran authored Jul 9, 2024
2 parents 22fed03 + 9fdde91 commit 811ff3b
Show file tree
Hide file tree
Showing 24 changed files with 305 additions and 122 deletions.
153 changes: 153 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"typing_extensions",
"unflatten",
"yaml",
"uuid_utils",
]

# "aries_cloudagent.tests.test_conductor",
Expand Down
8 changes: 4 additions & 4 deletions docs/features/SupportedRFCs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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).

Expand Down Expand Up @@ -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).<br><br>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
Expand Down
8 changes: 8 additions & 0 deletions docs/generated/aries_cloudagent.admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------------------------------------

Expand Down
18 changes: 18 additions & 0 deletions docs/generated/aries_cloudagent.didcomm_v2.rst
Original file line number Diff line number Diff line change
@@ -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:
1 change: 0 additions & 1 deletion docs/generated/aries_cloudagent.indy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Subpackages

aries_cloudagent.indy.credx
aries_cloudagent.indy.models
aries_cloudagent.indy.sdk

Submodules
----------
Expand Down
74 changes: 0 additions & 74 deletions docs/generated/aries_cloudagent.indy.sdk.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/generated/aries_cloudagent.ledger.multiple_ledger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------------------------------------

Expand Down
8 changes: 0 additions & 8 deletions docs/generated/aries_cloudagent.ledger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/generated/aries_cloudagent.messaging.models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
8 changes: 8 additions & 0 deletions docs/generated/aries_cloudagent.messaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Original file line number Diff line number Diff line change
@@ -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:
1 change: 1 addition & 0 deletions docs/generated/aries_cloudagent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions docs/generated/aries_cloudagent.storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------------------

Expand Down
8 changes: 0 additions & 8 deletions docs/generated/aries_cloudagent.storage.vc_holder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------------------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/generated/aries_cloudagent.transport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/generated/aries_cloudagent.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------

Expand Down
Loading

0 comments on commit 811ff3b

Please sign in to comment.