docs: add IPFS Architecture Diagram (#1673)

* docs: add IPFS Architecture Diagram * docs: apply review to arch diagram
ipfs · Dec 4, 2018 · 6f1381f · 6f1381f
1 parent d3345a5
commit 6f1381f
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -995,17 +995,19 @@ the metrics (in prometheus format) by making a GET request to the following endp
 http://localhost:5002/debug/metrics/prometheus
 ```
 
-### IPFS Core Architecture
+### IPFS Architecture
 
-![](/img/core.png)
+![](/img/architecture.png)
+
+[Annotated version](https://user-images.githubusercontent.com/1211152/47606420-b6265780-da13-11e8-923b-b365a8534e0e.png)j
 
 What does this image explain?
 
 - IPFS uses `ipfs-repo` which picks `fs` or `indexeddb` as its storage drivers, depending if it is running in Node.js or in the Browser.
 - The exchange protocol, `bitswap`, uses the Block Service which in turn uses the Repo, offering a get and put of blocks to the IPFS implementation.
 - The DAG API (previously Object) comes from the IPLD Resolver, it can support several IPLD Formats (i.e: dag-pb, dag-cbor, etc).
 - The Files API uses `ipfs-unixfs-engine` to import and export files to and from IPFS.
-- Swarm, the component that offers a network API, uses libp2p to dial and listen for connections, to use the DHT, for discovery mechanisms, and more. libp2p-ipfs-nodejs is used when running in Node.js and libp2p-ipfs-browser is used when running in the browser.
+- libp2p, the network stack of IPFS, uses libp2p to dial and listen for connections, to use the DHT, for discovery mechanisms, and more.
 
 ## Contribute
 

diff --git a/examples/README.md b/examples/README.md
@@ -32,7 +32,9 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 
 In this section, you will find explanations to different pieces of IPFS Architecture and how `js-ipfs` implements them.
 
-![](../img/core.png)
+![](../img/architecture.png)
+
+[Annotated version](https://user-images.githubusercontent.com/1211152/47606420-b6265780-da13-11e8-923b-b365a8534e0e.png)
 
 > These explanations are still a work in progress
 

diff --git a/img/architecture.monopic b/img/architecture.monopic
diff --git a/img/architecture.png b/img/architecture.png
diff --git a/img/architecture.txt b/img/architecture.txt
@@ -0,0 +1,64 @@
+ ┌─────────────────────────────────────────────────────────────────────────────┐
+ │                            The IPFS Architecture                            │
+ └─────────────────────────────────────────────────────────────────────────────┘
+               ┏━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━
+                  ======================= IPFS Daemon =======================  ┃
+               ┃                                                               ┃
+               ┃┌────┐ ┏ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━
+                │    │     ++++++++++++++++++ IPFS Core ++++++++++++++++++    ┃
+                │    │ ┃ ┌──────────────────────────────────────────────────┐
+                │HTTP│ ┌─│                  API (Core API)                  │ ┃┃
+               ┃│Gate│ │ ├──────┬──────┬──────┬──────┬──────┬───────┬───────┤  ┃
+               ┃│way │◀┤ │ Repo │Block │ DAG  │ Pin  │Files │       │Network│ ┃
+                │    │ │ └──────┴──────┴──────┴──────┴──────┘       └───────┘
+                │    │ │     │      │      │      │      │              │     ┃
+                │    │ │     │      │ ┌────┘      │ ┌────┘         ┌────┘      ┃
+               ┃└────┘ │  ┌──┘      │ │    ┌──────┘ │              ▼          ┃┃
+               ┃       │  │┌────────┘ │    ▼        ▼   ┌────────────────────┐
+                ┌────┐ │  ││          │┌───────┐┌──────┐│ libp2p             │┃
+                │    │ │  ││          ││Pinning││Unixfs││ (Network, PubSub,  │
+                │    │ │  ││          ││Service││Engine││ Swarm, Crypto)     │┃┃
+               ┃│    │ │  ││          │└───────┘└──────┘│┌──────────────────┐│ ┃
+               ┃│HTTP│ │  ││          │    │        │   ││Connection Manager││┃
+                │RPC │ │  ││          ├────┴────────┘   │└──────────────────┘│
+┌───┐┌────────┐ │API │◀┘  ││          │                 │┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ │┃
+│CLI││ipfs-api│ │    │ ┃  ││          │                 │  Peer Reputation  ││ ┃
+└───┘└────────┘┃│    │    ││          │                 │└ ─ ─ ─ ─ ─ ─ ─ ─ ─ │┃┃
+               ┃│    │ ┃  ││       ┌──┘                 └────────────────────┘
+                │    │    ││       │                   ┌ ─ ─ ─ ─ ┐┌ ─ ─ ─ ─ ─ ┃
+                └────┘ ┃  ││       │                    Providers      GC    │
+                          ││       ▼                   │ Service ││           ┃┃
+               ┃       ┃  ││┌─────────────┐             ─ ─ ─ ─ ─  ─ ─ ─ ─ ─ ┘ ┃
+               ┃          │││Graph Service│─────┬───────────┬───────────┐     ┃
+                       ┃  ││└─────────────┘     ▼           ▼           ▼
+                          ││       │      ┌ ─ ─ ─ ─ ─ ┌ ─ ─ ─ ─ ─ ┌ ─ ─ ─ ─ ─ ┃
+                       ┃  │└───────┤       GraphSync │ GraphSyncB│ GraphSyncC│ ┃
+               ┃          │        ▼      └ ─ ─ ─ ─ ─ └ ─ ─ ─ ─ ─ └ ─ ─ ─ ─ ─ ┃┃
+               ┃       ┃  │ ┌─────────────┐
+                          │ │Block Service│─────┬───────────┬───────────┐     ┃
+                       ┃  │ └─────────────┘     ▼           ▼           ▼
+                          │        │      ┌──────────┐┌ ─ ─ ─ ─ ─ ┌ ─ ─ ─ ─ ─ ┃┃
+               ┃       ┃  └─────┬──┴──────│ Bitswap  │  BitswapB │  BitswapB │ ┃
+               ┃                ▼         └──────────┘└ ─ ─ ─ ─ ─ └ ─ ─ ─ ─ ─ ┃
+                       ┃   ┌─────────┐
+                           │  Repo   │                                        ┃
+                       ┃   └─────────┘                                         ┃
+               ┃                │                                             ┃┃
+               ┃       ┃      ┌─┴──────┬──────────┬───────┐
+                              ▼        ▼          ▼       ▼                   ┃
+                       ┃   ┌────┐┌──────────┐┌────────┐┌────┐
+                           │ fs ││indexedDB ││LevelDB ││ S3 │                 ┃┃
+               ┃       ┃   └────┘└──────────┘└────────┘└────┘                  ┃
+               ┃                                                              ┃
+                       ┗ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━ ━
+                 ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━   ━━
+
+   ┌───────────────────────────────────────────────────────────────────────────┐
+   │ Legend                                                                    │
+   │ ┌ ─ ─ ┐                                                                   │
+   │         Planned, not yet implemented                                      │
+   │ └ ─ ─ ┘                                                                   │
+   │ ┌─────┐                                                                   │
+   │ │     │ Exist and shipped with IPFS                                       │
+   │ └─────┘                                                                   │
+   └───────────────────────────────────────────────────────────────────────────┘