git ssb - rebuild docs · wanderer🌟/bls-lib@22bf66e4

Commit 22bf66e454af3c3430bd9354d73620173cf52426

rebuild docs

Signed-off-by: wanderer <mjbecze@gmail.com>

wanderer committed on 10/8/2017, 3:43:07 AM
Parent: a3e23d92e4ac874e7df189be8a33cd3ee1222cf4

Files changed

docs/index.md

changed

docs/index.mdView
		@@ -12,8 +12,9 @@
12	12 …	- [signature](#signature)
13	13 …	- [free](#free)
14	14 …	- [freeArray](#freearray)
15	15 …	- [idSetInt](#idsetint)
	16 …	+- [idImportFromInt](#idimportfromint)
16	17 …	- [sign](#sign)
17	18 …	- [verify](#verify)
18	19 …	- [publicKeyExport](#publickeyexport)
19	20 …	- [secretKeyExport](#secretkeyexport)
		@@ -32,9 +33,9 @@
32	33 …	- [publicKeyShare](#publickeyshare)
33	34 …
34	35 …	## onModuleInit
35	36 …
36		-[index.js:13-20](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L13-L20 "Source code on GitHub")
	37 …	+[index.js:14-21](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L14-L21 "Source code on GitHub")
37	38 …
38	39 …	takes a callback that is called once the module is setup
39	40 …
40	41 …	Parameters
		@@ -42,27 +43,27 @@
42	43 …	- `cb`
43	44 …
44	45 …	## MCLBN_CURVE_FP254BNB
45	46 …
46		-[index.js:25-25](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L25-L25 "Source code on GitHub")
	47 …	+[index.js:26-26](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L26-L26 "Source code on GitHub")
47	48 …
48	49 …	the FP254BNB curve
49	50 …
50	51 …	## MCLBN_CURVE_FP382_1
51	52 …
52		-[index.js:30-30](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L30-L30 "Source code on GitHub")
	53 …	+[index.js:31-31](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L31-L31 "Source code on GitHub")
53	54 …
54	55 …	the FP382_1 curve
55	56 …
56	57 …	## MCLBN_CURVE_FP382_2
57	58 …
58		-[index.js:35-35](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L35-L35 "Source code on GitHub")
	59 …	+[index.js:36-36](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L36-L36 "Source code on GitHub")
59	60 …
60	61 …	the FP382_2 curve
61	62 …
62	63 …	## init
63	64 …
64		-[index.js:52-54](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L52-L54 "Source code on GitHub")
	65 …	+[index.js:53-55](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L53-L55 "Source code on GitHub")
65	66 …
66	67 …	intailizes the libary to use a given curve
67	68 …
68	69 …	Parameters
		@@ -70,33 +71,33 @@
70	71 …	- `curve` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the curves that can be used are MCLBN_CURVE_FP254BNB, MCLBN_CURVE_FP382_1 or MCLBN_CURVE_FP382_2 (optional, default `exports.MCLBN_CURVE_FP254BNB`)
71	72 …
72	73 …	## secretKey
73	74 …
74		-[index.js:60-62](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L60-L62 "Source code on GitHub")
	75 …	+[index.js:61-63](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L61-L63 "Source code on GitHub")
75	76 …
76	77 …	allocates a secret key
77	78 …
78	79 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
79	80 …
80	81 …	## publicKey
81	82 …
82		-[index.js:68-70](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L68-L70 "Source code on GitHub")
	83 …	+[index.js:69-71](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L69-L71 "Source code on GitHub")
83	84 …
84	85 …	allocates a secret key
85	86 …
86	87 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
87	88 …
88	89 …	## signature
89	90 …
90		-[index.js:76-78](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L76-L78 "Source code on GitHub")
	91 …	+[index.js:77-79](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L77-L79 "Source code on GitHub")
91	92 …
92	93 …	allocates a signature
93	94 …
94	95 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the signture
95	96 …
96	97 …	## free
97	98 …
98		-[index.js:83-85](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L83-L85 "Source code on GitHub")
	99 …	+[index.js:84-86](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L84-L86 "Source code on GitHub")
99	100 …
100	101 …	frees a pointer
101	102 …
102	103 …	Parameters
		@@ -104,9 +105,9 @@
104	105 …	- `x`
105	106 …
106	107 …	## freeArray
107	108 …
108		-[index.js:90-92](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L90-L92 "Source code on GitHub")
	109 …	+[index.js:91-93](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L91-L93 "Source code on GitHub")
109	110 …
110	111 …	frees an array of pointers
111	112 …
112	113 …	Parameters
		@@ -114,20 +115,32 @@
114	115 …	- `a`
115	116 …
116	117 …	## idSetInt
117	118 …
118		-[index.js:99-104](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L99-L104 "Source code on GitHub")
	119 …	+[index.js:100-105](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L100-L105 "Source code on GitHub")
119	120 …
120		-creates an ID to use in with threshold groups
	121 …	+creates an ID from an int to use in with threshold groups
121	122 …
122	123 …	Parameters
123	124 …
124	125 …	- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key, secret key stuct is used to hold the id
125	126 …	- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
126	127 …
	128 …	+## idImportFromInt
	129 …	+
	130 …	+[index.js:112-116](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L112-L116 "Source code on GitHub")
	131 …	+
	132 …	+creates an ID from an int and returns a pointer to it
	133 …	+
	134 …	+Parameters
	135 …	+
	136 …	+- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
	137 …	+
	138 …	+Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	139 …	+
127	140 …	## sign
128	141 …
129		-[index.js:112-112](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L112-L112 "Source code on GitHub")
	142 …	+[index.js:124-124](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L124-L124 "Source code on GitHub")
130	143 …
131	144 …	signs a message
132	145 …
133	146 …	Parameters
		@@ -137,9 +150,9 @@
137	150 …	- `msg` ([TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) \\| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)) the message to sign
138	151 …
139	152 …	## verify
140	153 …
141		-[index.js:120-120](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L120-L120 "Source code on GitHub")
	154 …	+[index.js:132-132](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L132-L132 "Source code on GitHub")
142	155 …
143	156 …	verifies a signature
144	157 …
145	158 …	Parameters
		@@ -149,9 +162,9 @@
149	162 …	- `msg` ([TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) \\| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)) the message that was signed
150	163 …
151	164 …	## publicKeyExport
152	165 …
153		-[index.js:127-127](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L127-L127 "Source code on GitHub")
	166 …	+[index.js:139-139](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L139-L139 "Source code on GitHub")
154	167 …
155	168 …	given a pointer to a public key this returns 64 byte Int8Array containing the key
156	169 …
157	170 …	Parameters
		@@ -161,9 +174,9 @@
161	174 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
162	175 …
163	176 …	## secretKeyExport
164	177 …
165		-[index.js:134-134](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L134-L134 "Source code on GitHub")
	178 …	+[index.js:146-146](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L146-L146 "Source code on GitHub")
166	179 …
167	180 …	given a pointer to a secret key this returns 32 byte Int8Array containing the key
168	181 …
169	182 …	Parameters
		@@ -173,9 +186,9 @@
173	186 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
174	187 …
175	188 …	## signatureExport
176	189 …
177		-[index.js:141-141](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L141-L141 "Source code on GitHub")
	190 …	+[index.js:153-153](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L153-L153 "Source code on GitHub")
178	191 …
179	192 …	given a pointer to a signature this returns 32 byte Int8Array containing the signature
180	193 …
181	194 …	Parameters
		@@ -185,9 +198,9 @@
185	198 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
186	199 …
187	200 …	## hashToSecretKey
188	201 …
189		-[index.js:148-148](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L148-L148 "Source code on GitHub")
	202 …	+[index.js:160-160](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L160-L160 "Source code on GitHub")
190	203 …
191	204 …	generates a secret key given a seed phrase.
192	205 …
193	206 …	Parameters
		@@ -196,9 +209,9 @@
196	209 …	- `seed` ([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)) the seed phrase
197	210 …
198	211 …	## secretKeyDeserialize
199	212 …
200		-[index.js:155-155](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L155-L155 "Source code on GitHub")
	213 …	+[index.js:167-167](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L167-L167 "Source code on GitHub")
201	214 …
202	215 …	write a secretKey to memory
203	216 …
204	217 …	Parameters
		@@ -207,9 +220,9 @@
207	220 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
208	221 …
209	222 …	## secretKeyImport
210	223 …
211		-[index.js:163-167](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L163-L167 "Source code on GitHub")
	224 …	+[index.js:175-179](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L175-L179 "Source code on GitHub")
212	225 …
213	226 …	write a secretKey to memory and returns a pointer to it
214	227 …
215	228 …	Parameters
		@@ -221,9 +234,9 @@
221	234 …	Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
222	235 …
223	236 …	## publicKeyDeserialize
224	237 …
225		-[index.js:174-174](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L174-L174 "Source code on GitHub")
	238 …	+[index.js:186-186](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L186-L186 "Source code on GitHub")
226	239 …
227	240 …	write a publicKey to memory
228	241 …
229	242 …	Parameters
		@@ -232,9 +245,9 @@
232	245 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
233	246 …
234	247 …	## publicKeyImport
235	248 …
236		-[index.js:181-185](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L181-L185 "Source code on GitHub")
	249 …	+[index.js:193-197](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L193-L197 "Source code on GitHub")
237	250 …
238	251 …	write a publicKey to memory and returns a pointer to it
239	252 …
240	253 …	Parameters
		@@ -245,9 +258,9 @@
245	258 …	Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
246	259 …
247	260 …	## signatureDeserialize
248	261 …
249		-[index.js:192-192](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L192-L192 "Source code on GitHub")
	262 …	+[index.js:204-204](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L204-L204 "Source code on GitHub")
250	263 …
251	264 …	write a signature to memory
252	265 …
253	266 …	Parameters
		@@ -256,9 +269,9 @@
256	269 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
257	270 …
258	271 …	## signatureImport
259	272 …
260		-[index.js:199-203](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L199-L203 "Source code on GitHub")
	273 …	+[index.js:211-215](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L211-L215 "Source code on GitHub")
261	274 …
WritePreview
262	275 …	write a signature to memory and returns a pointer to it
263	276 …
264	277 …	Parameters
		@@ -269,9 +282,9 @@
269	282 …	Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
270	283 …
271	284 …	## secretKeyRecover
272	285 …
273		-[index.js:211-211](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L211-L211 "Source code on GitHub")
	286 …	+[index.js:223-223](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L223-L223 "Source code on GitHub")
274	287 …
275	288 …	Recovers a secret key for a group given the groups secret keys shares and the groups ids
276	289 …
277	290 …	Parameters
		@@ -281,9 +294,9 @@
281	294 …	- `idArrah` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
282	295 …
283	296 …	## publicKeyRecover
284	297 …
285		-[index.js:219-219](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L219-L219 "Source code on GitHub")
	298 …	+[index.js:231-231](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L231-L231 "Source code on GitHub")
286	299 …
287	300 …	Recovers a public key for a group given the groups public keys shares and the groups ids
288	301 …
289	302 …	Parameters
		@@ -293,9 +306,9 @@
293	306 …	- `idArrah` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
294	307 …
295	308 …	## signatureRecover
296	309 …
297		-[index.js:227-227](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L227-L227 "Source code on GitHub")
	310 …	+[index.js:239-239](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L239-L239 "Source code on GitHub")
298	311 …
299	312 …	Recovers a signature for a group given the groups public keys shares and the groups ids
300	313 …
301	314 …	Parameters
		@@ -305,9 +318,9 @@
305	318 …	- `idArrah` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
306	319 …
307	320 …	## secretKeyShare
308	321 …
309		-[index.js:235-235](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L235-L235 "Source code on GitHub")
	322 …	+[index.js:247-247](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L247-L247 "Source code on GitHub")
310	323 …
311	324 …	Creates a secket key share for a group member given the groups members id (which is a the secret key) and array of master secret keys
312	325 …
313	326 …	Parameters
		@@ -317,9 +330,9 @@
317	330 …	- `id` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
318	331 …
319	332 …	## publicKeyShare
320	333 …
321		-[index.js:243-243](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L243-L243 "Source code on GitHub")
	334 …	+[index.js:255-255](https://github.com/wanderer/bls-lib/blob/63a2cdafe199f883855c63bd361a125a6b8b464a/index.js#L255-L255 "Source code on GitHub")
322	335 …
323	336 …	Creates a public key share for a group member given the groups members id (which is a the secret key) and array of master public keys
324	337 …
325	338 …	Parameters

Built with git-ssb-web

wanderer🌟 / bls-lib

Commit 22bf66e454af3c3430bd9354d73620173cf52426

rebuild docs

Files changed