aries_cloudagent.protocols.routing.v1_0 package



aries_cloudagent.protocols.routing.v1_0.manager module

Routing manager classes for tracking and inspecting routing records.

exception aries_cloudagent.protocols.routing.v1_0.manager.RouteNotFoundError(*args, error_code: Optional[str] = None, **kwargs)[source]

Bases: RoutingManagerError

Requested route was not found.

class aries_cloudagent.protocols.routing.v1_0.manager.RoutingManager(profile: Profile)[source]

Bases: object

Class for handling routing records.

RECORD_TYPE = 'forward_route'
async create_route_record(client_connection_id: Optional[str] = None, recipient_key: Optional[str] = None, internal_wallet_id: Optional[str] = None) RouteRecord[source]

Create and store a new RouteRecord.

  • client_connection_id – The ID of the connection record

  • recipient_key – The recipient verkey of the route

  • internal_wallet_id – The ID of the wallet record. Used for internal routing


The new routing record

async delete_route_record(route: RouteRecord)[source]

Remove an existing route record.

async get_recipient(recip_verkey: str) RouteRecord[source]

Resolve the recipient for a verkey.


recip_verkey – The verkey (“to”) of the incoming Forward message


The RouteRecord associated with this verkey

async get_routes(client_connection_id: Optional[str] = None, tag_filter: Optional[dict] = None) Sequence[RouteRecord][source]

Fetch all routes associated with the current connection.

  • client_connection_id – The ID of the connection record

  • tag_filter – An optional dictionary of tag filters


A sequence of route records found by the query

exception aries_cloudagent.protocols.routing.v1_0.manager.RoutingManagerError(*args, error_code: Optional[str] = None, **kwargs)[source]

Bases: BaseError

Generic routing error.

aries_cloudagent.protocols.routing.v1_0.message_types module

Message type identifiers for Routing.