Skip to content

Commit

Permalink
updated: the arch doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chendiblessing committed Nov 15, 2024
1 parent 7c40911 commit 88f8255
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions docs/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@
- [**1. Introduction**](#1-introduction)
- [**1.1 Purpose**](#11-purpose)
- [**1.2 System Overview**](#12-system-overview)
- [**1.3 Scope**](#13-scope)
- [**1.3 Quality Goals**](#13-quality-goals)
- [**1.4 Stakeholders**](#14-stakeholders)
- [**1.5 Definitions and Acronyms**](#15-definitions-and-acronyms)
- [**2. Constraints**](#2-constraints)
- [**3. System Scope and Context**](#3-system-scope-and-context)
- [**3.1 Business Context**](#31-business-context)
- [**3.2 Technical Context**](#32-technical-context)
- [**12. Glossary**](#12-glossary)

## 1. Introduction
### 1.1 Purpose
Expand All @@ -18,18 +21,27 @@ This document provides a detailed architecture for the DIDComm Mediator, a syste
### 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.3 Quality Goals
- ***Security***: End-to-End encryption and authentication.
- ***Scalability***: Handle high message volume efficiently.
- ***Reliability***: Ensure fault tolerance and high availability
- ***Extensibility***: Support future enhancements and additional DID methods

### 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
- The project must adhere to DIDComm V2 specifications

# 3. System Scope and Context
### 3.1 Business Context
The DIDComm Mediator acts as a bridge to enable seemless communication between decentralized agents, ensuring secure and reliable message routing.

### 3.2 Technical Context

# 12. Glossary
- ***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

0 comments on commit 88f8255

Please sign in to comment.