Skip to content

Commit

Permalink
feat: init Architecture doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chendiblessing committed Nov 15, 2024
1 parent 00d2efe commit 7c40911
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/Architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# DIDComm Mediator Architecture Document

### **Table of Contents**
- [**DIDComm Mediator Architecture Document**](#didcomm-mediator-architecture-document)
- [**Table of Contents**](#table-of-contents)
- [**1. Introduction**](#1-introduction)
- [**1.1 Purpose**](#11-purpose)
- [**1.2 System Overview**](#12-system-overview)
- [**1.3 Scope**](#13-scope)
- [**1.4 Stakeholders**](#14-stakeholders)
- [**1.5 Definitions and Acronyms**](#15-definitions-and-acronyms)
- [**2. Constraints**](#2-constraints)

## 1. Introduction
### 1.1 Purpose
This document provides a detailed architecture for the DIDComm Mediator, a system designed to mediate communication between decentralized identities (DIDs) using the DIDComm protocol. The document outlines the design decisions, components, and interactions in the system.

### 1.2 System Overview
The DIDComm Mediator acts as an intermediary that forwards messages between decentralized identifiers (DIDs) while maintaining security, privacy, and scalability. It adheres to the DIDComm messaging protocol, enabling seamless communication between agents.

### 1.3 Scope
The DIDComm Mediator serves as an intermediary for decentralized communication, supporting DIDComm messages over secure channels, forwarding, and routing messages to the appropriate endpoints

### 1.4 Stakeholders
Key stakeholders include DATEV, the adorsys development team, and third-party developers

### 1.5 Definitions and Acronyms
- ***DID(Decentralized Identifier):*** A unique identifier that enables verifiable, self-sovereign identities
- ***DIDComm:*** A secure messaging protocol used to communicate over decentralized networks
- ***Mediator:*** An intermediary service that routes DIDComm messages between agents

# 2. Constraints
- The project will be implemented in rust so as to take advantage of it's performance and safety features
- Only asynchronous Rust frameworks like tokio, axum, hyper, tracing can be used to ensure non-blocking operations
- The project must adhere to DIDComm V2 specifications

0 comments on commit 7c40911

Please sign in to comment.