Home
SSBC
Patchwork
Social Messaging App
Scuttlebot
P2P Log Store
Documentation
APIs, Articles
Key Concepts
API Documentation
Articles

scuttlebot gossip plugin

Schedule connections randomly with a peerlist constructed from config, multicast UDP announcements, feed announcements, and API-calls.

peers: sync

Get the current peerlist.

peers
peers(cb)

add: sync

Add an address to the peer table.

add {addr}
add --host {string} --port {number} --key {feedid}
add(addr, cb)
add({ host:, port:, key: }, cb)

connect: async

Add an address to the peer table, and connect immediately.

connect {addr}
connect --host {string} --port {number} --key {feedid}
connect(addr, cb)
connect({ host:, port:, key: }, cb)

changes: source

Listen for gossip events.

changes
changes()

Events come in the following forms:

{ type: 'discover', peer:, source: }
{ type: 'connect', peer: }
{ type: 'connect-failure', peer: }
{ type: 'disconnect', peer: }