ssbc/ssb-client

Name: ssb-client

Owner: Secure Scuttlebutt Consortium

Description: client library to scuttlebot

Created: 2015-03-04 02:20:56.0

Updated: 2018-03-12 16:19:40.0

Pushed: 2018-02-19 00:53:51.0

Homepage: null

Size: 53

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

ssb-client v2

Scuttlebot client.

Create an rpc connection to an sbot running locally.

example

ssbClient = require('ssb-client')

implest usage, connect to localhost sbot
his will cb with an error if an sbot server is not running
lient(function (err, sbot) {
 ...


onfiguration:
keys = ssbKeys.loadOrCreateSync('./app-private.key')
lient(
ys,                // optional, defaults to ~/.ssb/secret

host: 'localhost', // optional, defaults to localhost
port: 8008,        // optional, defaults to 8008
key: keys.id,      // optional, defaults to keys.id

caps: {
    // random string for `appKey` in secret-handshake
    shs: ''
},

// optional, muxrpc manifest. Defaults to ~/.ssb/manifest.json
manifest: {}       


nction (err, sbot, config) {
// ...

keys

See ssb-keys. The keys look like this:

id: String,
public: String,
private: String,
curve: 'ed25519'

caps

caps.shs is a random string passed to secret-handshake. It determines which sbot you are able to connect to. It defaults to a magic string in this repo and also in scuttlebot

appKey = new Buffer(opts.caps.shs, 'base64')

License

MIT, Copyright 2015 Paul Frazee and Dominic Tarr