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

scuttlebot invite plugin

Invite-token system, mainly used for pubs.

create: async

Create a new invite code.

create {n}
create(n, cb)

This produces an invite-code which encodes the sbot server's address, and a keypair seed. The keypair seed is used to generate a keypair, which is then used to authenticate a connection with the sbot server. The sbot server will then grant access to the use call.

accept: async

Use an invite code.

accept {invitecode}
accept(invitecode, cb)

This connects to the server address encoded in the invite-code, then calls use() on the server. It will cause the server to follow the local user.

addMe: async

Alias for accept.

use: async

Use an invite code created by this sbot instance (advanced function).

use --feed {feedid}
use({ feed: }, cb)

This commands the receiving server to follow the given feed.

An invite-code encodes the sbot server's address, and a keypair seed. The keypair seed must be used to generate a keypair, then authenticate a connection with the sbot server, in order to use this function.