git ssb - rebuild docs · wanderer🌟/bls-lib@402b1e3e

Commit 402b1e3e1a62fb7d66e18edddf8959874d853d03

rebuild docs

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

wanderer committed on 10/7/2017, 6:01:13 AM
Parent: 410c677aaa8a9f8c0a2a117b9d72c7df060bd4bb

Files changed

docs/index.md

changed

docs/index.mdView
		@@ -10,27 +10,31 @@
10	10 …	- [secretKey](#secretkey)
11	11 …	- [publicKey](#publickey)
12	12 …	- [signature](#signature)
13	13 …	- [free](#free)
	14 …	+- [freeArray](#freearray)
14	15 …	- [idSetInt](#idsetint)
15	16 …	- [sign](#sign)
16	17 …	- [verify](#verify)
17		-- [publicKeySerialize](#publickeyserialize)
18		-- [secretKeySerialize](#secretkeyserialize)
19		-- [signatureSerialize](#signatureserialize)
	18 …	+- [publicKeyExport](#publickeyexport)
	19 …	+- [secretKeyExport](#secretkeyexport)
	20 …	+- [signatureExport](#signatureexport)
20	21 …	- [hashToSecretKey](#hashtosecretkey)
21	22 …	- [secretKeyDeserialize](#secretkeydeserialize)
	23 …	+- [secretKeyImport](#secretkeyimport)
22	24 …	- [publicKeyDeserialize](#publickeydeserialize)
	25 …	+- [publicKeyImport](#publickeyimport)
23	26 …	- [signatureDeserialize](#signaturedeserialize)
	27 …	+- [signatureImport](#signatureimport)
24	28 …	- [secretKeyRecover](#secretkeyrecover)
25	29 …	- [publicKeyRecover](#publickeyrecover)
26	30 …	- [signatureRecover](#signaturerecover)
27	31 …	- [secretKeyShare](#secretkeyshare)
28	32 …	- [publicKeyShare](#publickeyshare)
29	33 …
30	34 …	## onModuleInit
31	35 …
32		-[index.js:13-20](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L13-L20 "Source code on GitHub")
	36 …	+[index.js:13-20](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L13-L20 "Source code on GitHub")
33	37 …
34	38 …	takes a callback that is called once the module is setup
35	39 …
36	40 …	Parameters
		@@ -38,27 +42,27 @@
38	42 …	- `cb`
39	43 …
40	44 …	## MCLBN_CURVE_FP254BNB
41	45 …
42		-[index.js:25-25](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L25-L25 "Source code on GitHub")
	46 …	+[index.js:25-25](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L25-L25 "Source code on GitHub")
43	47 …
44	48 …	the FP254BNB curve
45	49 …
46	50 …	## MCLBN_CURVE_FP382_1
47	51 …
48		-[index.js:30-30](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L30-L30 "Source code on GitHub")
	52 …	+[index.js:30-30](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L30-L30 "Source code on GitHub")
49	53 …
50	54 …	the FP382_1 curve
51	55 …
52	56 …	## MCLBN_CURVE_FP382_2
53	57 …
54		-[index.js:35-35](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L35-L35 "Source code on GitHub")
	58 …	+[index.js:35-35](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L35-L35 "Source code on GitHub")
55	59 …
56	60 …	the FP382_2 curve
57	61 …
58	62 …	## init
59	63 …
60		-[index.js:52-54](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L52-L54 "Source code on GitHub")
	64 …	+[index.js:52-54](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L52-L54 "Source code on GitHub")
61	65 …
62	66 …	intailizes the libary to use a given curve
63	67 …
64	68 …	Parameters
		@@ -66,43 +70,53 @@
66	70 …	- `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`)
67	71 …
68	72 …	## secretKey
69	73 …
70		-[index.js:60-62](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L60-L62 "Source code on GitHub")
	74 …	+[index.js:60-62](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L60-L62 "Source code on GitHub")
71	75 …
72	76 …	allocates a secret key
73	77 …
74	78 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
75	79 …
76	80 …	## publicKey
77	81 …
78		-[index.js:68-70](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L68-L70 "Source code on GitHub")
	82 …	+[index.js:68-70](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L68-L70 "Source code on GitHub")
79	83 …
80	84 …	allocates a secret key
81	85 …
82	86 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
83	87 …
84	88 …	## signature
85	89 …
86		-[index.js:76-78](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L76-L78 "Source code on GitHub")
	90 …	+[index.js:76-78](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L76-L78 "Source code on GitHub")
87	91 …
88	92 …	allocates a signature
89	93 …
90	94 …	Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the signture
91	95 …
92	96 …	## free
93	97 …
94		-[index.js:83-85](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L83-L85 "Source code on GitHub")
	98 …	+[index.js:83-85](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L83-L85 "Source code on GitHub")
95	99 …
96	100 …	frees a pointer
97	101 …
98	102 …	Parameters
99	103 …
100	104 …	- `x`
101	105 …
	106 …	+## freeArray
	107 …	+
	108 …	+[index.js:90-92](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L90-L92 "Source code on GitHub")
	109 …	+
	110 …	+frees an array of pointers
	111 …	+
	112 …	+Parameters
	113 …	+
	114 …	+- `a`
	115 …	+
102	116 …	## idSetInt
103	117 …
104		-[index.js:92-97](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L92-L97 "Source code on GitHub")
	118 …	+[index.js:99-104](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L99-L104 "Source code on GitHub")
105	119 …
106	120 …	creates an ID to use in with threshold groups
107	121 …
108	122 …	Parameters
		@@ -111,9 +125,9 @@
111	125 …	- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
112	126 …
113	127 …	## sign
114	128 …
115		-[index.js:105-105](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L105-L105 "Source code on GitHub")
	129 …	+[index.js:112-112](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L112-L112 "Source code on GitHub")
116	130 …
117	131 …	signs a message
118	132 …
119	133 …	Parameters
		@@ -123,9 +137,9 @@
123	137 …	- `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
124	138 …
125	139 …	## verify
126	140 …
127		-[index.js:113-113](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L113-L113 "Source code on GitHub")
	141 …	+[index.js:120-120](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L120-L120 "Source code on GitHub")
128	142 …
129	143 …	verifies a signature
130	144 …
131	145 …	Parameters
		@@ -133,11 +147,11 @@
133	147 …	- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the a signature
134	148 …	- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
135	149 …	- `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
136	150 …
137		-## publicKeySerialize
	151 …	+## publicKeyExport
138	152 …
139		-[index.js:120-120](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L120-L120 "Source code on GitHub")
	153 …	+[index.js:127-127](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L127-L127 "Source code on GitHub")
140	154 …
141	155 …	given a pointer to a public key this returns 64 byte Int8Array containing the key
142	156 …
143	157 …	Parameters
		@@ -145,11 +159,11 @@
145	159 …	- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
146	160 …
147	161 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
148	162 …
149		-## secretKeySerialize
	163 …	+## secretKeyExport
150	164 …
151		-[index.js:127-127](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L127-L127 "Source code on GitHub")
	165 …	+[index.js:134-134](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L134-L134 "Source code on GitHub")
152	166 …
153	167 …	given a pointer to a secret key this returns 32 byte Int8Array containing the key
154	168 …
155	169 …	Parameters
		@@ -157,11 +171,11 @@
157	171 …	- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
158	172 …
159	173 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
160	174 …
161		-## signatureSerialize
	175 …	+## signatureExport
162	176 …
163		-[index.js:134-134](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L134-L134 "Source code on GitHub")
	177 …	+[index.js:141-141](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L141-L141 "Source code on GitHub")
164	178 …
165	179 …	given a pointer to a signature this returns 32 byte Int8Array containing the signature
166	180 …
167	181 …	Parameters
		@@ -171,9 +185,9 @@
171	185 …	Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
172	186 …
173	187 …	## hashToSecretKey
174	188 …
175		-[index.js:141-141](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L141-L141 "Source code on GitHub")
	189 …	+[index.js:148-148](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L148-L148 "Source code on GitHub")
176	190 …
177	191 …	generates a secret key given a seed phrase.
178	192 …
179	193 …	Parameters
		@@ -182,42 +196,82 @@
182	196 …	- `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
183	197 …
184	198 …	## secretKeyDeserialize
185	199 …
186		-[index.js:148-148](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L148-L148 "Source code on GitHub")
	200 …	+[index.js:155-155](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L155-L155 "Source code on GitHub")
187	201 …
188	202 …	write a secretKey to memory
189	203 …
190	204 …	Parameters
191	205 …
192	206 …	- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
193	207 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
194	208 …
	209 …	+## secretKeyImport
	210 …	+
	211 …	+[index.js:163-167](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L163-L167 "Source code on GitHub")
	212 …	+
	213 …	+write a secretKey to memory and returns a pointer to it
	214 …	+
	215 …	+Parameters
	216 …	+
	217 …	+- `buf`
	218 …	+- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	219 …	+- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
	220 …	+
	221 …	+Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	222 …	+
195	223 …	## publicKeyDeserialize
196	224 …
197		-[index.js:155-155](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L155-L155 "Source code on GitHub")
	225 …	+[index.js:174-174](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L174-L174 "Source code on GitHub")
198	226 …
199	227 …	write a publicKey to memory
200	228 …
201	229 …	Parameters
202	230 …
203		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	231 …	+- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
204	232 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
205	233 …
	234 …	+## publicKeyImport
	235 …	+
	236 …	+[index.js:181-185](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L181-L185 "Source code on GitHub")
	237 …	+
	238 …	+write a publicKey to memory and returns a pointer to it
	239 …	+
	240 …	+Parameters
	241 …	+
	242 …	+- `buf`
	243 …	+- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
	244 …	+
	245 …	+Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	246 …	+
206	247 …	## signatureDeserialize
207	248 …
208		-[index.js:162-162](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L162-L162 "Source code on GitHub")
	249 …	+[index.js:192-192](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L192-L192 "Source code on GitHub")
209	250 …
210	251 …	write a signature to memory
211	252 …
212	253 …	Parameters
213	254 …
214	255 …	- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a signature
215	256 …	- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
216	257 …
	258 …	+## signatureImport
	259 …	+
	260 …	+[index.js:199-203](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L199-L203 "Source code on GitHub")
	261 …	+
	262 …	+write a signature to memory and returns a pointer to it
	263 …	+
	264 …	+Parameters
	265 …	+
	266 …	+- `buf`
	267 …	+- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
	268 …	+
	269 …	+Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	270 …	+
217	271 …	## secretKeyRecover
218	272 …
219		-[index.js:170-170](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L170-L170 "Source code on GitHub")
	273 …	+[index.js:211-211](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L211-L211 "Source code on GitHub")
220	274 …
221	275 …	Recovers a secret key for a group given the groups secret keys shares and the groups ids
222	276 …
223	277 …	Parameters
		@@ -227,9 +281,9 @@
227	281 …	- `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
228	282 …
229	283 …	## publicKeyRecover
230	284 …
231		-[index.js:178-178](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L178-L178 "Source code on GitHub")
	285 …	+[index.js:219-219](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L219-L219 "Source code on GitHub")
232	286 …
233	287 …	Recovers a public key for a group given the groups public keys shares and the groups ids
234	288 …
235	289 …	Parameters
		@@ -239,9 +293,9 @@
239	293 …	- `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
240	294 …
WritePreview
241	295 …	## signatureRecover
242	296 …
243		-[index.js:186-186](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L186-L186 "Source code on GitHub")
	297 …	+[index.js:227-227](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L227-L227 "Source code on GitHub")
244	298 …
245	299 …	Recovers a signature for a group given the groups public keys shares and the groups ids
246	300 …
247	301 …	Parameters
		@@ -251,9 +305,9 @@
251	305 …	- `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
252	306 …
253	307 …	## secretKeyShare
254	308 …
255		-[index.js:194-194](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L194-L194 "Source code on GitHub")
	309 …	+[index.js:235-235](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L235-L235 "Source code on GitHub")
256	310 …
257	311 …	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
258	312 …
259	313 …	Parameters
		@@ -263,9 +317,9 @@
263	317 …	- `id` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
264	318 …
265	319 …	## publicKeyShare
266	320 …
267		-[index.js:202-202](https://github.com/wanderer/bls-lib/blob/29702674041ace08d16a5600105230669f208404/index.js#L202-L202 "Source code on GitHub")
	321 …	+[index.js:243-243](https://github.com/wanderer/bls-lib/blob/0e97e39f3b15ac41e2d87017b73dcad5b6950276/index.js#L243-L243 "Source code on GitHub")
268	322 …
269	323 …	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
270	324 …
271	325 …	Parameters

Built with git-ssb-web

wanderer🌟 / bls-lib

Commit 402b1e3e1a62fb7d66e18edddf8959874d853d03

rebuild docs

Files changed