docs: add architecture graph

ipfs · Dec 10, 2016 · de99976 · de99976
1 parent e7835cb
commit de99976
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -142,31 +142,35 @@ Get stats about about the current state of the bitswap instance.
 
 ## Development
 
-### Code Structure
+### Structure
+
+![](/img/architecture.png)
 
 ```sh
 » tree src
 src
+├── components
+│   ├── decision
+│   │   ├── engine.js
+│   │   ├── index.js
+│   │   ├── ledger.js
+│   │   ├── peer-request-queue.js
+│   │   └── pq.js
+│   ├── network             # Handles peerSet and open new conns
+│   │   └── index.js
+│   └── want-manager        # Keeps track of all blocks the peer wants (not the others which it is connected)
+│       ├── index.js
+│       └── msg-queue.js    # Messages to send queue, one per peer
 ├── constants.js
-├── decision             #
-│   ├── engine.js
-│   ├── index.js
-│   ├── ledger.js
-│   ├── peer-request-queue.js
-│   └── pq.js
 ├── index.js
-├── message              # (Type) message that is put in the wire
-│   ├── entry.js
-│   ├── index.js
-│   └── message.proto.js
-├── network              # Handles peerSet and open new conns
-│   └── index.js
-├── wantlist             # (Type) track wanted blocks
-│   ├── entry.js
-│   └── index.js
-└── wantmanager          # Keeps track of all blocks the peer wants (not the others which it is connected)
-    ├── index.js
-    └── msg-queue.js
+└── types
+    ├── message             # (Type) message that is put in the wire
+    │   ├── entry.js
+    │   ├── index.js
+    │   └── message.proto.js
+    └── wantlist            # (Type) track wanted blocks
+        ├── entry.js
+        └── index.js
 ```
 
 ## Contribute

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,51 @@
+
+ ┌────────────────────────────────────────────────────────────────────────────┐
+ │                             Bitswap API                                    │
+ └────────────────────────────────────────────────────────────────────────────┘
+             │                                                  ▲              
+             │register wants                                    │yields the    
+             │and unwants                                       │received      
+             │                                                  │blocks        
+             │                                                  │              
+             │           send block to other nodes┌───────────────────────────┐
+             │           by adding them to their  │      Decision Engine      │
+             │           buckets                  │                           │
+             │                         ┌─────────◀├ ─ ─ ─                     │
+             │                         │          │Ledger│                    │
+             │                         │          └───────────────────────────┘
+             │                         │                                  ▲    
+             ▼                         │                                  │    
+  ┌────────────────────┐               │                                  │    
+  │                    │               │                                  │    
+  │    Want Manager    │               │                                  │    
+  │                    │               │                                  │    
+  ├───────────┬──┬─────┘               │                                  │    
+  │my wantlist│  │                     │                                  │    
+  └───────────┘  │update wantlist      │                                  │    
+                 │messages             │                  receive a block │    
+                 └─────┬───────┬───────┤                                  │    
+                       │       │       │                                  │    
+                       ▼       ▼       ▼                                  │    
+                   ┌───────┬───────┬───────┐                              │    
+                   │Message│Message│...    │                              │    
+                   │Queue/ │Queue/ │       │                              │    
+                   │peer   │peer   │       │                              │    
+                   └───────┴───────┴───────┘                              │    
+                       │       │       │                                  │    
+                       │       │       │                                  │    
+                       │       │       │                                  │    
+                       └───────┴───────┴─┐                                │    
+                                         │                                │    
+                                         │                                │    
+                                         ▼                                │    
+                                    ┌────────────────────────────────────────┐ 
+                                    │             Network                    │ 
+                                    └────────────────────────────────────────┘ 
+                                         │      ▲                 │  ▲         
+                                         ▼      │                 │  │         
+                                       ┌─────────┐                ▼  │         
+                                       │Transform│        /ipfs/bitswap/1.1.0  
+                                       └─────────┘                             
+                                         │      ▲                              
+                                         ▼      │                              
+                                     /ipfs/bitswap/1.0.0