kosgrillis/hyperbeam

A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm

hyperbeam

A 1-1 end-to-end encrypted internet pipe powered by Hyperswarm and Noise

npm install hyperbeam

Usage

const Hyperbeam = require('hyperbeam')

// 'from mafintosh' should be a somewhat unique topic used to derive a discovery key.
// to find the other side of your pipe. it's seemed with a determistic timestamp from ~+-30min for better privacy
// once the other peer is discovered it is used to derive a noise keypair as well.
const beam = new Hyperbeam('from mafintosh')

// make a little chat app
process.stdin.pipe(beam).pipe(process.stdout)

CLI

Part of the Hyperspace CLI, hyp

Provided here as a standalone CLI as well.

First install it

npm install -g hyperbeam

Then on one machine run

echo 'hello world' | hyperbeam 'some topic'

Then on another

# will print "hello world"
hyperbeam 'some topic'

That's it! Happy piping.

API

const stream = new Hyperbeam(key)

Make a new Hyperbeam duplex stream.

Will auto connect to another peer making using the same key within ~30 min with an end to end encrypted tunnel.

When the other peer writes it's emitted as data on this stream.

Likewise when you write to this stream it's emitted as data on the other peers stream.

License

MIT