git ssb

1
2
module.exports = {
3
  description: 'invite peers to your ssb network',
4
  commands: {
5
    create: {
6
      type: 'async',
7
      description: 'create an invitation',
8
      args: {
9
        id: {
10
          type: 'FeedId',
11
          description: 'feed identity to create invite from, defaults to your main identity',
12
          optional: true
13
        },
14
        private: {
15
          type: "Any",
16
          description: 'message to be encrypted to guest',
17
          optional: true,
18
        },
19
        reveal: {
20
          type: "Any",
21
          description: 'message to be encrypted to guest, and also publically revealed on invite acceptance',
22
          optional: true
23
        }
24
25
      }
26
    },
27
    getNearbyPubs: {
28
      type: 'async',
29
      descryption: 'get a list of nearby pubs that are willing to receive peer invites for you. if this does not return anything, no one will be able to accept your messages. Used internally by `ssb-peer-invites`',
30
      args: {
31
        hops: {
32
          type: 'number',
33
          description: 'number of hops away pubs are still considered "nearby", default is 2',
34
          optional: true
35
        }
36
      }
37
    },
38
    openInvite: {
39
      type: 'async',
40
      description: 'retrive an invitation, and decrypt any private messages inside it',
41
      args: {
42
        invite: {
43
          type: "PeerInvite",
44
          descryption: 'a peer invite as returned by peerInvites.create',
45
          optional: false
46
        }
47
      }
48
    },
49
    acceptInvite: {
50
      type: 'async',
51
      description: 'accept an invitation, including revealing publically any information in the reveal portion of the invitation. (see peerInvites.openInvite)',
52
      args: {
53
        invite: {
54
          type: "PeerInvite",
55
          descryption: 'a peer invite as returned by peerInvites.create',
56
          optional: false
57
        }
58
      }
59
    }
60
  }
61
}
62
63
64
65
66
67
68
69
70
71