...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Abstract

Mediator service is like a drop box / post box that Aries agents can use to receive and store encrypted messages in their stead.

...

• High performance
• Horizontal scalability
• Simpler and more robust integration with Aries-vcx
• Support for newer standard protocols like Pick Up protocol.

Deliverables

Main Deliverables:

•  Specialized high performance Aries agent (mediator to-be) that can store "forward messages" received through connection protocol.
•  Pickup protocol data structs and impl inside aries-vcx
•  Mediator service that can answer pick up protocol requests to authenticated peers
•  CI to build and test on new commits.

...

•  CI to make releases based on tags and provide binaries or docker image in Github's release section.
•  (stretch goal): design/document mediator service component that can notify registered peers on inbox message available.

Project Plan

Stage 1: HTTP Server 

•  Research and choose rust based web framework, suitable for project goals
•  Implement simple http service with some endpoints
•  Include logging library (env_logger is popular choice)
•  Include E2E test - make request against the endpoints, expect appropriate response
•  CI: Lint, build, run & test each commit

Stage 2: Storage

•  Understand pick-up protocol specification
•  Based on the specification, design trait for retrieving messages and storing messages
•  Provide mysql implementation
•  Include integration tests
•  CI: Include new set of tests in CI

Stage 3: Integrate Aries-vcx

•  Include aries-vcx as project dependency
•  Initialize aries-vcx library (create wallet)
•  Add endpoint for clients to fetch connection invitation (built using aries-vcx)

Stage 4: Support establishing didcomm connections

•  Decide if there is need to alter storage traits, or to just create new implementations, and act accordingly.
  
•  Implement endpoint to fetch mediator's connection invitiation
•  Support establishing didcomm connection between client and mediator using aries-vcx Connection state machine
•  Create e2e test for establishing didcomm connection betwen test client and the mediator

stage 5: Receiving and storing didcomm messages

•  Enable receiving messages (mediation) on behalf of a connected client (which established connection and requested mediation - stage 4)
•  Add medaitor e2e test where mediator receives and stores didcomm message

stage 6: Add pickup protocol support

•  Add pick-up protocol data model to aries-vcx messages crate
•  Add pick-up protocol messages parsing to mediator
•  Add mediator e2e test performing message pick-up

stage 7: Bonus - websocket

•  Implement websocket interface for pickup protocol (think can be broken down further if we start working on this)

stage 8: Bonus - notifications

•  Implement pub/sub mechanism in distributed environment to assure instant notification of connected websocket clients about a newly received message (think can be broken down further if we start working on this)

Milestones

Evaluation 1 (July 11):

• Development environment setup
• Rust learning, http framework research
• Evaluation of Stage 1

Evaluation 2 (August 22):

• Evaluation of Stage 2, 3, 4

Evaluation 3 (October 6):

• Evaluation of Stage 5, 6

Evaluation 4 (November 14):

• Evaluation of Stage 7 / 8 or overall solution polishing&refactoring

Timeline

Future plans

Design and document ways in which websocket based notification service could be integrated into mediator service project

Participants (Mentors/Mentees)

Mentors

Mentee

Processes

Internal communication and updates:

...