Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lmatteis/peer-tweet

Decentralized feeds using BitTorrent's DHT. Idea from Arvid and The_8472 "DHT RSS feeds" http://libtorrent.org/dht_rss.html
https://github.com/lmatteis/peer-tweet

Last synced: 9 days ago
JSON representation

Decentralized feeds using BitTorrent's DHT. Idea from Arvid and The_8472 "DHT RSS feeds" http://libtorrent.org/dht_rss.html

Awesome Lists containing this project

README 

        
# PeerTweet



> Decentralized feeds using BitTorrent's DHT. Idea from Arvid and The_8472 "DHT RSS feeds" http://libtorrent.org/dht_rss.html



## Screenshot



![PeerTweet](http://i.imgur.com/5vYZScZ.png)



## Quick links



* Download the latest binaries from the [releases page](https://github.com/lmatteis/peer-tweet/releases).

* Find and share PeerTweet addresses from the [addresses](https://github.com/lmatteis/peer-tweet/issues/9) issues page.



## What is PeerTweet?



BitTorrent's DHT is probably one of the most resilient and censorship-resistant networks on the internet. PeerTweet uses this network to allow users to broadcast *tweets* to anyone who is listening. When you start PeerTweet, it generates a hash `@33cwte8iwWn7uhtj9MKCs4q5Ax7B` which is similar to your Twitter username (ex. `@lmatteis`). The difference is that you have entire control over what can be posted because only you own the private key associated with such address. Furthermore, thanks to the DHT, what you post cannot be stopped by any government or institution.



Once you find other PeerTweet addresses you trust (and are not spam), you can follow them. This configures your client to store this user's tweets and broadcasts them to the DHT every once in a while to keep their feed alive. This cooperation of following accounts, allows for feeds to stay alive in the DHT network. The PeerTweet protocol also publishes your actions such as `I just followed @919c..` or `I just liked @9139..` and `I just retweeted @5789..`. This allows the possibility for new users to find other addresses they can trust; if I trust the user `@6749..` and they're following `@9801..`, then perhaps I can mark `@9801..` as not spam. This idea of publicly tweeting about your actions also allows for powerful future crawling analysis of this social graph.



## How does it work?



PeerTweet follows most of the implementation guidelines provided by the DHT RSS feed proposal http://libtorrent.org/dht_rss.html. We implemented it on top of the current [BEP44](http://bittorrent.org/beps/bep_0044.html) proposal which provides `get()` and `put()` functionality over the DHT network. This means that, rather than only using the DHT to announce which torrents one is currently downloading, we can use it to also put and get small amounts of data (roughly 1000 bytes).



PeerTweet differentiates between two types of items:



1. **Your feed head**. Which is the only mutable item of your feed, and is what your followers use to download your items and find updates. Your head's hash is what your followers use to know about updates - it's your identity and can be used to let others know about your feed (similar to your `@lmattes` handle). The feed head is roughly structured as follows:



  ```

  {

    "d": ,

    "next": ,

    "n": ,

    "a": ,

    "i": 

  }

  ```



2. **Your feed items**. These are immutable items which contain your actual tweets and are structured:



  ```

  {

    "d": ,

    "next": ,

    "t": 

  }

  ```



### Skip lists



The reason items have multiple pointers to other items in the list is to allow for parallel lookups. Our [skip list](https://en.wikipedia.org/wiki/Skip_list) implementation differs from regular implementations and is targeted for network lookups, where each item contains 4 pointers so that when we receive an item, we can issue 4 `get()` requests in parallel to other items in the list. This is crucial for accessing user's feeds in a timely manner because DHT lookups have unpredictable response times.



### Following



When you follow someone, you're essentially informing your client to download their feed and republish it every so often. The DHT network is not a persistent one, and items quickly drop out of the network after roughly 30 minutes. In order to keep things alive, having many followers is crucial for the uptime of your feed. Otherwise you can still have a server somewhere running 24/7 which keeps your feed alive by republishing items every 30 minutes.



# Install



Install dependencies.



```bash

$ npm install

```



## Installing native modules



The app comes with some native bindings. I used this code to make it run on my computer:



Source: https://github.com/atom/electron/blob/master/docs/tutorial/using-native-node-modules.md



```bash

npm install --save-dev electron-rebuild



# Every time you run "npm install", run this

./node_modules/.bin/electron-rebuild



# On Windows if you have trouble, try:

.\node_modules\.bin\electron-rebuild.cmd

```



To get `ed25519-supercop` to work on Windows I also had to install `node-gyp` and all the Python2.7 and Visual Studio stuff which node-gyp requires: https://github.com/nodejs/node-gyp



Then run these commands to build it on Windows:



```

npm install -g node-gyp

cd ./node_modules/ed25519-supercop/

HOME=~/.electron-gyp node-gyp rebuild --target=0.36.9 --arch=x64 --dist-url=https://atom.io/download/atom-shell

```



## Run



Run this two commands __simultaneously__ in different console tabs.



```bash

$ npm run hot-server

$ npm run start-hot

```



*Note: requires a node version >= 4 and an npm version >= 2.*



#### Toggle Chrome DevTools



- OS X: Cmd Alt I or F12

- Linux: Ctrl Shift I or F12

- Windows: Ctrl Shift I or F12



*See [electron-debug](https://github.com/sindresorhus/electron-debug) for more information.*



#### Toggle Redux DevTools



- All platforms: Ctrl+H



*See [redux-devtools-dock-monitor](https://github.com/gaearon/redux-devtools-dock-monitor) for more information.*



## Externals



If you use any 3rd party libraries which can't be built with webpack, you must list them in your `webpack.config.base.js`：



```javascript

externals: [

  // put your node 3rd party libraries which can't be built with webpack here (mysql, mongodb, and so on..)

]

```



You can find those lines in the file.



## CSS Modules support



Import css file as [css-modules](https://github.com/css-modules/css-modules) using `.module.css`.



## Package



```bash

$ npm run package

```



To package apps for all platforms:



```bash

$ npm run package-all

```



#### Options



- --name, -n: Application name (default: ElectronReact)

- --version, -v: Electron version (default: latest version)

- --asar, -a: [asar](https://github.com/atom/asar) support (default: false)

- --icon, -i: Application icon

- --all: pack for all platforms



Use `electron-packager` to pack your app with `--all` options for darwin (osx), linux and win32 (windows) platform. After build, you will find them in `release` folder. Otherwise, you will only find one for your os.



`test`, `tools`, `release` folder and devDependencies in `package.json` will be ignored by default.



#### Default Ignore modules



We add some module's `peerDependencies` to ignore option as default for application size reduction.



- `babel-core` is required by `babel-loader` and its size is ~19 MB

- `node-libs-browser` is required by `webpack` and its size is ~3MB.



> **Note:** If you want to use any above modules in runtime, for example: `require('babel/register')`, you should move them form `devDependencies` to `dependencies`.



#### Building windows apps from non-windows platforms



Please checkout [Building windows apps from non-windows platforms](https://github.com/maxogden/electron-packager#building-windows-apps-from-non-windows-platforms).



## Native-like UI



If you want to have native-like User Interface (OS X El Capitan and Windows 10), [react-desktop](https://github.com/gabrielbull/react-desktop) may perfect suit for you.



## Maintainers



This is a fork of the https://github.com/chentsulin/electron-react-boilerplate project.



## License

MIT