RELEASES.md

Version 0.7.0 (2019-11-25)

Highlights

• Improved standard message dispatch bypass mechanism.
• Improved interface for MTCs.
• Significantly increased code coverage in unit tests resulting in overall improvement in reliability.

Detailed Changes

General Fixes and Improvements

• Export MessageDeliveryError from package root.
• Fixes for forwarding and processing forwarded messages.
• Fix Message equality checks.

Message Trust Contexts

• Add MTC helper functions for checking and setting typical message characteristics.
• Refactor Additional Data; now a class instead of a dictionary. Currently only has sender and recipient as properties. sender and recipient are also accessible as properties on MTC.

StaticConnection

• Remove ConditionallyAwaitFutureMessage construct in favor of simpler and more robust connection.next method.
• Refactor send method into injectable dependency. Defaults to HTTP.
• unpack will take a dictionary or bytes as input.
• pack takes plaintext as an argument.
• Add next context manager method, yielding a future to the next message matching the given type or condition. This mechanism is now also utilized in await_message.

Utils

• Move HTTP sending code to method under utils.

Version 0.6.1 (2019-11-19)

Fixes

• Fixed preparation of Forward message (PR #26)

Version 0.6.0 (2019-11-18)

Highlights

• Add support for forwarding for connections utilizing mediators for routing.
• Simplified StaticConnection and added mechanism for updating "their" info, resulting in differences in the method signature of its constructor.

Detailed Changes

StaticConnection

• __init__ - changed to accept tuple of keys (public, private) with optional named arguments: endpoint, their_vk, recipients, and routing_keys.
  • endpoint - sets the endpoint to which messages are sent.
  • their_vk - mutually exclusive with recipients and results in a recipients list of size one containing their_vk.
  • recipients - mutually exclusive with their_vk, setting the contents of the recipients list for this connection.
  • routing_keys - list of mediator keys that will forward the message on to the recipient(s).
• pack prepares messages for forwarding when routing_keys is set on the connection.
• Renamed convenience accessors for keys: my_vk -> verkey, my_sk -> sigkey.
• Added update - Updates "their" connection information for this static connection. Arguments are named arguments; processing is similar to __init__ with the exclusion of "my" keys. A change in my information should be viewed as creating a new connection and therefore updating those values is not supported.

Crypto

• pack_message - added named optional argument dump that will convert the packed message to bytes when set to True or will leave as a dictionary when set to False. Defaults to True.
• bytes_to_b58 and b58_to_bytes - added a small (max size of 16) lru_cache to make frequent conversions of keys in the pack, unpack, and message handling process more efficient.

Utils

• Added ensure_key_bytes - ensures that the given key is formatted as a byte string rather than a Base58 encoded string.
• Added ensure_key_b58 - ensures that the given key is formatted as a Base58 encoded string rather than as bytes.
• Added forward_msg - creates a new forward message.

Examples

• Updated to reflect new method signatures.

Version 0.5.1 (2019-11-06)

Bug fixes

• Fix condition not passed to await_message inside of send_and_await_reply.
• Return signer on verify_signed_message_field so that the signer of the message can be verified to be the expected signer.
• Fix usage of removed _key_for_type in dispatcher
• Fix tests

Additions

• Added more connection information to StaticConnection, including: did as Base58 encoding of first sixteen bytes of my_vk, my_vk_b58, their_vk_b58.

Version 0.5.0 (2019-10-21)

Highlights

• Add return route support.
• Add mechanism for directly awaiting a message, bypassing regular dispatch. This makes it possible to treat messages more like a return-response model and significantly simplifies some flows.

Detailed Changes

General improvements

• Favor named arguments over keyword arguments where possible.

Examples

• Added a return route server example, intended to be run with the corresponding client, to demonstrate return route support.
• Added a return route client example, intended to be run with the corresponding server, to demonstrate return route support.
• Removed original cron_returnroute example.

Improvements to StaticConnection

• Add construct for conditionally awaiting a message on the connection, bypassing regular dispatch. As a result, two new methods are defined on StaticConnection: await_message, and send_and_await_reply. See return route client example
• Add Reply construct to support return routing while keeping transport decoupled from the library. See return route server example.
• Add MessageUndeliverable Exception, raised when no endpoint or return route is currently available for the connection or other errors with the connection are encountered.
• Add support for unpacking plaintext messages.
• Better error handling in send.

Improvements to Dispatcher

• Add remove_handler method.

Version 0.4.0 (2019-09-20)

Highlights

• Switch to PyNacl instead of PySodium. PyNacl includes pre-built binary packages of libsodium; this switch means removing the dependency of libsodium being installed on the system.
• Module and route definition rewrite. The Module system has been significantly improved, allowing for cleaner and more flexible module definitions.

Detailed Changes

Improvements to Static (Agent) Connection

• Rename to StaticConnection.
• Reorder parameter into slightly more natural order. (Breaking change)
• Split out pack and unpack functionality into separate functions for a little added flexibility and simpler testing.
• route and route_module no longer simply wrap a dispatcher method. These methods are now responsible for creating Handlers corresponding to the route or routes defined by a module. See below for more on Dispatcher and Handler changes/additions.

Improvements to Crypto

• Switch to PyNacl instead of PySodium.
• Add field signing and verification helpers.

Improvements to Module

Overhauled route definitions (breaking changes):

• Use @route to define a route (instead of @route_def).
• No implicit routes. If a method of a module does not have a @route decorator, it will never be routed to.
• A bare @route will create a handler for the message type defined by combining the module's DOC_URI, PROTOCOL, VERSION and the method's name. Use @route(name='...') to specify a name that differs from the method name.
• Route a message that normally doesn't match the module's DOC_URI, PROTOCOL, or VERSION with @route(doc_uri='...', protocol='...', version='...'). If any of these keyword arguments are not specified, the module's defaults are used. You can also include name, as in the previous example, to specify a name that differs from the method name.
• @route('<raw_type_string>') will also work.

Improvements to Dispatcher

• Altered Dispatcher to operate on "Handlers" rather than simple type routes and modules. This improves handler selection and provides an overall cleaner interface.

Added Handler

• Relatively simple container used to help map a Type to a handler function.

Added Type

• Object used for representing the @type string.
• Allows for comparing types, better version information.
• Reduced code duplication across Message, Module, and Dispatcher.

Examples

• Cleaned up all examples.
• Added example for using a Module and web server.

Version 0.3.0 (2019-07-25)

This update includes many backported updates from the Aries Protocol Test Suite "agent core" which was originally derived from this library.

Potentially Breaking Changes

• Messages with malformed message types will raise an InvalidMessage exception instead of InvalidMessageType.
• Semver class moved from module to utils.

Additions

• Added route_module() to StaticAgentConnection.
• Added clear_routes() and clear_modules() to StaticAgentConnection.
• StaticAgentConnection.__init__() can now take the raw bytes of keys as well as base58 strings.
• Message Trust Contexts; StaticAgentConnection.handle() will add contexts as appropriate. See the tests for examples of querying or adding to these contexts.
• More tests