From a5d7584758520da895d3775a8b71f584fdb93469 Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 6 Dec 2021 10:44:22 -0800 Subject: [PATCH 01/10] Changelog and RTD updates for the pending 0.7.3 release Signed-off-by: Stephen Curran --- docs/conf.py | 2 + docs/generated/aries_cloudagent.core.rst | 8 +++ ...es_cloudagent.ledger.merkel_validation.rst | 58 +++++++++++++++++++ ...ries_cloudagent.ledger.multiple_ledger.rst | 58 +++++++++++++++++++ docs/generated/aries_cloudagent.ledger.rst | 9 +++ ...nt.protocols.coordinate_mediation.v1_0.rst | 8 +++ .../aries_cloudagent.protocols.discovery.rst | 1 + ...dagent.protocols.discovery.v1_0.models.rst | 18 ++++++ ...es_cloudagent.protocols.discovery.v1_0.rst | 9 +++ ...gent.protocols.discovery.v2_0.handlers.rst | 26 +++++++++ ...gent.protocols.discovery.v2_0.messages.rst | 26 +++++++++ ...dagent.protocols.discovery.v2_0.models.rst | 18 ++++++ ...es_cloudagent.protocols.discovery.v2_0.rst | 44 ++++++++++++++ ...ent.protocols.endorse_transaction.v1_0.rst | 8 +++ ...dagent.protocols.issue_credential.v1_0.rst | 8 +++ ...dagent.protocols.issue_credential.v2_0.rst | 8 +++ ..._cloudagent.protocols.out_of_band.v1_0.rst | 8 +++ ...loudagent.protocols.present_proof.v1_0.rst | 8 +++ ...loudagent.protocols.present_proof.v2_0.rst | 8 +++ ...gent.protocols.revocation_notification.rst | 26 +++++++++ ....revocation_notification.v1_0.handlers.rst | 18 ++++++ ....revocation_notification.v1_0.messages.rst | 18 ++++++ ...ls.revocation_notification.v1_0.models.rst | 18 ++++++ ...protocols.revocation_notification.v1_0.rst | 36 ++++++++++++ docs/generated/aries_cloudagent.protocols.rst | 1 + 25 files changed, 450 insertions(+) create mode 100644 docs/generated/aries_cloudagent.ledger.merkel_validation.rst create mode 100644 docs/generated/aries_cloudagent.ledger.multiple_ledger.rst create mode 100644 docs/generated/aries_cloudagent.protocols.discovery.v1_0.models.rst create mode 100644 docs/generated/aries_cloudagent.protocols.discovery.v2_0.handlers.rst create mode 100644 docs/generated/aries_cloudagent.protocols.discovery.v2_0.messages.rst create mode 100644 docs/generated/aries_cloudagent.protocols.discovery.v2_0.models.rst create mode 100644 docs/generated/aries_cloudagent.protocols.discovery.v2_0.rst create mode 100644 docs/generated/aries_cloudagent.protocols.revocation_notification.rst create mode 100644 docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.handlers.rst create mode 100644 docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.messages.rst create mode 100644 docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.models.rst create mode 100644 docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.rst diff --git a/docs/conf.py b/docs/conf.py index 9fb915245e..cbf20e1fd0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,6 +43,8 @@ "dateutil", "jsonpath_ng", "unflatten", + "qrcode", + "rlp", ] # "aries_cloudagent.tests.test_conductor", diff --git a/docs/generated/aries_cloudagent.core.rst b/docs/generated/aries_cloudagent.core.rst index b93c0a7166..b708e02226 100644 --- a/docs/generated/aries_cloudagent.core.rst +++ b/docs/generated/aries_cloudagent.core.rst @@ -49,6 +49,14 @@ aries\_cloudagent.core.event\_bus module :undoc-members: :show-inheritance: +aries\_cloudagent.core.goal\_code\_registry module +-------------------------------------------------- + +.. automodule:: aries_cloudagent.core.goal_code_registry + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.core.plugin\_registry module ---------------------------------------------- diff --git a/docs/generated/aries_cloudagent.ledger.merkel_validation.rst b/docs/generated/aries_cloudagent.ledger.merkel_validation.rst new file mode 100644 index 0000000000..2aba21f5ce --- /dev/null +++ b/docs/generated/aries_cloudagent.ledger.merkel_validation.rst @@ -0,0 +1,58 @@ +aries\_cloudagent.ledger.merkel\_validation package +=================================================== + +.. automodule:: aries_cloudagent.ledger.merkel_validation + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.ledger.merkel\_validation.constants module +------------------------------------------------------------ + +.. automodule:: aries_cloudagent.ledger.merkel_validation.constants + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.merkel\_validation.domain\_txn\_handler module +----------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.merkel_validation.domain_txn_handler + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.merkel\_validation.hasher module +--------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.merkel_validation.hasher + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.merkel\_validation.merkel\_verifier module +------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.merkel_validation.merkel_verifier + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.merkel\_validation.trie module +------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.merkel_validation.trie + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.merkel\_validation.utils module +-------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.merkel_validation.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst b/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst new file mode 100644 index 0000000000..ed257bc7cf --- /dev/null +++ b/docs/generated/aries_cloudagent.ledger.multiple_ledger.rst @@ -0,0 +1,58 @@ +aries\_cloudagent.ledger.multiple\_ledger package +================================================= + +.. automodule:: aries_cloudagent.ledger.multiple_ledger + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.ledger.multiple\_ledger.base\_manager module +-------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.multiple_ledger.base_manager + :members: + :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 +------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.multiple_ledger.indy_vdr_manager + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.multiple\_ledger.ledger\_config\_schema module +----------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.multiple_ledger.ledger_config_schema + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.multiple\_ledger.ledger\_requests\_executor module +--------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.ledger.multiple_ledger.ledger_requests_executor + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.ledger.multiple\_ledger.manager\_provider module +------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.ledger.multiple_ledger.manager_provider + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.ledger.rst b/docs/generated/aries_cloudagent.ledger.rst index 66a6bda1c8..aff0574fef 100644 --- a/docs/generated/aries_cloudagent.ledger.rst +++ b/docs/generated/aries_cloudagent.ledger.rst @@ -6,6 +6,15 @@ aries\_cloudagent.ledger package :undoc-members: :show-inheritance: +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aries_cloudagent.ledger.merkel_validation + aries_cloudagent.ledger.multiple_ledger + Submodules ---------- diff --git a/docs/generated/aries_cloudagent.protocols.coordinate_mediation.v1_0.rst b/docs/generated/aries_cloudagent.protocols.coordinate_mediation.v1_0.rst index 40c1bb1da7..80c49734be 100644 --- a/docs/generated/aries_cloudagent.protocols.coordinate_mediation.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.coordinate_mediation.v1_0.rst @@ -19,6 +19,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.coordinate\_mediation.v1\_0.controller module +------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.coordinate_mediation.v1_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.coordinate\_mediation.v1\_0.manager module ---------------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.discovery.rst b/docs/generated/aries_cloudagent.protocols.discovery.rst index c93818adc0..4c736183c7 100644 --- a/docs/generated/aries_cloudagent.protocols.discovery.rst +++ b/docs/generated/aries_cloudagent.protocols.discovery.rst @@ -13,6 +13,7 @@ Subpackages :maxdepth: 4 aries_cloudagent.protocols.discovery.v1_0 + aries_cloudagent.protocols.discovery.v2_0 Submodules ---------- diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v1_0.models.rst b/docs/generated/aries_cloudagent.protocols.discovery.v1_0.models.rst new file mode 100644 index 0000000000..baec81e6d7 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.discovery.v1_0.models.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.protocols.discovery.v1\_0.models package +========================================================== + +.. automodule:: aries_cloudagent.protocols.discovery.v1_0.models + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.discovery.v1\_0.models.discovery\_record module +--------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v1_0.models.discovery_record + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v1_0.rst b/docs/generated/aries_cloudagent.protocols.discovery.v1_0.rst index aa83c1dae8..f221130077 100644 --- a/docs/generated/aries_cloudagent.protocols.discovery.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.discovery.v1_0.rst @@ -14,10 +14,19 @@ Subpackages aries_cloudagent.protocols.discovery.v1_0.handlers aries_cloudagent.protocols.discovery.v1_0.messages + aries_cloudagent.protocols.discovery.v1_0.models Submodules ---------- +aries\_cloudagent.protocols.discovery.v1\_0.manager module +---------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v1_0.manager + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.discovery.v1\_0.message\_types module ----------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v2_0.handlers.rst b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.handlers.rst new file mode 100644 index 0000000000..b79d280002 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.handlers.rst @@ -0,0 +1,26 @@ +aries\_cloudagent.protocols.discovery.v2\_0.handlers package +============================================================ + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.handlers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.discovery.v2\_0.handlers.disclosures\_handler module +-------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.handlers.disclosures_handler + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.discovery.v2\_0.handlers.queries\_handler module +---------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.handlers.queries_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v2_0.messages.rst b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.messages.rst new file mode 100644 index 0000000000..99fdbc332b --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.messages.rst @@ -0,0 +1,26 @@ +aries\_cloudagent.protocols.discovery.v2\_0.messages package +============================================================ + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.messages + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.discovery.v2\_0.messages.disclosures module +----------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.messages.disclosures + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.discovery.v2\_0.messages.queries module +------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.messages.queries + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v2_0.models.rst b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.models.rst new file mode 100644 index 0000000000..767db8e92e --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.models.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.protocols.discovery.v2\_0.models package +========================================================== + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.models + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.discovery.v2\_0.models.discovery\_record module +--------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.models.discovery_record + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.discovery.v2_0.rst b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.rst new file mode 100644 index 0000000000..d12fef9348 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.discovery.v2_0.rst @@ -0,0 +1,44 @@ +aries\_cloudagent.protocols.discovery.v2\_0 package +=================================================== + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0 + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aries_cloudagent.protocols.discovery.v2_0.handlers + aries_cloudagent.protocols.discovery.v2_0.messages + aries_cloudagent.protocols.discovery.v2_0.models + +Submodules +---------- + +aries\_cloudagent.protocols.discovery.v2\_0.manager module +---------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.manager + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.discovery.v2\_0.message\_types module +----------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.message_types + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.discovery.v2\_0.routes module +--------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.discovery.v2_0.routes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.endorse_transaction.v1_0.rst b/docs/generated/aries_cloudagent.protocols.endorse_transaction.v1_0.rst index 62f8d5b47d..eaf4c9eb32 100644 --- a/docs/generated/aries_cloudagent.protocols.endorse_transaction.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.endorse_transaction.v1_0.rst @@ -19,6 +19,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.endorse\_transaction.v1\_0.controller module +------------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.protocols.endorse_transaction.v1_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.endorse\_transaction.v1\_0.manager module --------------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.issue_credential.v1_0.rst b/docs/generated/aries_cloudagent.protocols.issue_credential.v1_0.rst index d380f5f12f..6221c61954 100644 --- a/docs/generated/aries_cloudagent.protocols.issue_credential.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.issue_credential.v1_0.rst @@ -19,6 +19,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.issue\_credential.v1\_0.controller module +--------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v1_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.issue\_credential.v1\_0.manager module ------------------------------------------------------------------ diff --git a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.rst b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.rst index b218bf8826..daf64871a1 100644 --- a/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.rst +++ b/docs/generated/aries_cloudagent.protocols.issue_credential.v2_0.rst @@ -20,6 +20,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.issue\_credential.v2\_0.controller module +--------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.issue_credential.v2_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.issue\_credential.v2\_0.manager module ------------------------------------------------------------------ diff --git a/docs/generated/aries_cloudagent.protocols.out_of_band.v1_0.rst b/docs/generated/aries_cloudagent.protocols.out_of_band.v1_0.rst index 424c8c5b9a..80443da521 100644 --- a/docs/generated/aries_cloudagent.protocols.out_of_band.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.out_of_band.v1_0.rst @@ -19,6 +19,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.out\_of\_band.v1\_0.controller module +----------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.out_of_band.v1_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.out\_of\_band.v1\_0.manager module -------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.present_proof.v1_0.rst b/docs/generated/aries_cloudagent.protocols.present_proof.v1_0.rst index 7fb3dd5dd0..1a18103b2d 100644 --- a/docs/generated/aries_cloudagent.protocols.present_proof.v1_0.rst +++ b/docs/generated/aries_cloudagent.protocols.present_proof.v1_0.rst @@ -19,6 +19,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.present\_proof.v1\_0.controller module +------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.protocols.present_proof.v1_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.present\_proof.v1\_0.manager module --------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.present_proof.v2_0.rst b/docs/generated/aries_cloudagent.protocols.present_proof.v2_0.rst index 19a5e02281..ad4e408035 100644 --- a/docs/generated/aries_cloudagent.protocols.present_proof.v2_0.rst +++ b/docs/generated/aries_cloudagent.protocols.present_proof.v2_0.rst @@ -20,6 +20,14 @@ Subpackages Submodules ---------- +aries\_cloudagent.protocols.present\_proof.v2\_0.controller module +------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.protocols.present_proof.v2_0.controller + :members: + :undoc-members: + :show-inheritance: + aries\_cloudagent.protocols.present\_proof.v2\_0.manager module --------------------------------------------------------------- diff --git a/docs/generated/aries_cloudagent.protocols.revocation_notification.rst b/docs/generated/aries_cloudagent.protocols.revocation_notification.rst new file mode 100644 index 0000000000..013c0319ac --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.revocation_notification.rst @@ -0,0 +1,26 @@ +aries\_cloudagent.protocols.revocation\_notification package +============================================================ + +.. automodule:: aries_cloudagent.protocols.revocation_notification + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aries_cloudagent.protocols.revocation_notification.v1_0 + +Submodules +---------- + +aries\_cloudagent.protocols.revocation\_notification.definition module +---------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.revocation_notification.definition + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.handlers.rst b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.handlers.rst new file mode 100644 index 0000000000..205b069dc4 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.handlers.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.protocols.revocation\_notification.v1\_0.handlers package +=========================================================================== + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.handlers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.revocation\_notification.v1\_0.handlers.revoke\_handler module +------------------------------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.handlers.revoke_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.messages.rst b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.messages.rst new file mode 100644 index 0000000000..d623d66dc8 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.messages.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.protocols.revocation\_notification.v1\_0.messages package +=========================================================================== + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.messages + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.revocation\_notification.v1\_0.messages.revoke module +--------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.messages.revoke + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.models.rst b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.models.rst new file mode 100644 index 0000000000..48164ca2bf --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.models.rst @@ -0,0 +1,18 @@ +aries\_cloudagent.protocols.revocation\_notification.v1\_0.models package +========================================================================= + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.models + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +aries\_cloudagent.protocols.revocation\_notification.v1\_0.models.rev\_notification\_record module +-------------------------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.models.rev_notification_record + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.rst b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.rst new file mode 100644 index 0000000000..06a3b4ace0 --- /dev/null +++ b/docs/generated/aries_cloudagent.protocols.revocation_notification.v1_0.rst @@ -0,0 +1,36 @@ +aries\_cloudagent.protocols.revocation\_notification.v1\_0 package +================================================================== + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0 + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aries_cloudagent.protocols.revocation_notification.v1_0.handlers + aries_cloudagent.protocols.revocation_notification.v1_0.messages + aries_cloudagent.protocols.revocation_notification.v1_0.models + +Submodules +---------- + +aries\_cloudagent.protocols.revocation\_notification.v1\_0.message\_types module +-------------------------------------------------------------------------------- + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.message_types + :members: + :undoc-members: + :show-inheritance: + +aries\_cloudagent.protocols.revocation\_notification.v1\_0.routes module +------------------------------------------------------------------------ + +.. automodule:: aries_cloudagent.protocols.revocation_notification.v1_0.routes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/generated/aries_cloudagent.protocols.rst b/docs/generated/aries_cloudagent.protocols.rst index 825fad65f1..c569e1d81b 100644 --- a/docs/generated/aries_cloudagent.protocols.rst +++ b/docs/generated/aries_cloudagent.protocols.rst @@ -25,6 +25,7 @@ Subpackages aries_cloudagent.protocols.out_of_band aries_cloudagent.protocols.present_proof aries_cloudagent.protocols.problem_report + aries_cloudagent.protocols.revocation_notification aries_cloudagent.protocols.routing aries_cloudagent.protocols.trustping From f10dbe8f16b07cd6e8b582302417eed0c002114b Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 6 Dec 2021 10:57:55 -0800 Subject: [PATCH 02/10] Updated the Supported RFCs document to reflect updates in this release Signed-off-by: Stephen Curran --- CHANGELOG.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++ SupportedRFCs.md | 18 +++++++------- 2 files changed, 71 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0ded2aaaf..dc9a8bd69f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,65 @@ +# 0.7.3 + +## Pending, Date TBD + +This release includes some new AIP 2.0 features out (Revocation Notification and +Discover Features 2.0), a major new feature for those using Indy ledger (multi-ledger support), +and a fix for a critical bug in some mediator scenarios. The release also includes several new +pieces of documentation (storage database information and logging) and some other documentation +updates that make the ACA-Py [Read The Docs site](https://aries-cloud-agent-python.readthedocs.io/en/latest/) +useful again. And of course, some recent bug fixes and cleanups are included. + +There is a **BREAKING CHANGE** for those deploying ACA-Py with an external outbound queue +implementation (see [PR #1501](https://github.com/hyperledger/aries-cloudagent-python/pull/1501)). +As far as we know, there is only one organization that has such an implementation and they +were involved in the creation of this PR, so we are not making this release a minor or major update. +However, anyone else using an external queue should be aware of the impact of this PR that is +included in the release. + +The [Supported RFCs document](/SupportedRFCs.md) has been updated to reflect the addition of the +AIP 2.0 RFCs for which support was added. + +The following is an annotated list of PRs in the release, including a link to each PR. + +- **AIP 2.0 Features** + - Discover Features Protocol: v1_0 refactoring and v2_0 implementation [[#1500](https://github.com/hyperledger/aries-cloudagent-python/pull/1500)](https://github.com/hyperledger/aries-cloudagent-python/pull/1500) + - Updates the Discover Features 1.0 (AIP 1.0) implementation and implements the new 2.0 version. In doing so, adds generalized support for goal codes to ACA-Py. + - Implement Revocation Notification v1.0 [#1464](https://github.com/hyperledger/aries-cloudagent-python/pull/1464) + - Fix integration tests (revocation notifications) [#1528](https://github.com/hyperledger/aries-cloudagent-python/pull/1528) + - Add Revocation notification support to alice/faber [#1527](https://github.com/hyperledger/aries-cloudagent-python/pull/1527) +- **Other New Features** + - Multiple Indy Ledger support and State Proof verification [#1425](https://github.com/hyperledger/aries-cloudagent-python/pull/1425) + - Outbound Queue - more usability improvements [#1501](https://github.com/hyperledger/aries-cloudagent-python/pull/1501) + - Display QR code when generating/displaying invites on startup [#1526](https://github.com/hyperledger/aries-cloudagent-python/pull/1526) + - Enable WS Pings for WS Inbound Transport [#1530](https://github.com/hyperledger/aries-cloudagent-python/pull/1530) + - Faster detection of lost Web Socket connections; implementation verified with an existing mediator. +- **Critical Fixes** + - Fix connection record response for mobile [#1469](https://github.com/hyperledger/aries-cloudagent-python/pull/1469) +- **Documentation Additions and Updates** + - added documentation for wallet storage databases [#1523](https://github.com/hyperledger/aries-cloudagent-python/pull/1523) + - added logging documentation [#1519](https://github.com/hyperledger/aries-cloudagent-python/pull/1519) + - Fix warnings when generating ReadTheDocs [#1509](https://github.com/hyperledger/aries-cloudagent-python/pull/1509) + - Remove Streetcred references [#1504](https://github.com/hyperledger/aries-cloudagent-python/pull/1504) + - Add RTD configs to get generator working [#1496](https://github.com/hyperledger/aries-cloudagent-python/pull/1496) +- **Key Fixes** + - Connection Handling / Out of Band Invitations Fixes + - OOB: Fixes issues with multiple public explicit invitation and unused 0160 connection [#1525](https://github.com/hyperledger/aries-cloudagent-python/pull/1525) + - Delete unused ConnRecord generated - OOB invitation (use_exising_connection) [#1521](https://github.com/hyperledger/aries-cloudagent-python/pull/1521) + - When an invitee responded with a "reuse" message, the connection record associated with the invitation was not being deleted. Now it is. + - DIF Presentation Exchange Cleanups + - Fix DIF Presentation Request Input Validation [#1517](https://github.com/hyperledger/aries-cloudagent-python/pull/1517) + - Some validation checking of a DIF presentation request to prevent uncaught errors later in the process. + - DIF PresExch - ProblemReport and "is_holder" [#1493](https://github.com/hyperledger/aries-cloudagent-python/pull/1493) + - Cleanups related to when "is_holder" is or is not required. Related to [Issue #1486](https://github.com/hyperledger/aries-cloudagent-python/issues/1486) + - Indy SDK Related Fixes + - Fix AttributeError when writing an Indy Cred Def record [#1516](https://github.com/hyperledger/aries-cloudagent-python/pull/1516) + - Fix TypeError when calling credential_definitions_fix_cred_def_wallet… [#1515](https://github.com/hyperledger/aries-cloudagent-python/pull/1515) + - Fix TypeError when writing a Schema record [#1494](https://github.com/hyperledger/aries-cloudagent-python/pull/1494) + - Aries Askar Related Fixes: + - Fix bug when getting credentials on askar-profile [#1510](https://github.com/hyperledger/aries-cloudagent-python/pull/1510) + - Fix error when removing a wallet on askar-profile [#1518](https://github.com/hyperledger/aries-cloudagent-python/pull/1518) + - Fix error when connection request is received (askar, public invitation) [#1508](https://github.com/hyperledger/aries-cloudagent-python/pull/1508) + # 0.7.2 ## November 15, 2021 diff --git a/SupportedRFCs.md b/SupportedRFCs.md index 17e85e94a2..dca001abc4 100644 --- a/SupportedRFCs.md +++ b/SupportedRFCs.md @@ -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 Rocketchat](https://chat.hyperledger.org) or through an issue in this repo. -**Last Update**: 2021-11-12, Release 0.7.2 +**Last Update**: 2021-12-06, Release 0.7.3 > The checklist version of this document was created as a joint effort > between [Northern Block](https://northernblock.io/) and [Animo Solutions](https://animo.id/). @@ -85,8 +85,8 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b | Connection-less (non OOB protocol / AIP 1.0) | :white_check_mark: | Only for issue credential and present proof | | Connection-less (OOB protocol / AIP 2.0) | :white_check_mark: | Only for present proof | | Signed Attachments | :white_check_mark: | Used for OOB | -| Multi ledger support (with automatic detection) | :construction: | [Pull Request](https://github.com/hyperledger/aries-cloudagent-python/pull/1425) | -| Persistence of mediated messages | :x: | Messages are currently stored in an in-memory and so are subject to loss in the case of a sudden termination of an ACA-Py process. The in-memory queue is properly handled in the case of a graceful shutdown of an ACA-Py process (e.g. processing of the queue completes and no new messages are accepted). | +| Multi Indy ledger support (with automatic detection) | :white_check_mark: | Support added in the 0.7.3 Release. | +| Persistence of mediated messages | :construction: | Messages are currently stored in an in-memory and so are subject to loss in the case of a sudden termination of an ACA-Py process. The in-memory queue is properly handled in the case of a graceful shutdown of an ACA-Py process (e.g. processing of the queue completes and no new messages are accepted). Work is underway to add useful external queues handling, including support for multiple external queue implementations (e.g., redis and kafka). | | Storage Import & Export | :warning: | Supported by directly interacting with the indy-sdk or Aries Askar (e.g., no Admin API endpoint available for wallet import & export). Aries Askar support includes the ability to import storage exported from the Indy SDK's "indy-wallet" component. | ## Supported RFCs @@ -108,13 +108,13 @@ are fully supported in ACA-Py **EXCEPT** as noted in the table below. | RFC | Supported | Notes | --- | :--: | -- | -| [0023-did-exchange](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0023-did-exchange) | :warning: | Not using DIDDoc conventions yet, still using DID format of 0160-connections (which is incorrect and outdated). Also using incorrect format for `did:peer` (or not using a `did:` prefix at all) | -| [0183-revocation-notification](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0183-revocation-notification) | :construction: | [PR is in review](https://github.com/hyperledger/aries-cloudagent-python/pull/1464) | -| [0211-route-coordination](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0211-route-coordination) | :warning: | Only pre-AIP 2.0 version. Must be updated to use `did:key` for full AIP 2.0 support | +| [0023-did-exchange](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0023-did-exchange) | :warning: | Not using DIDDoc conventions yet, still using DID format of 0160-connections (which is incorrect and outdated). Also using incorrect format for `did:peer` (or not using a `did:` prefix at all) | +| [0183-revocation-notification](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0183-revocation-notification) | :white_check_mark: | :new: This was added in release 0.7.3 and will be removed from this list with the next update. | +| [0211-route-coordination](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0211-route-coordination) | :warning: | Only pre-AIP 2.0 version. Must be updated to use `did:key` for full AIP 2.0 support | | [0317-please-ack](https://github.com/hyperledger/aries-rfcs/tree/main/features/0317-please-ack) | :x: | | | [0360-use-did-key](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0360-use-did-key) | :warning: | Creating and resolving `did:key` DIDs is supported, but not all protocols are updated yet to use `did:key`. This is a breaking change for AIP 1.0 -> AIP 2.0. | -| [0519-goal-codes](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/concepts/0519-goal-codes) | :x: | To be implemented as part of the work on RFC 0557 Discover Features V2 (below) | -| [0557-discover-features-v2](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2) | :x: | [Issue exists](https://github.com/hyperledger/aries-cloudagent-python/issues/1466) and is being implemented. | +| [0519-goal-codes](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/concepts/0519-goal-codes) | :white_check_mark: | :new: This was added in release 0.7.3 and will be removed from this list with the next update. | +| [0557-discover-features-v2](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2) | :white_check_mark: | :new: This was added in release 0.7.3 and will be removed from this list with the next update. | | [0587-encryption-envelope-v2](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0587-encryption-envelope-v2) | :construction: | Support for the DIDComm V2 envelope format is a work in progress, including the PRs ([AIP-2 base64url consistency](https://github.com/hyperledger/aries-cloudagent-python/pull/1188) and [Small AIP-2 updates](https://github.com/hyperledger/aries-cloudagent-python/pull/1056)) | | [0627-static-peer-dids](https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0627-static-peer-dids) | :x: | | @@ -122,6 +122,6 @@ are fully supported in ACA-Py **EXCEPT** as noted in the table below. | RFC | Supported | Notes | | --- | :--: | -- | -| [0031-discover-features](https://github.com/hyperledger/aries-rfcs/blob/main/features/0031-discover-features/README.md) | :warning: | Rarely (never?) used, and in implementing the V2 version of the protocol, the V1 version was found to be incomplete. It will be updated as part of the V2 work. | +| [0031-discover-features](https://github.com/hyperledger/aries-rfcs/blob/main/features/0031-discover-features/README.md) | :white_check_mark: | Rarely (never?) used, and in implementing the V2 version of the protocol, the V1 version was found to be incomplete and was updated as part of Release 0.7.3 | | [0028-introduce](https://github.com/hyperledger/aries-rfcs/blob/main/features/0028-introduce/README.md) | :white_check_mark: | | | [00509-action-menu](https://github.com/hyperledger/aries-rfcs/blob/main/features/0509-action-menu/README.md) | :white_check_mark: | | From 92cb1d411ccdeff3a3df8bdd5d746a8f8e03ff52 Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 6 Dec 2021 11:40:40 -0800 Subject: [PATCH 03/10] Update the publishing a release documentation Signed-off-by: Stephen Curran --- CHANGELOG.md | 2 ++ PUBLISHING.md | 25 +++++++++++++++++++------ 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc9a8bd69f..29b127d6a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,6 +59,8 @@ The following is an annotated list of PRs in the release, including a link to ea - Fix bug when getting credentials on askar-profile [#1510](https://github.com/hyperledger/aries-cloudagent-python/pull/1510) - Fix error when removing a wallet on askar-profile [#1518](https://github.com/hyperledger/aries-cloudagent-python/pull/1518) - Fix error when connection request is received (askar, public invitation) [#1508](https://github.com/hyperledger/aries-cloudagent-python/pull/1508) + - Release Adminstration: + - Changelog and RTD updates for the pending 0.7.3 release [#1553](https://github.com/hyperledger/aries-cloudagent-python/pull/1553) # 0.7.2 diff --git a/PUBLISHING.md b/PUBLISHING.md index c05a8bca5e..c52ebcb016 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -1,13 +1,26 @@ # How to Publish a New Version -0. The code to be published should be in the `main` branch. +The code to be published should be in the `main` branch. Make sure that all the PRs to go in the release are +merged, and decide on the release tag. Should it be a release candidate or the final tag, and should it be +a major, minor or patch release, per [semver](https://semver.org/) rules. -1. Update CHANGELOG.md to include details of the closed PRs included in this release. +Once ready to do a release, create a PR that includes the following updates: -2. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release. +1. Update the CHANGELOG.md to add the new release. If transitioning for a Release Candidate to the final release for the tag, do not create a new section -- just drop the "RC" designation. -3. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py). Include the additions to CHANGELOG.md in the release notes. +2. include details of the closed PRs included in this release. General process to follow: -4. Create a new [distribution package](https://packaging.python.org/glossary/#term-distribution-package) with `python setup.py sdist bdist_wheel` +- Gather the set of PRs since the last release and put them into a list. + - An example query to use to get the list of PRs is: [https://github.com/hyperledger/aries-cloudagent-python/pulls?q=is%3Apr+is%3Amerged+sort%3Aupdated+merged%3A%3E2021-11-15](https://github.com/hyperledger/aries-cloudagent-python/pulls?q=is%3Apr+is%3Amerged+sort%3Aupdated+merged%3A%3E2021-11-15), where the date at the end is the date of the previous release. + - Organize the list into suitable categories, update (if necessary) the PR description and add notes to clarify the changes. + - Add a link to each PR on the PR number. + - A regular expression you can use in VS Code to add the links to the list (assuming each line ends with the PR number) is `#([0-9]*)` (find) and `[#$1](https://github.com/hyperledger/aries-cloudagent-python/pull/$1)` (replace). Use regular expressions in the search, highlight the list and choose "Find in Selection" before replacing. + - Add a narrative about the release above the PR that highlights what has gone into the release. -5. Publish the release to [PyPI](https://pypi.org) using [twine](https://pypi.org/project/twine/) with `twine upload dist/*` +3. Update the ReadTheDocs in the `/docs` folder by following the instructions in the `docs/README.md` file. That will likely add a number of new and modified files to the PR. Eliminate all of the errors in the generation process, either by mocking external dependencies or by fixing ACA-Py code. If necessary, create an issue with the errors and assign it to the appropriate developer. Experience has demonstrated to use that documentation generation errors should be fixed in the code. + +4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release. + +5. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py). Include the additions to CHANGELOG.md in the release notes. + +6. Publish a new docker container on Docker Hub ([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/)) by following the instructions to create a PR for the release in the repository [https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container). From 5276e77e87289dd91a1b5ec53f0a4b0287360d9d Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Fri, 10 Dec 2021 11:02:53 -0800 Subject: [PATCH 04/10] Update publishing information Signed-off-by: Stephen Curran --- CHANGELOG.md | 2 +- PUBLISHING.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 29b127d6a2..33a9f2ad28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# 0.7.3 +# 0.7.3-RC0 ## Pending, Date TBD diff --git a/PUBLISHING.md b/PUBLISHING.md index c52ebcb016..3468f901bc 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -23,4 +23,6 @@ Once ready to do a release, create a PR that includes the following updates: 5. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py). Include the additions to CHANGELOG.md in the release notes. -6. Publish a new docker container on Docker Hub ([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/)) by following the instructions to create a PR for the release in the repository [https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container). +6. Publish a new docker container on Docker Hub ([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/)) by following the instructions to create a PR for the release in the repository [https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container). Appropriate permissions are required to publish the image. + +7. Update the AC-Py Read The Docs site by building the new "latest" (main branch) and activating and building the new release. Appropriate permissions are required to publish the new documentation version. From 355db3ef72b2eb5649e5317944dfa3f3b6a6e00a Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Fri, 10 Dec 2021 16:20:58 -0800 Subject: [PATCH 05/10] Added latest PRs to the changelog Signed-off-by: Stephen Curran --- CHANGELOG.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33a9f2ad28..dc94f213ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,15 @@ were involved in the creation of this PR, so we are not making this release a mi However, anyone else using an external queue should be aware of the impact of this PR that is included in the release. +For those that have an existing deployment of ACA-Py with long-lasting connection records, some action +may be required in order 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 +(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 +candidates. We don't think this will affect (m)any deployments and so have not implemented a migration +approach. However, if this issue might affect your deployment, please submit an issue and the ACA-Py +team will work with you to find a solution. + The [Supported RFCs document](/SupportedRFCs.md) has been updated to reflect the addition of the AIP 2.0 RFCs for which support was added. @@ -29,10 +38,13 @@ The following is an annotated list of PRs in the release, including a link to ea - Add Revocation notification support to alice/faber [#1527](https://github.com/hyperledger/aries-cloudagent-python/pull/1527) - **Other New Features** - Multiple Indy Ledger support and State Proof verification [#1425](https://github.com/hyperledger/aries-cloudagent-python/pull/1425) + - Remove required dependencies from multi-ledger code that was requiring the import of Aries Askar even when not being used[#1550](https://github.com/hyperledger/aries-cloudagent-python/pull/1550) - Outbound Queue - more usability improvements [#1501](https://github.com/hyperledger/aries-cloudagent-python/pull/1501) - Display QR code when generating/displaying invites on startup [#1526](https://github.com/hyperledger/aries-cloudagent-python/pull/1526) - Enable WS Pings for WS Inbound Transport [#1530](https://github.com/hyperledger/aries-cloudagent-python/pull/1530) - Faster detection of lost Web Socket connections; implementation verified with an existing mediator. + - Performance Improvement when using connection reuse in OOB and there are many DID connections. ConnRecord tags - their_public_did and invitation_msg_id [#1543](https://github.com/hyperledger/aries-cloudagent-python/pull/1543) + - In previous releases, a "their_public_did" was not a tag, so to see if you can reuse a connection, all connections were retrieved from the database to see if a matching public DID can be found. Now, connections created after deploying this release will have a tag on the connection such that an indexed query can be used. See "Breaking Change" note above. - **Critical Fixes** - Fix connection record response for mobile [#1469](https://github.com/hyperledger/aries-cloudagent-python/pull/1469) - **Documentation Additions and Updates** @@ -55,6 +67,8 @@ The following is an annotated list of PRs in the release, including a link to ea - Fix AttributeError when writing an Indy Cred Def record [#1516](https://github.com/hyperledger/aries-cloudagent-python/pull/1516) - Fix TypeError when calling credential_definitions_fix_cred_def_wallet… [#1515](https://github.com/hyperledger/aries-cloudagent-python/pull/1515) - Fix TypeError when writing a Schema record [#1494](https://github.com/hyperledger/aries-cloudagent-python/pull/1494) + - Fix validation for range checks [#1538](https://github.com/hyperledger/aries-cloudagent-python/pull/1538) + - Back out some of the validation checking for proof requests with predicates as they were preventing valid proof requests from being processed. - Aries Askar Related Fixes: - Fix bug when getting credentials on askar-profile [#1510](https://github.com/hyperledger/aries-cloudagent-python/pull/1510) - Fix error when removing a wallet on askar-profile [#1518](https://github.com/hyperledger/aries-cloudagent-python/pull/1518) From 36a5be081de9b481e5e688dd5f43fd59451f021e Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Sat, 11 Dec 2021 12:13:22 -0800 Subject: [PATCH 06/10] Apply the final tag for the 0.7.3-RC0 release Signed-off-by: Stephen Curran --- CHANGELOG.md | 2 +- PUBLISHING.md | 10 ++++++---- aries_cloudagent/version.py | 2 +- open-api/openapi.json | 2 +- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc94f213ed..374ae9c73b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # 0.7.3-RC0 -## Pending, Date TBD +## December 11, 2021 This release includes some new AIP 2.0 features out (Revocation Notification and Discover Features 2.0), a major new feature for those using Indy ledger (multi-ledger support), diff --git a/PUBLISHING.md b/PUBLISHING.md index 3468f901bc..386f42e0a0 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -19,10 +19,12 @@ Once ready to do a release, create a PR that includes the following updates: 3. Update the ReadTheDocs in the `/docs` folder by following the instructions in the `docs/README.md` file. That will likely add a number of new and modified files to the PR. Eliminate all of the errors in the generation process, either by mocking external dependencies or by fixing ACA-Py code. If necessary, create an issue with the errors and assign it to the appropriate developer. Experience has demonstrated to use that documentation generation errors should be fixed in the code. -4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release. +4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py) and in [open-api/openapi.json](open-api/openapi.json). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release, for example "v0.7.2". For Release Candidates, the form of the tag is "v0.7.2-rc0". + +5. An extra search of the repo for the existing tag is recommended to see if there are any other instances of the tag in the repo. If any are found to be required, finding a way to not need them is best, but if they are needed, please update this document to note where the tag can be found. -5. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py). Include the additions to CHANGELOG.md in the release notes. +6. Create a new GitHub release. The tag name and title of the release should be the same as the version in [aries_cloudagent/version.py](aries_cloudagent/version.py). Include the additions to CHANGELOG.md in the release notes. -6. Publish a new docker container on Docker Hub ([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/)) by following the instructions to create a PR for the release in the repository [https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container). Appropriate permissions are required to publish the image. +7. Publish a new docker container on Docker Hub ([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/)) by following the instructions to create a PR for the release in the repository [https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container). Appropriate permissions are required to publish the image. -7. Update the AC-Py Read The Docs site by building the new "latest" (main branch) and activating and building the new release. Appropriate permissions are required to publish the new documentation version. +8. Update the ACA-Py Read The Docs site by building the new "latest" (main branch) and activating and building the new release. Appropriate permissions are required to publish the new documentation version. diff --git a/aries_cloudagent/version.py b/aries_cloudagent/version.py index 66773e2793..17d9640e32 100644 --- a/aries_cloudagent/version.py +++ b/aries_cloudagent/version.py @@ -1,3 +1,3 @@ """Library version information.""" -__version__ = "0.7.2" +__version__ = "v0.7.3-rc0" diff --git a/open-api/openapi.json b/open-api/openapi.json index 8fbc56d531..726cfa2cdb 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "version" : "v0.7.2", + "version" : "v0.7.3-rc0", "title" : "Aries Cloud Agent" }, "tags" : [ { From e859b2e3f3ba4e2dec4a6f9027d08aed6039e5f4 Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 13 Dec 2021 13:49:23 -0800 Subject: [PATCH 07/10] Update release date Signed-off-by: Stephen Curran --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 374ae9c73b..09e65ab224 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # 0.7.3-RC0 -## December 11, 2021 +## December 13, 2021 This release includes some new AIP 2.0 features out (Revocation Notification and Discover Features 2.0), a major new feature for those using Indy ledger (multi-ledger support), From dc0b65e86de82b2efa5172576a368d9036689de8 Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 13 Dec 2021 14:23:25 -0800 Subject: [PATCH 08/10] Correct typo in docs Signed-off-by: Stephen Curran --- PUBLISHING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PUBLISHING.md b/PUBLISHING.md index 386f42e0a0..b8ac5b6fc3 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -19,7 +19,7 @@ Once ready to do a release, create a PR that includes the following updates: 3. Update the ReadTheDocs in the `/docs` folder by following the instructions in the `docs/README.md` file. That will likely add a number of new and modified files to the PR. Eliminate all of the errors in the generation process, either by mocking external dependencies or by fixing ACA-Py code. If necessary, create an issue with the errors and assign it to the appropriate developer. Experience has demonstrated to use that documentation generation errors should be fixed in the code. -4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py) and in [open-api/openapi.json](open-api/openapi.json). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release, for example "v0.7.2". For Release Candidates, the form of the tag is "v0.7.2-rc0". +4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py) and in [open-api/openapi.json](open-api/openapi.json). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release, for example "0.7.2". For Release Candidates, the form of the tag is "0.7.2-rc0". 5. An extra search of the repo for the existing tag is recommended to see if there are any other instances of the tag in the repo. If any are found to be required, finding a way to not need them is best, but if they are needed, please update this document to note where the tag can be found. From 5b9f247e3a2a60ccfde54c08416474a831e0fe98 Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 13 Dec 2021 14:25:01 -0800 Subject: [PATCH 09/10] Correct typo in version.py and openapi.json Signed-off-by: Stephen Curran --- aries_cloudagent/version.py | 2 +- open-api/openapi.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/aries_cloudagent/version.py b/aries_cloudagent/version.py index 17d9640e32..63ca7dd10c 100644 --- a/aries_cloudagent/version.py +++ b/aries_cloudagent/version.py @@ -1,3 +1,3 @@ """Library version information.""" -__version__ = "v0.7.3-rc0" +__version__ = "0.7.3-rc0" diff --git a/open-api/openapi.json b/open-api/openapi.json index 726cfa2cdb..c1c513195e 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "version" : "v0.7.3-rc0", + "version" : "0.7.3-rc0", "title" : "Aries Cloud Agent" }, "tags" : [ { From 43956f1c9fa069bbe966bb3e4a58ae5df5fa867b Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Mon, 13 Dec 2021 14:43:26 -0800 Subject: [PATCH 10/10] Adding changelog entries for last PRs, docs and openapi fix Signed-off-by: Stephen Curran --- CHANGELOG.md | 4 +++- PUBLISHING.md | 2 +- open-api/openapi.json | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09e65ab224..4a9a4e61d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,6 +45,7 @@ The following is an annotated list of PRs in the release, including a link to ea - Faster detection of lost Web Socket connections; implementation verified with an existing mediator. - Performance Improvement when using connection reuse in OOB and there are many DID connections. ConnRecord tags - their_public_did and invitation_msg_id [#1543](https://github.com/hyperledger/aries-cloudagent-python/pull/1543) - In previous releases, a "their_public_did" was not a tag, so to see if you can reuse a connection, all connections were retrieved from the database to see if a matching public DID can be found. Now, connections created after deploying this release will have a tag on the connection such that an indexed query can be used. See "Breaking Change" note above. + - Follow up to [#1543](https://github.com/hyperledger/aries-cloudagent-python/pull/1543) - Adding invitation_msg_id and their_public_did back to record_value [#1553](https://github.com/hyperledger/aries-cloudagent-python/pull/1553) - **Critical Fixes** - Fix connection record response for mobile [#1469](https://github.com/hyperledger/aries-cloudagent-python/pull/1469) - **Documentation Additions and Updates** @@ -53,11 +54,12 @@ The following is an annotated list of PRs in the release, including a link to ea - Fix warnings when generating ReadTheDocs [#1509](https://github.com/hyperledger/aries-cloudagent-python/pull/1509) - Remove Streetcred references [#1504](https://github.com/hyperledger/aries-cloudagent-python/pull/1504) - Add RTD configs to get generator working [#1496](https://github.com/hyperledger/aries-cloudagent-python/pull/1496) -- **Key Fixes** +- **Other Fixes** - Connection Handling / Out of Band Invitations Fixes - OOB: Fixes issues with multiple public explicit invitation and unused 0160 connection [#1525](https://github.com/hyperledger/aries-cloudagent-python/pull/1525) - Delete unused ConnRecord generated - OOB invitation (use_exising_connection) [#1521](https://github.com/hyperledger/aries-cloudagent-python/pull/1521) - When an invitee responded with a "reuse" message, the connection record associated with the invitation was not being deleted. Now it is. + - Await asyncio.sleeps to cleanup warnings in Python 3.8/3.9 [#1558](https://github.com/hyperledger/aries-cloudagent-python/pull/1558) - DIF Presentation Exchange Cleanups - Fix DIF Presentation Request Input Validation [#1517](https://github.com/hyperledger/aries-cloudagent-python/pull/1517) - Some validation checking of a DIF presentation request to prevent uncaught errors later in the process. diff --git a/PUBLISHING.md b/PUBLISHING.md index b8ac5b6fc3..9f97266bad 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -19,7 +19,7 @@ Once ready to do a release, create a PR that includes the following updates: 3. Update the ReadTheDocs in the `/docs` folder by following the instructions in the `docs/README.md` file. That will likely add a number of new and modified files to the PR. Eliminate all of the errors in the generation process, either by mocking external dependencies or by fixing ACA-Py code. If necessary, create an issue with the errors and assign it to the appropriate developer. Experience has demonstrated to use that documentation generation errors should be fixed in the code. -4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py) and in [open-api/openapi.json](open-api/openapi.json). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release, for example "0.7.2". For Release Candidates, the form of the tag is "0.7.2-rc0". +4. Update the version number listed in [aries_cloudagent/version.py](aries_cloudagent/version.py) and, prefixed with a "v" in [open-api/openapi.json](open-api/openapi.json) (e.g. "v0.7.2" in the openapi.json file, and "0.7.2" in the version.py file). The incremented version number should adhere to the [Semantic Versioning Specification](https://semver.org/#semantic-versioning-specification-semver) based on the changes since the last published release. For Release Candidates, the form of the tag is "0.7.2-rc0". 5. An extra search of the repo for the existing tag is recommended to see if there are any other instances of the tag in the repo. If any are found to be required, finding a way to not need them is best, but if they are needed, please update this document to note where the tag can be found. diff --git a/open-api/openapi.json b/open-api/openapi.json index c1c513195e..726cfa2cdb 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -1,7 +1,7 @@ { "swagger" : "2.0", "info" : { - "version" : "0.7.3-rc0", + "version" : "v0.7.3-rc0", "title" : "Aries Cloud Agent" }, "tags" : [ {