https://github.com/toby/keyrun
Distributed content publication and scoring based on Bitcoin
https://github.com/toby/keyrun
bitcoin bittorrent content-management-system crypto cryptocurrency distributed magnet-link p2p
Last synced: 6 months ago
JSON representation
Distributed content publication and scoring based on Bitcoin
- Host: GitHub
- URL: https://github.com/toby/keyrun
- Owner: toby
- Created: 2019-03-31T21:11:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T21:11:50.000Z (over 6 years ago)
- Last Synced: 2025-02-12T09:59:13.739Z (8 months ago)
- Topics: bitcoin, bittorrent, content-management-system, crypto, cryptocurrency, distributed, magnet-link, p2p
- Language: Clojure
- Size: 60.5 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# key.run
## What is it?
Key.run is an open source, distributed content publication app built on
Bitcoin and BitTorrent. Users publish content pointers known as magnet
links to the blockchain using the key.run web interface and the Bitcoin Core
wallet. The links are then sorted by the total amount of Bitcoin each
magnet url has acquired in key.run transaction fees.
Since key.run uses the blockchain as its db and BitTorrent for content
storage, it operates without a centralized server and is designed to be
highly resistant to censorship or manipulation.
## Get running
The fastest way to use key.run is to visit http://key.run and start
downloading content with any BitTorrent client that supports magnet
links. We recommend [Transmission](http://www.transmissionbt.com).
Publishing content on key.run requires paying a small Bitcoin fee using
the official [Bitcoin Core](https://bitcoin.org/en/download) client
(additional wallet support coming soon).
To publish a magnet link, paste the full link url into the text field at
the top of key.run and click **Run**. This will open up Bitcoin Core and
load the transaction needed to publish your link.
Once you submit your payment using your wallet, your link will show up
on key.run.
## Scoring and content ranking
Magnet links contain a BTIH (BitTorrent info hash) that represents a
unique individual torrent file. BTIHs are distinct in the key.run db and
multiple attempts to publish the same BTIH will be aggregated. The total
value sent to publish a particular BTIH is used for ranking.
Currently content is ranked by total Bitcoin amount used to publish that
BTIH. In the future there will be more of a distinction between number
of transactions and total amount possibly including the ability to sort by each.
## Namespace keys
A namespace key is a Bitcoin address that is monitored for key.run
transactions. Messages published to one namespace will not be visible in
other namespaces.
When you start the key.run server you have to give it a namespace key.
The default key.run namespace is [2NUysE6fnJNhiUGJbWE2wP8T7AFCtRAVs4](bitcoin:1NUysE6fnJNhiUGJbWE2wP8T7AFCtRAVs4).
The server uses Bitcoin [SPV](https://bitcoin.org/en/developer-guide#simplified-payment-verification-spv)
and will only look for key.run transactions on that bitcoin address. All
key.run fees are sent to the namespace key.
## Transaction Fees
Key.run watches for transactions on a single namespace key per server
instance. Bitcoin sent in those transactions is collected by the namespace
owner. Fees are currently fixed at 10,000 Satoshi per transactions but will
eventually be variable (down to the smallest amount allowed in a Bitcoin
transaction).
By default, key.run operates with the namespace key [2NUysE6fnJNhiUGJbWE2wP8T7AFCtRAVs4](bitcoin:1NUysE6fnJNhiUGJbWE2wP8T7AFCtRAVs4).
Fees collected are used to help continue the development of key.run, so
please consider using the default namespace even on your own hosted servers.
You can also donate bitcoin directly to the namespace key if you would like
to support the project.
## Hosting your own key.run server
The http://key.run website is hosted as a reference instance of the
server but you are encouraged to download and host your own server.
Key.run is currently built in Clojure so you'll need the following
installed on your machine:
* [Java](https://www.java.com/en/download/)
* [Leiningen](http://leiningen.org)
You can then [download the key.run source](https://git.playgrub.com/toby/keyrun)
and run it with the command `lein run`.
You can also build the project as an uberjar and run it on any machine
that has Java installed (Leiningen isn't needed).
Once started, the key.run server will synchronize with the Bitcoin
network then be available for use. By default the web server runs on
port 9090.
## BIP-70 Payment Protocol
Key.run uses the [BIP-70](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki)
Payment Protocol to construct proper key.run transactions which are then
passed to the Bitcoin Core client. This means each client publishes
content directly to the Bitcoin network and no private keys are stored
on the key.run server.
## OP_RETURN
Bitcoin transactions can store 40 bytes of data using [OP_RETURN](http://bitzuma.com/posts/op-return-and-the-future-of-bitcoin/).
BitTorrent magnet links contain a 40 byte hash of a torrent file. That
hash is stored on the blockchain in the OP_RETURN output of the
transaction constructed by key.run.
## Future plans
Key.run is a nascent technology and is meant as a technology
demonstration. Future versions will resolve magnet link metadata, allow
for sub namespace creation and allow users to earn Bitcoin by splitting
fees with content publishers and sub namespace creators.
## Who did this?
Key.run is built by [Toby](http://twitter.com/toby). If you would like
to discuss the project there is a #keyrun channel on Freenode.