Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
webrtc-explorer
Advanced tools
webrtc-explorer - npm Package Compare versions
Comparing version 1.0.0 to 1.0.3
| { | ||
| "name": "webrtc-explorer", | ||
| "version": "1.0.0", | ||
| "version": "1.0.3", | ||
| "description": "Chord inspired ring DHT algorithm using WebRTC as transport layer for P2P in the browser", | ||
@@ -5,0 +5,0 @@ "main": "src/index.js", |
@@ -1,64 +0,55 @@ | ||
| webrtc-ring | ||
| webrtc-explorer | ||
| ======================================= | ||
| **tl;dr** ring inspired ring DHT algorithm using WebRTC as transport layer for P2P in the browser. You can find more about how it works underneath at [HOW_DOES_IT_WORK](/HOW_DOES_IT_WORD.md) | ||
| **tl;dr** `webrtc-explorer` is a [Chord][chord-paper] inspired P2P overlay network designed for the Web platform (browsers), using WebRTC as its transport between peers and WebSockets for Signaling data. Essentially, it enables your peers (browsers) to communicate between each other without the need to have a server as a mediator of messages. | ||
| It enables you to communicate between several browsers in a p2p/decentralized fashion though a DHT. | ||
| # Badgers | ||
| [](https://nodei.co/npm/webrtc-ring/) | ||
| [](https://nodei.co/npm/webrtc-explorer/) | ||
| [](https://gitter.im/diasdavid/webrtc-ring?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
| [](https://david-dm.org/diasdavid/webrtc-ring) | ||
| [](https://gitter.im/diasdavid/webrtc-explorer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
| [](https://david-dm.org/diasdavid/webrtc-explorer) | ||
| # How to create a node | ||
| # Properties | ||
| webrtc-ring uses [browserify](http://browserify.org/) | ||
| - Ids have 48 bits (so that is a multiple of 4 (for hex notation) and doesn't require importing a big-num lib to handle over 53 bits operations) | ||
| - The number of fingers of each peer is flexible, however it is recommended to not pass 16 per node (due to browser resource constraints) | ||
| - Each peer is responsible for a segment of the hash ring | ||
| ``` | ||
| var ring = require('webrtc-ring'); | ||
| # Usage | ||
| var nodeConfig = { | ||
| signalingURL: 'http://url-to-webrtc-ring-signaling-server.com' | ||
| }; | ||
| var node = ring.createNode(nodeConfig); | ||
| `webrtc-explorer` uses [browserify](http://browserify.org) | ||
| node.e.on('ready', function () { | ||
| // this node is ready | ||
| }); | ||
| ``` | ||
| ## Create a new peer | ||
| # How to communicate with other nodes | ||
| ``` | ||
| var Explorer = require('webrtc-explorer'); | ||
| Send a message to a Node responsible for the ID `1af17e73721dbe0c40011b82ed4bb1a7dbe3ce29` | ||
| var config = { | ||
| signalingURL: 'http://url-to-webrtc-ring-signaling-server.com' | ||
| }; | ||
| var peer = new Explorer(config); | ||
| ``` | ||
| var toId = '1af17e73721dbe0c40011b82ed4bb1a7dbe3ce29'; | ||
| // 160 bit ID represented in hex(`git_sha1` module is a good way to generate these) | ||
| peer.events.on('ready', function () { | ||
| // this node is ready | ||
| }); | ||
| ``` | ||
| node.send(destID: toId, | ||
| data: 'hey, how are you doing'); | ||
| ``` | ||
| ## Register the peer | ||
| Send a message to this node sucessor (next node in ring) | ||
| ``` | ||
| ``` | ||
| ``` | ||
| node.sendSucessor(data: 'hey, how are you doing'); | ||
| ``` | ||
| ## Send and receive a message | ||
| Receive a message | ||
| ``` | ||
| node.e.on('message', function(message) { | ||
| console.log(message); | ||
| }); | ||
| ``` | ||
| ``` | ||
| ``` | ||
| # Other options | ||
| ## Other options | ||
| ## logging | ||
| ### logging | ||
| add the logging flag to your nodeConfig | ||
| add the logging flag to your config | ||
| ``` | ||
| var nodeConfig = { | ||
| var config = { | ||
| //... | ||
@@ -68,2 +59,17 @@ logging: true | ||
| }; | ||
| ``` | ||
| ``` | ||
| # How does it work | ||
| Read the CHORD paper | ||
| Some important learnings that are part of webrtc-explorer, were done in webrtc-ring | ||
| http://blog.daviddias.me/2014/12/20/webrtc-ring | ||
| ## Registering a peer | ||
| ## Updating the finger table | ||
| ## Signaling between two peers | ||
| ## Message routing | ||
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by10.29%
75
Worsened metrics
- Total package byte prevSize
- decreased by-2.35%
21837
- Number of package files
- decreased by-7.14%
13
No dependency changes