-
Notifications
You must be signed in to change notification settings - Fork 1
/
help.js
44 lines (39 loc) · 1.16 KB
/
help.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
module.exports = {
description: 'advertise an publically reachable address for an ssb device',
commands: {
getAddress: {
description: 'get the announced address for a given peer, if known',
args: {
id: {
type: 'FeedId', description: 'an ssb feed identity',
optional: false
}
}
},
announce: {
description: 'announce an address for your device',
args: {
availability: {
type: 'number',
description: 'availability as decimal between 0 and 1. estimate of probability a peer can connect, defaults to 0.3',
optional: true
},
scope: {
type: 'string',
description: 'the address scope to announce, normally this would be "public"',
optional: true
},
recps: {
type: "Array<FeedId>",
description: 'feeds this address announcement should be encrypted to',
optional: true
},
address: {
type: "MultiServerAddress",
description: 'a multiserver address, either "scope" or "address" must be set',
optional: true
}
}
}
}
}