From 79bc65d7f6f70907030f96e8dfc4659e499cc1a3 Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 16:17:59 +0000 Subject: [PATCH 1/8] doc(all): Add Interdependencies.md --- .gitignore | 1 + Interdependencies.md | 71 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 Interdependencies.md diff --git a/.gitignore b/.gitignore index 9718a056d4..312f9cf9e0 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,4 @@ package-lock.json **/.docker-volumes/* target/ **.env.* +project \ No newline at end of file diff --git a/Interdependencies.md b/Interdependencies.md new file mode 100644 index 0000000000..2c88594295 --- /dev/null +++ b/Interdependencies.md @@ -0,0 +1,71 @@ +# Interdependencies + +This document describes the interdependencies between the different Building Blocks. + + + +```mermaid +flowchart + PLUTO-didcomm --> 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] + prism-node -.???\nMAYBE in the future.-> castor + prism-node -.???\nMAYBE in the future.-> pollux + + pluto --> OR2{OR} + pluto --> PLUTO-didcomm + + OR1 --> mercury + + OR2 --> castor + + subgraph REPO [BB Repository] + shared --> castor + shared --> pollux + shared --> prism-agent + shared --> connect + + mercury --> pollux + mercury --> connect + mercury --> prism-agent + mercury --> mediator + + connect --> prism-agent + + castor --> iris + castor --> prism-agent + + + infrastructure + test + end + end + end + + + +%% All +castor[Castor] +connect +infrastructure +iris[IRIS] +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** is 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). \ No newline at end of file From 4c678ea5d7e2a7ab48249d6723e5cad85d724d62 Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 16:21:43 +0000 Subject: [PATCH 2/8] Add link on root README.mr --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 185748ae13..033ef0d892 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ ## Documentation -* [OpenAPI docs](openapi) + + +* [Interdependencies](./Interdependencies.md) ## Running a single instance locally From d704881fac1989411fbe3ccf4e0ae7164c05b08e Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 16:38:25 +0000 Subject: [PATCH 3/8] add 'WIP' on lines --- Interdependencies.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Interdependencies.md b/Interdependencies.md index 2c88594295..54f8f1d4ee 100644 --- a/Interdependencies.md +++ b/Interdependencies.md @@ -6,7 +6,7 @@ This document describes the interdependencies between the different Building Blo ```mermaid flowchart - PLUTO-didcomm --> OR1{OR} + PLUTO-didcomm -.WIP.-> OR1{OR} didcommx --external dependency--> OR1{OR} subgraph PRISM @@ -18,7 +18,7 @@ flowchart prism-node -.???\nMAYBE in the future.-> castor prism-node -.???\nMAYBE in the future.-> pollux - pluto --> OR2{OR} + pluto -.WIP.-> OR2{OR} pluto --> PLUTO-didcomm OR1 --> mercury From 18a8f0423ff45791e920f6f5619e17a71ea5a978 Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 16:41:40 +0000 Subject: [PATCH 4/8] Add castor --> pollux --- Interdependencies.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Interdependencies.md b/Interdependencies.md index 54f8f1d4ee..029b75d341 100644 --- a/Interdependencies.md +++ b/Interdependencies.md @@ -39,6 +39,7 @@ flowchart connect --> prism-agent castor --> iris + castor --> pollux castor --> prism-agent @@ -66,6 +67,7 @@ test ``` **Note:** -The **Mercury Libraries** is the collection of dependencies with the single cross version. +- 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). \ No newline at end of file +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. \ No newline at end of file From 68818927bb1d41b38bfa1b7e186b1cd292289d15 Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 16:42:49 +0000 Subject: [PATCH 5/8] Add pollux --> prism-agent --- Interdependencies.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Interdependencies.md b/Interdependencies.md index 029b75d341..7854a2d44c 100644 --- a/Interdependencies.md +++ b/Interdependencies.md @@ -42,6 +42,8 @@ flowchart castor --> pollux castor --> prism-agent + pollux --> prism-agent + infrastructure test From b8159391e1643c7101a10d333385e0d20045cfab Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 17:07:14 +0000 Subject: [PATCH 6/8] fixes --- Interdependencies.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/Interdependencies.md b/Interdependencies.md index 7854a2d44c..7651659112 100644 --- a/Interdependencies.md +++ b/Interdependencies.md @@ -15,8 +15,7 @@ flowchart prism-node-1.4 -.copy proto files.-> prism-node subgraph BB[Building Blocks Interdependencies] - prism-node -.???\nMAYBE in the future.-> castor - prism-node -.???\nMAYBE in the future.-> pollux + pluto -.WIP.-> OR2{OR} pluto --> PLUTO-didcomm @@ -24,12 +23,20 @@ flowchart OR1 --> mercury OR2 --> castor + OR2 ----> iris subgraph REPO [BB Repository] - shared --> castor + prism-node -.???\nMAYBE in the future.-> pollux + prism-node --> castor + + iris -.IRIS client\nMAYBE in the future.-> prism-agent + iris --> iris-server + shared --> pollux + shared --> castor shared --> prism-agent shared --> connect + shared --> iris mercury --> pollux mercury --> connect @@ -38,13 +45,12 @@ flowchart connect --> prism-agent - castor --> iris castor --> pollux castor --> prism-agent + castor --> iris pollux --> prism-agent - infrastructure test end @@ -58,6 +64,7 @@ castor[Castor] connect infrastructure iris[IRIS] +iris-server((IRIS-server)) mercury[MERCURY] mediator((Mercury\nMediator)) pluto[PLUTO extrenal repo] From 6e4470cfcf06fe996547768f6d8f6184ce4d7eb7 Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Thu, 12 Jan 2023 17:10:21 +0000 Subject: [PATCH 7/8] iris and castor fixes --- Interdependencies.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Interdependencies.md b/Interdependencies.md index 7651659112..8bca17418d 100644 --- a/Interdependencies.md +++ b/Interdependencies.md @@ -22,19 +22,20 @@ flowchart OR1 --> mercury + OR2 ---> iris OR2 --> castor - OR2 ----> iris 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 --> prism-agent shared --> connect shared --> iris @@ -47,7 +48,7 @@ flowchart castor --> pollux castor --> prism-agent - castor --> iris + %%castor --> iris pollux --> prism-agent From 377f8ff1a64633a85c7f2a280458cbf156d4931c Mon Sep 17 00:00:00 2001 From: Fabio Pinheiro Date: Tue, 17 Jan 2023 13:19:09 +0000 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 033ef0d892..2d9ffc3c55 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@

- Contributing Guidelines ยท Blog + Contributing Guidelines