Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(shared): Interdependencies.md #299

Merged
merged 12 commits into from
Jan 17, 2023
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ package-lock.json
**/.docker-volumes/*
target/
**.env.*
project
83 changes: 83 additions & 0 deletions Interdependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Interdependencies

This document describes the interdependencies between the different Building Blocks.



```mermaid
flowchart
PLUTO-didcomm -.WIP.-> OR1{OR}
didcommx --external dependency--> OR1{OR}

subgraph PRISM
prism-cryto --> prism-node-1.4
prism-cryto --> OR2{OR}
prism-node-1.4 -.copy proto files.-> prism-node

subgraph BB[Building Blocks Interdependencies]


pluto -.WIP.-> OR2{OR}
pluto --> PLUTO-didcomm

OR1 --> mercury

OR2 ---> iris
OR2 --> castor

subgraph REPO [BB Repository]
prism-node -.???\nMAYBE in the future.-> pollux
prism-node --> castor

iris -.IRIS client\nMAYBE in the future.-> castor
iris -.IRIS client\nMAYBE in the future.-> prism-agent
iris --> iris-server

shared --> prism-agent
shared --> pollux
shared --> castor
shared --> connect
shared --> iris

mercury --> pollux
mercury --> connect
mercury --> prism-agent
mercury --> mediator

connect --> prism-agent

castor --> pollux
castor --> prism-agent
%%castor --> iris

pollux --> prism-agent

infrastructure
test
end
end
end



%% All
castor[Castor]
connect
infrastructure
iris[IRIS]
iris-server((IRIS-server))
mercury[MERCURY]
mediator((Mercury\nMediator))
pluto[PLUTO extrenal repo]
pollux[POLLUX]
prism-agent((Prism Agent))
prism-node[prism-node-client]
shared
test
```

**Note:**
- The **Mercury Libraries** are the collection of dependencies with the single cross version.
We will represent as a single box here. But the real dependencies can of a subset of the Mercury Libraries.
For more information about the Mercury Modules Interdependencies see [HERE](./mercury/mercury-library/README.md).
- The **Pollux Libraries** are the collection of dependencies with the single cross version.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@

## Documentation

* [OpenAPI docs](openapi)
<!-- FIXME * [OpenAPI docs](openapi) -->

* [Interdependencies](./Interdependencies.md)

## Running a single instance locally

Expand Down