UNPKG

wiki-plugin-allyabase

Version:

Allyabase plugin for the federated wiki

github.com/planet-nine-app/wiki-plugin-contract

planet-nine-app/wiki-plugin-contract

166 lines (108 loc) • 8.97 kB
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# Federated Wiki - allyabase plugin allyabase is a Backend as a Service (BaaS) similar to Firebase and Supabase except it is open, and interoperable with other systems that utilize the [Sessionless] protocol. allyabase has many features, but the few that are exposed at this time in wiki are enable the signing of smart contracts, and the subsequent creation and/or transfer of nineum tokens upon completed parameters from the contracts. To facilitate this, the plugin exposes the following routes to the client: <details> <summary><code>GET</code> <code><b>/plugin/allyabase/user/:pubKey</b></code> <code>Gets an existing user by public key</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | pubKey | true | string (hex) | the publicKey of the user's keypair | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>GET</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Gets the user's BDO</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | pubKey | true | string (hex) | the publicKey of the user's keypair | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>PUT</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Puts a new bdo or updates the bdo for the user</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | pubKey | true | string (hex) | the publicKey of the user's keypair | > | bdo | true | object | the signature from sessionless for the message | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>POST</code> <code><b>/plugin/allyabase/grant-nineum</b></code> <code>grants a nineum to a user. Requires the wiki owner to have an admin or galactic nineum</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | toUUID | true | string (hex) | the uuid of the user to grant the nineum | > | flavor | true | string (hex) | the flavor of nineum to grant | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>POST</code> <code><b>/plugin/allyabase/grant-admin-nineum</b></code> <code>grants an admin nineum to a user</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | toUUID | true | string (hex) | the uuid of the user to grant the nineum | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>POST</code> <code><b>/plugin/allyabase/transfer</b></code> <code>transfer nineum to another user</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | toUUID | true | string (hex) | the uuid of the user to grant the nineum | > | nineum | true | array of nineum hex strings | the nineum to transfer | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>GET</code> <code><b>/plugin/allyabase/sign/:thing</b></code> <code>creates a signature from the thing to sign</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | thing | true | string | the uuid of the user to grant the nineum | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `{signature: <signature>}` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> <details> <summary><code>GET</code> <code><b>/plugin/allyabase/verify</b></code> <code>verifies a signature</code></summary> ##### Parameters > | name | required | data type | description | > |--------------|-----------|-------------------------|-----------------------------------------------------------------------| > | signature | true | string (hex) | the signature to verify | > | message | true | string | the message to check | ##### Responses > | http code | content-type | response | > |---------------|-----------------------------------|---------------------------------------------------------------------| > | `200` | `application/json` | `USER` | > | `400` | `application/json` | `{"code":"400","message":"Bad Request"}` | </details> ## License MIT [Sessionless]: https://github.com/planet-nine-app/sessionless