@peerbit/stream 4.0.5-0691c73 → 4.0.5-218a5bb

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -1
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,2 +1,12 @@
1
1
  # Direct stream
2
- Data streaming protocol that aggregates "hellos" and goodbye" from peers to build a route map, which is used with path-finding algorithms to find the shortest path to send data from A to B.
2
+ Data streaming protocol for delivering messages efficiently to peers with redundancy and failure recovery modes.
3
+
4
+ ## Features
5
+ - Packet prioritization. Data packages can be sent with different priority. That allows some traffic to pass through the traffic faster than other. This is useful in case of congestion
6
+ - Mode'd delivery. Packages can be sent with different delivery mode 'Acknowledge' (wait for acknowledgement from all known subscribers), 'Seek' (find new subscribers for a topic), 'Silent' (just deliver).
7
+ - Redundancy in data delivery. Data packages can be sent with different redundancy. This means that you can choose to send some packages only in one path (the fastest) or send a package in the 'N' fastest paths (this gives you a redundancy degree of 'N'). This feature is useful when you want to adapt delivery for unstable networks or when you want to make sure that some messages are delivered with high probability (without waiting for Acknowledgemts and retry)
8
+
9
+
10
+ Protocol specification (TODO)
11
+
12
+ Currently the protocol itself is not specificed more than as in this implementation with messages types found [here](https://github.com/dao-xyz/peerbit/blob/master/packages/transport/stream-interface/src/messages.ts) and [here](https://github.com/dao-xyz/peerbit/blob/aa577a5e5b2b4920662de5e0efb92fb97a5dc63c/packages/transport/stream/src/index.ts#L1057).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@peerbit/stream",
3
- "version": "4.0.5-0691c73",
3
+ "version": "4.0.5-218a5bb",
4
4
  "description": "A building block for direct streaming protocols",
5
5
  "sideEffects": false,
6
6
  "type": "module",
@@ -75,7 +75,7 @@
75
75
  "dao.xyz"
76
76
  ],
77
77
  "devDependencies": {
78
- "@peerbit/libp2p-test-utils": "2.1.3-0691c73",
78
+ "@peerbit/libp2p-test-utils": "2.1.3-218a5bb",
79
79
  "@types/yallist": "^4.0.4",
80
80
  "@types/fast-fifo": "^1.0.2"
81
81
  },
@@ -83,10 +83,10 @@
83
83
  "p-queue": "^8.0.1",
84
84
  "fast-fifo": "^1.3.2",
85
85
  "@dao-xyz/borsh": "^5.2.2",
86
- "@peerbit/cache": "2.0.6-0691c73",
87
- "@peerbit/crypto": "2.2.0-0691c73",
88
- "@peerbit/stream-interface": "5.0.2-0691c73",
89
- "@peerbit/logger": "1.0.2-0691c73",
86
+ "@peerbit/cache": "2.0.6-218a5bb",
87
+ "@peerbit/crypto": "2.2.0-218a5bb",
88
+ "@peerbit/stream-interface": "5.0.2-218a5bb",
89
+ "@peerbit/logger": "1.0.2-218a5bb",
90
90
  "libp2p": "^1.2.3",
91
91
  "yallist": "^4.0.0",
92
92
  "abortable-iterator": "^5.0.1"