orbit-core
Communication protocol on IPFS
Orbit is a serverless, distributed, p2p communication library and protocol that enables feed-based information sharing, such as real-time chat, in the IPFS peer-to-peer network.
This repository is the core library of Orbit. This library is intended to be used in your Node.js or Browser applications.
Used in the various Orbit projects:
- orbit-web - Orbit browser app
- orbit-electron - Orbit desktop app
- orbit-textui - Orbit terminal client
Usage
Install
npm install orbit_
Example
See examples/browser/index.html for a more detailed example.
/* NOTE! To run this example, you need to have an IPFS daemon running */
'use strict'
const IpfsApi = require('ipfs-api')
const Orbit = require('orbit_')
const ipfs = IpfsApi()
const orbit = new Orbit(ipfs)
const channel = 'HelloWorld'
orbit.events.on('connected', (network) => {
console.log(`-!- Connected to ${network.name}`)
orbit.join(channel)
})
orbit.events.on('joined', (channel) => {
orbit.send(channel, "/me is now caching this channel")
console.log(`-!- Joined #${channel}`)
})
// Listen for new messages
orbit.events.on('message', (channel, post) => {
console.log(`[${post.meta.ts}] < ${post.meta.from.name}> ${post.content}`)
})
// Connect to Orbit network
orbit.connect('Example Bot')
.catch((e) => logger.error(e))
API
See API documentation for full details.
Development
Install Dependencies
git clone https://github.com/haadcode/orbit-core.git
cd orbit-core/
npm install
Run Tests
npm test
Build Library and Distributables
npm run build
Library (ES5 for older browsers and Node.js) will be located in lib/
.
Distributable (ES5 minified for browsers) will be located in dist/
.