git ssb - Merge pull request #7 from FloorLamp/fix-typos

Commit fd809fb0134868c1f4d481a16255753af43fe5f6

Merge pull request #7 from FloorLamp/fix-typos

fix various typos

wanderer authored on 2/2/2018, 10:17:04 PM
GitHub committed on 2/2/2018, 10:17:04 PM
Parent: 3c007f5ed0e57b38cc7df4239d9631d617eef1cc
Parent: 9b289e702feb8e028fc80ea5bf81b5040f1e5f8c

Files changed

README.md	changed
docs/index.md	changed
index.js	changed
package.json	changed

README.mdView
		@@ -2,9 +2,9 @@
2	2 …	[![Build Status](https://img.shields.io/travis/dfinity/js-bls-lib.svg?branch=master&style=flat-square)](https://travis-ci.org/dfinity/js-bls-lib)
3	3 …	[![Coverage Status](https://img.shields.io/coveralls/dfinity/js-bls-lib.svg?style=flat-square)](https://coveralls.io/r/dfinity/js-bls-lib)
4	4 …
5	5 …
6		-[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
	6 …	+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
7	7 …
8	8 …	# Synopsis
9	9 …
10	10 …	This libary provides primitives for creating and verifying [BLS threshold signatures](https://en.wikipedia.org/wiki/Boneh–Lynn–Shacham) in Webassembly with a JS API. All the hard work is done by [herumi/bls](https://github.com/herumi/bls). This wraps the bls C++ code which is compiled to Webassembly for easier use.
		@@ -44,19 +44,19 @@
44	44 …
45	45 …	# API
46	46 …	[./docs/](./docs/index.md)
47	47 …
48		-# Dependants
49		-* [verifible secret sharing](https://github.com/wanderer/vss)
50		-* [distributed key generation](https://github.com/wanderer/dkg)
	48 …	+# Dependents
	49 …	+* [verifiable secret sharing](https://github.com/dfinity/vss)
	50 …	+* [distributed key generation](https://github.com/dfinity/dkg)
51	51 …
52	52 …	# Building
53	53 …
54		-First install the dependancies [emscripten](https://github.com/kripken/emscripten) and [ninja](ninja-build.org)
	54 …	+First install the dependencies [emscripten](https://github.com/kripken/emscripten) and [ninja](ninja-build.org)
55	55 …
56	56 …	```
57		- git clone --recursive https://github.com/wanderer/bls-lib.git
58		- cd bls-lib/build
	57 …	+ git clone --recursive https://github.com/dfinity/js-bls-lib.git
	58 …	+ cd js-bls-lib/build
59	59 …	ninja
60	60 …	```
61	61 …
62	62 …	## License

docs/index.mdView
		@@ -40,391 +40,391 @@
40	40 …	- [dhKeyExchange](#dhkeyexchange)
41	41 …
42	42 …	## onModuleInit
43	43 …
44		-[index.js:14-21](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L14-L21 "Source code on GitHub")
	44 …	+[index.js:14-21](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L14-L21 "Source code on GitHub")
45	45 …
46		-takes a callback that is called once the module is setup
	46 …	+Takes a callback that is called once the module is setup
47	47 …
48	48 …	Parameters
49	49 …
50	50 …	- `cb`
51	51 …
52	52 …	## MCLBN_CURVE_FP254BNB
53	53 …
54		-[index.js:26-26](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L26-L26 "Source code on GitHub")
	54 …	+[index.js:26-26](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L26-L26 "Source code on GitHub")
55	55 …
56		-the FP254BNB curve
	56 …	+The FP254BNB curve
57	57 …
58	58 …	## MCLBN_CURVE_FP382_1
59	59 …
60		-[index.js:31-31](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L31-L31 "Source code on GitHub")
	60 …	+[index.js:31-31](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L31-L31 "Source code on GitHub")
61	61 …
62		-the FP382_1 curve
	62 …	+The FP382_1 curve
63	63 …
64	64 …	## MCLBN_CURVE_FP382_2
65	65 …
66		-[index.js:36-36](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L36-L36 "Source code on GitHub")
	66 …	+[index.js:36-36](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L36-L36 "Source code on GitHub")
67	67 …
68		-the FP382_2 curve
	68 …	+The FP382_2 curve
69	69 …
70	70 …	## init
71	71 …
72		-[index.js:49-51](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L49-L51 "Source code on GitHub")
	72 …	+[index.js:49-51](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L49-L51 "Source code on GitHub")
73	73 …
74		-intailizes the libary to use a given curve
	74 …	+Initializes the library to use a given curve
75	75 …
76	76 …	Parameters
77	77 …
78		-- `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`)
	78 …	+- `curve` [number](https://developer.mozilla.org/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`)
79	79 …
80	80 …	## secretKey
81	81 …
82		-[index.js:57-59](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L57-L59 "Source code on GitHub")
	82 …	+[index.js:57-59](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L57-L59 "Source code on GitHub")
83	83 …
84		-allocates a secret key
	84 …	+Allocates a secret key
85	85 …
86		-Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
	86 …	+Returns [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
87	87 …
88	88 …	## publicKey
89	89 …
90		-[index.js:65-67](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L65-L67 "Source code on GitHub")
	90 …	+[index.js:65-67](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L65-L67 "Source code on GitHub")
91	91 …
92		-allocates a secret key
	92 …	+Allocates a secret key
93	93 …
94		-Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
	94 …	+Returns [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the key
95	95 …
96	96 …	## signature
97	97 …
98		-[index.js:73-75](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L73-L75 "Source code on GitHub")
	98 …	+[index.js:73-75](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L73-L75 "Source code on GitHub")
99	99 …
100		-allocates a signature
	100 …	+Allocates a signature
101	101 …
102		-Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the signture
	102 …	+Returns [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) the pointer to the signature
103	103 …
104	104 …	## free
105	105 …
106		-[index.js:80-82](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L80-L82 "Source code on GitHub")
	106 …	+[index.js:80-82](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L80-L82 "Source code on GitHub")
107	107 …
108		-frees a pointer
	108 …	+Frees a pointer
109	109 …
110	110 …	Parameters
111	111 …
112	112 …	- `x`
113	113 …
114	114 …	## freeArray
115	115 …
116		-[index.js:87-89](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L87-L89 "Source code on GitHub")
	116 …	+[index.js:87-89](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L87-L89 "Source code on GitHub")
117	117 …
118		-frees an array of pointers
	118 …	+Frees an array of pointers
119	119 …
120	120 …	Parameters
121	121 …
122	122 …	- `a`
123	123 …
124	124 …	## idSetInt
125	125 …
126		-[index.js:96-101](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L96-L101 "Source code on GitHub")
	126 …	+[index.js:96-101](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L96-L101 "Source code on GitHub")
127	127 …
128		-creates an ID from an int to use in with threshold groups
	128 …	+Creates an ID from an int to use with threshold groups
129	129 …
130	130 …	Parameters
131	131 …
132		-- `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
133		-- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
	132 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key, secret key struct is used to hold the id
	133 …	+- `n` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a int representing the ID. n cannot be zero.
134	134 …
135	135 …	## idImportFromInt
136	136 …
137		-[index.js:108-112](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L108-L112 "Source code on GitHub")
	137 …	+[index.js:108-112](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L108-L112 "Source code on GitHub")
138	138 …
139		-creates an ID from an int and returns a pointer to it
	139 …	+Creates an ID from an int and returns a pointer to it
140	140 …
141	141 …	Parameters
142	142 …
143		-- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
	143 …	+- `n` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a int representing the ID. n cannot be zero.
144	144 …
145		-Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	145 …	+Returns [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
146	146 …
147	147 …	## idImport
148	148 …
149		-[index.js:119-127](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L119-L127 "Source code on GitHub")
	149 …	+[index.js:119-127](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L119-L127 "Source code on GitHub")
150	150 …
151		-creates an ID from an int and returns a pointer to it
	151 …	+Creates an ID from an int and returns a pointer to it
152	152 …
153	153 …	Parameters
154	154 …
155		-- `n` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a int repsenting the ID. n cannot be zero.
	155 …	+- `n` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a int representing the ID. n cannot be zero.
156	156 …
157		-Returns [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	157 …	+Returns [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
158	158 …
159	159 …	## sign
160	160 …
161		-[index.js:135-135](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L135-L135 "Source code on GitHub")
	161 …	+[index.js:135-135](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L135-L135 "Source code on GitHub")
162	162 …
163		-signs a message
	163 …	+Signs a message
164	164 …
165	165 …	Parameters
166	166 …
167		-- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the a signature
168		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
169		-- `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
	167 …	+- `sig` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the a signature
	168 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
	169 …	+- `msg` ([TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) \\| [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)) the message to sign
170	170 …
171	171 …	## verify
172	172 …
173		-[index.js:144-144](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L144-L144 "Source code on GitHub")
	173 …	+[index.js:144-144](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L144-L144 "Source code on GitHub")
174	174 …
175		-verifies a signature
	175 …	+Verifies a signature
176	176 …
177	177 …	Parameters
178	178 …
179		-- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the a signature
180		-- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
181		-- `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
	179 …	+- `sig` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the a signature
	180 …	+- `pk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
	181 …	+- `msg` ([TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) \\| [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)) the message that was signed
182	182 …
183		-Returns [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
	183 …	+Returns [Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
184	184 …
185	185 …	## publicKeyExport
186	186 …
187		-[index.js:151-151](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L151-L151 "Source code on GitHub")
	187 …	+[index.js:151-151](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L151-L151 "Source code on GitHub")
188	188 …
189		-given a pointer to a public key this returns 64 byte Int8Array containing the key
	189 …	+Given a pointer to a public key, this returns a 64 byte Int8Array containing the key
190	190 …
191	191 …	Parameters
192	192 …
193		-- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
	193 …	+- `pk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
194	194 …
195		-Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
	195 …	+Returns [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
196	196 …
197	197 …	## secretKeyExport
198	198 …
199		-[index.js:158-158](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L158-L158 "Source code on GitHub")
	199 …	+[index.js:158-158](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L158-L158 "Source code on GitHub")
200	200 …
201		-given a pointer to a secret key this returns 32 byte Int8Array containing the key
	201 …	+Given a pointer to a secret key, this returns a 32 byte Int8Array containing the key
202	202 …
203	203 …	Parameters
204	204 …
205		-- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
	205 …	+- `pk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
206	206 …
207		-Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
	207 …	+Returns [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
208	208 …
209	209 …	## signatureExport
210	210 …
211		-[index.js:165-165](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L165-L165 "Source code on GitHub")
	211 …	+[index.js:165-165](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L165-L165 "Source code on GitHub")
212	212 …
213		-given a pointer to a signature this returns 32 byte Int8Array containing the signature
	213 …	+Given a pointer to a signature, this returns a 32 byte Int8Array containing the signature
214	214 …
215	215 …	Parameters
216	216 …
217		-- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
	217 …	+- `pk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the secret key
218	218 …
219		-Returns [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
	219 …	+Returns [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)
220	220 …
221	221 …	## hashToSecretKey
222	222 …
223		-[index.js:172-172](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L172-L172 "Source code on GitHub")
	223 …	+[index.js:172-172](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L172-L172 "Source code on GitHub")
224	224 …
225		-generates a secret key given a seed phrase.
	225 …	+Generates a secret key given a seed phrase
226	226 …
227	227 …	Parameters
228	228 …
229		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
230		-- `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
	229 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	230 …	+- `seed` ([String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)) the seed phrase
231	231 …
232	232 …	## secretKeyDeserialize
233	233 …
234		-[index.js:179-179](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L179-L179 "Source code on GitHub")
	234 …	+[index.js:179-179](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L179-L179 "Source code on GitHub")
235	235 …
236		-write a secretKey to memory
	236 …	+Writes a secretKey to memory
237	237 …
238	238 …	Parameters
239	239 …
240		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
241		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
	240 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	241 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
242	242 …
243	243 …	## secretKeyImport
244	244 …
245		-[index.js:187-191](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L187-L191 "Source code on GitHub")
	245 …	+[index.js:187-191](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L187-L191 "Source code on GitHub")
246	246 …
247		-write a secretKey to memory and returns a pointer to it
	247 …	+Writes a secretKey to memory and returns a pointer to it
248	248 …
249	249 …	Parameters
250	250 …
251	251 …	- `buf`
252		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
253		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
	252 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	253 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 32 byte TypedArray
254	254 …
255		-Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	255 …	+Returns [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
256	256 …
257	257 …	## publicKeyDeserialize
258	258 …
259		-[index.js:198-198](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L198-L198 "Source code on GitHub")
	259 …	+[index.js:198-198](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L198-L198 "Source code on GitHub")
260	260 …
261		-write a publicKey to memory
	261 …	+Writes a publicKey to memory
262	262 …
263	263 …	Parameters
264	264 …
265		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
266		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
	265 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	266 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
267	267 …
268	268 …	## publicKeyImport
269	269 …
270		-[index.js:205-209](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L205-L209 "Source code on GitHub")
	270 …	+[index.js:205-209](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L205-L209 "Source code on GitHub")
271	271 …
272		-write a publicKey to memory and returns a pointer to it
	272 …	+Writes a publicKey to memory and returns a pointer to it
273	273 …
274	274 …	Parameters
275	275 …
276	276 …	- `buf`
277		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
	277 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a 64 byte TypedArray
278	278 …
279		-Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	279 …	+Returns [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
280	280 …
281	281 …	## signatureDeserialize
282	282 …
283		-[index.js:216-216](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L216-L216 "Source code on GitHub")
	283 …	+[index.js:216-216](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L216-L216 "Source code on GitHub")
284	284 …
285		-write a signature to memory
	285 …	+Writes a signature to memory
286	286 …
287	287 …	Parameters
288	288 …
289		-- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a signature
290		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
	289 …	+- `sig` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a signature
	290 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
291	291 …
292	292 …	## signatureImport
293	293 …
294		-[index.js:223-227](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L223-L227 "Source code on GitHub")
	294 …	+[index.js:223-227](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L223-L227 "Source code on GitHub")
295	295 …
296		-write a signature to memory and returns a pointer to it
	296 …	+Writes a signature to memory and returns a pointer to it
297	297 …
298	298 …	Parameters
299	299 …
300	300 …	- `buf`
301		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
	301 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the signature as a 32 byte TypedArray
302	302 …
303		-Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
	303 …	+Returns [Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
304	304 …
305	305 …	## secretKeySetByCSPRNG
306	306 …
307		-[index.js:233-233](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L233-L233 "Source code on GitHub")
	307 …	+[index.js:233-233](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L233-L233 "Source code on GitHub")
308	308 …
309		-Initialize a secret key by a Cryptographically Secure Pseudo Random Number Generator
	309 …	+Initializes a secret key by a Cryptographically Secure Pseudo Random Number Generator
310	310 …
311	311 …	Parameters
312	312 …
313		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a TypedArray
	313 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a TypedArray
314	314 …
315	315 …	## getPublicKey
316	316 …
317		-[index.js:240-240](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L240-L240 "Source code on GitHub")
	317 …	+[index.js:240-240](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L240-L240 "Source code on GitHub")
318	318 …
319		-Create a public key from the secret key
	319 …	+Creates a public key from the secret key
320	320 …
321	321 …	Parameters
322	322 …
323		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the public key as a TypedArray
324		-- `array` [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a TypedArray
	323 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the public key as a TypedArray
	324 …	+- `array` [TypedArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) the secret key as a TypedArray
325	325 …
326	326 …	## secretKeyRecover
327	327 …
328		-[index.js:248-248](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L248-L248 "Source code on GitHub")
	328 …	+[index.js:248-248](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L248-L248 "Source code on GitHub")
329	329 …
330	330 …	Recovers a secret key for a group given the groups secret keys shares and the groups ids
331	331 …
332	332 …	Parameters
333	333 …
334		-- `sk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
335		-- `sksArray` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to the groups secret key shares. The length of the array should be the threshold number for the group
336		-- `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
	334 …	+- `sk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
	335 …	+- `sksArray` [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to the groups secret key shares. The length of the array should be the threshold number for the group
	336 …	+- `idArrah` [Array](https://developer.mozilla.org/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
337	337 …
338	338 …	## publicKeyRecover
339	339 …
340		-[index.js:256-256](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L256-L256 "Source code on GitHub")
	340 …	+[index.js:256-256](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L256-L256 "Source code on GitHub")
341	341 …
342	342 …	Recovers a public key for a group given the groups public keys shares and the groups ids
343	343 …
344	344 …	Parameters
345	345 …
346		-- `pk` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key that will be generated
347		-- `pksArray` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to the groups public key shares. The length of the array should be the threshold number for the group
348		-- `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
	346 …	+- `pk` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key that will be generated
	347 …	+- `pksArray` [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to the groups public key shares. The length of the array should be the threshold number for the group
	348 …	+- `idArrah` [Array](https://developer.mozilla.org/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
349	349 …
350	350 …	## signatureRecover
351	351 …
352		-[index.js:264-264](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L264-L264 "Source code on GitHub")
	352 …	+[index.js:264-264](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L264-L264 "Source code on GitHub")
353	353 …
354	354 …	Recovers a signature for a group given the groups public keys shares and the groups ids
355	355 …
356	356 …	Parameters
357	357 …
358		-- `sig` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the signature that will be generated
359		-- `sigArray` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to signature shares. The length of the array should be the threshold number for the group
360		-- `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
	358 …	+- `sig` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to the signature that will be generated
	359 …	+- `sigArray` [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of pointers to signature shares. The length of the array should be the threshold number for the group
	360 …	+- `idArrah` [Array](https://developer.mozilla.org/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
361	361 …
362	362 …	## secretKeyShare
363	363 …
364		-[index.js:272-272](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L272-L272 "Source code on GitHub")
	364 …	+[index.js:272-272](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L272-L272 "Source code on GitHub")
365	365 …
366		-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
	366 …	+Creates a secret key share for a group member given the groups members id (which is the secret key) and array of master secret keys
367	367 …
368	368 …	Parameters
369	369 …
370		-- `skshare` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
371		-- `msk` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of master secret keys. The number of keys is the threshould of the group.
372		-- `id` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
	370 …	+- `skshare` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
	371 …	+- `msk` [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of master secret keys. The number of keys is the threshold of the group.
	372 …	+- `id` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
373	373 …
374	374 …	## publicKeyShare
375	375 …
376		-[index.js:280-280](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L280-L280 "Source code on GitHub")
	376 …	+[index.js:280-280](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L280-L280 "Source code on GitHub")
377	377 …
378	378 …	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
379	379 …
380	380 …	Parameters
381	381 …
382		-- `pkshare` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
383		-- `mpk` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of master public keys. The number of keys is the threshould of the group.
384		-- `id` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
	382 …	+- `pkshare` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key that will be generated
	383 …	+- `mpk` [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)> an array of master public keys. The number of keys is the threshold of the group.
	384 …	+- `id` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) the id of the member
385	385 …
386	386 …	## publicKeyAdd
387	387 …
388		-[index.js:287-287](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L287-L287 "Source code on GitHub")
	388 …	+[index.js:287-287](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L287-L287 "Source code on GitHub")
389	389 …
390		-Take two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2
	390 …	+Takes two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2
391	391 …
392	392 …	Parameters
393	393 …
394		-- `pubkey1` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
395		-- `pubkey2` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	394 …	+- `pubkey1` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	395 …	+- `pubkey2` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
396	396 …
397	397 …	## secretKeyAdd
398	398 …
399		-[index.js:294-294](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L294-L294 "Source code on GitHub")
	399 …	+[index.js:294-294](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L294-L294 "Source code on GitHub")
400	400 …
401		-Take two secretKeys and adds them together. seckey1 = seckey1 + seckey2
	401 …	+Takes two secretKeys and adds them together. seckey1 = seckey1 + seckey2
402	402 …
403	403 …	Parameters
404	404 …
405		-- `seckey1` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
406		-- `seckey2` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	405 …	+- `seckey1` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	406 …	+- `seckey2` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
407	407 …
408	408 …	## publicKeyIsEqual
409	409 …
410		-[index.js:302-302](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L302-L302 "Source code on GitHub")
	410 …	+[index.js:302-302](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L302-L302 "Source code on GitHub")
411	411 …
412		-Take two publicKeys and tests thier equality
	412 …	+Takes two publicKeys and tests their equality
413	413 …
414	414 …	Parameters
415	415 …
416		-- `pubkey1` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
417		-- `pubkey2` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	416 …	+- `pubkey1` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	417 …	+- `pubkey2` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
418	418 …	return {Boolean}
419	419 …
420	420 …	## dhKeyExchange
421	421 …
422		-[index.js:310-310](https://github.com/dfinity/bls-lib/blob/2b6104bd4d6a111c264a5b60ec590f39c84b3da0/index.js#L310-L310 "Source code on GitHub")
	422 …	+[index.js:310-310](https://github.com/dfinity/js-bls-lib/blob/3c007f5ed0e57b38cc7df4239d9631d617eef1cc/index.js#L310-L310 "Source code on GitHub")
423	423 …
424	424 …	Does Diffie–Hellman key exchange
425	425 …
426	426 …	Parameters
427	427 …
428		-- `sharedSecretKey` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secretKey that will be populated with the shared secret
429		-- `secretKey` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
430		-- `pubkey` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key
	428 …	+- `sharedSecretKey` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secretKey that will be populated with the shared secret
	429 …	+- `secretKey` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a secret key
	430 …	+- `pubkey` [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) a pointer to a public key

index.jsView
		@@ -7,10 +7,10 @@
7	7 …
8	8 …	exports.mod = mod
9	9 …
10	10 …	/**
11		- * takes a callback that is called once the module is setup
12		- * @params {Function} cb - the callback tobe called once the module is intailized
	11 …	+ * Takes a callback that is called once the module is setup
	12 …	+ * @params {Function} cb - the callback to be called once the module is initialized
13	13 …	*/
14	14 …	exports.onModuleInit = function (cb) {
15	15 …	if (init) {
16	16 …	cb()
		@@ -20,19 +20,19 @@
20	20 …	}
21	21 …	}
22	22 …
23	23 …	/**
24		- * the FP254BNB curve
	24 …	+ * The FP254BNB curve
25	25 …	*/
26	26 …	exports.MCLBN_CURVE_FP254BNB = 0
27	27 …
28	28 …	/**
29		- * the FP382_1 curve
	29 …	+ * The FP382_1 curve
30	30 …	*/
31	31 …	exports.MCLBN_CURVE_FP382_1 = 1
32	32 …
33	33 …	/**
34		- * the FP382_2 curve
	34 …	+ * The FP382_2 curve
35	35 …	*/
36	36 …	exports.MCLBN_CURVE_FP382_2 = 2
37	37 …
38	38 …	const MCLBN_FP_UNIT_SIZE = 6
		@@ -42,57 +42,57 @@
42	42 …	const G2_SIZE = FR_SIZE * 3 * 2
43	43 …
44	44 …	mod.onRuntimeInitialized = function () {
45	45 …	/**
46		- * intailizes the libary to use a given curve
	46 …	+ * Initializes the library to use a given curve
47	47 …	* @param {number} curve - the curves that can be used are MCLBN_CURVE_FP254BNB, MCLBN_CURVE_FP382_1 or MCLBN_CURVE_FP382_2
48	48 …	*/
49	49 …	exports.init = function (curve = exports.MCLBN_CURVE_FP254BNB) {
50	50 …	return mod._blsInit(curve, MCLBN_FP_UNIT_SIZE)
51	51 …	}
52	52 …
53	53 …	/**
54		- * allocates a secret key
	54 …	+ * Allocates a secret key
55	55 …	* @returns {number} the pointer to the key
56	56 …	*/
57	57 …	exports.secretKey = function () {
58	58 …	return mod._malloc(FR_SIZE)
59	59 …	}
60	60 …
61	61 …	/**
62		- * allocates a secret key
	62 …	+ * Allocates a secret key
63	63 …	* @returns {number} the pointer to the key
64	64 …	*/
65	65 …	exports.publicKey = function () {
66	66 …	return mod._malloc(G2_SIZE)
67	67 …	}
68	68 …
69	69 …	/**
70		- * allocates a signature
71		- * @returns {number} the pointer to the signture
	70 …	+ * Allocates a signature
	71 …	+ * @returns {number} the pointer to the signature
72	72 …	*/
73	73 …	exports.signature = function () {
74	74 …	return mod._malloc(G1_SIZE)
75	75 …	}
76	76 …
77	77 …	/**
78		- * frees a pointer
	78 …	+ * Frees a pointer
79	79 …	*/
80	80 …	exports.free = function (x) {
81	81 …	mod._free(x)
82	82 …	}
83	83 …
84	84 …	/**
85		- * frees an array of pointers
	85 …	+ * Frees an array of pointers
86	86 …	*/
87	87 …	exports.freeArray = function (a) {
88	88 …	a.forEach(el => mod._free(el))
89	89 …	}
90	90 …
91	91 …	/**
92		- * creates an ID from an int to use in with threshold groups
93		- * @param {number} sk - a pointer to the secret key, secret key stuct is used to hold the id
94		- * @param {number} n - a int repsenting the ID. n cannot be zero.
	92 …	+ * Creates an ID from an int to use with threshold groups
	93 …	+ * @param {number} sk - a pointer to the secret key, secret key struct is used to hold the id
	94 …	+ * @param {number} n - a int representing the ID. n cannot be zero.
95	95 …	*/
96	96 …	exports.idSetInt = function (sk, n) {
97	97 …	if (n === 0) {
98	98 …	throw new Error('id cannot be zero')
		@@ -100,10 +100,10 @@
100	100 …	mod._blsIdSetInt(sk, n)
101	101 …	}
102	102 …
103	103 …	/**
104		- * creates an ID from an int and returns a pointer to it
105		- * @param {number} n - a int repsenting the ID. n cannot be zero.
	104 …	+ * Creates an ID from an int and returns a pointer to it
	105 …	+ * @param {number} n - a int representing the ID. n cannot be zero.
106	106 …	* @return {number}
107	107 …	*/
108	108 …	exports.idImportFromInt = function (n) {
109	109 …	const sk = exports.secretKey()
		@@ -111,10 +111,10 @@
111	111 …	return sk
112	112 …	}
113	113 …
114	114 …	/**
115		- * creates an ID from an int and returns a pointer to it
116		- * @param {number} n - a int repsenting the ID. n cannot be zero.
	115 …	+ * Creates an ID from an int and returns a pointer to it
	116 …	+ * @param {number} n - a int representing the ID. n cannot be zero.
117	117 …	* @return {number}
118	118 …	*/
119	119 …	exports.idImport = function (n) {
120	120 …	if (Number.isInteger(n)) {
		@@ -126,61 +126,61 @@
126	126 …	}
127	127 …	}
128	128 …
129	129 …	/**
130		- * signs a message
	130 …	+ * Signs a message
131	131 …	* @param {number} sig - a pointer to the a signature
132	132 …	* @param {number} sk - a pointer to the secret key
133	133 …	* @param {TypedArray\|String} msg - the message to sign
134	134 …	*/
135	135 …	exports.sign = wrapInput(mod._blsSign)
136	136 …
137	137 …	/**
138		- * verifies a signature
	138 …	+ * Verifies a signature
139	139 …	* @param {number} sig - a pointer to the a signature
140	140 …	* @param {number} pk - a pointer to the secret key
141	141 …	* @param {TypedArray\|String} msg - the message that was signed
142	142 …	* @returns {Boolean}
143	143 …	*/
144	144 …	exports.verify = returnBool(wrapInput(mod._blsVerify))
145	145 …
146	146 …	/**
147		- * given a pointer to a public key this returns 64 byte Int8Array containing the key
	147 …	+ * Given a pointer to a public key, this returns a 64 byte Int8Array containing the key
148	148 …	* @param {number} pk - a pointer to the secret key
149	149 …	* @return {TypedArray}
150	150 …	*/
151	151 …	exports.publicKeyExport = wrapOutput(mod._blsPublicKeySerialize, 64)
152	152 …
153	153 …	/**
154		- * given a pointer to a secret key this returns 32 byte Int8Array containing the key
	154 …	+ * Given a pointer to a secret key, this returns a 32 byte Int8Array containing the key
155	155 …	* @param {number} pk - a pointer to the secret key
156	156 …	* @return {TypedArray}
157	157 …	*/
158	158 …	exports.secretKeyExport = wrapOutput(mod._blsSecretKeySerialize, 32)
159	159 …
160	160 …	/**
161		- * given a pointer to a signature this returns 32 byte Int8Array containing the signature
	161 …	+ * Given a pointer to a signature, this returns a 32 byte Int8Array containing the signature
162	162 …	* @param {number} pk - a pointer to the secret key
163	163 …	* @return {TypedArray}
164	164 …	*/
165	165 …	exports.signatureExport = wrapOutput(mod._blsSignatureSerialize, 32)
166	166 …
167	167 …	/**
168		- * generates a secret key given a seed phrase.
	168 …	+ * Generates a secret key given a seed phrase
169	169 …	* @param {number} sk - a pointer to a secret key
170	170 …	* @param {String\|TypedArray} seed - the seed phrase
171	171 …	*/
172	172 …	exports.hashToSecretKey = wrapInput(mod._blsHashToSecretKey)
173	173 …
174	174 …	/**
175		- * write a secretKey to memory
	175 …	+ * Writes a secretKey to memory
176	176 …	* @param {number} sk - a pointer to a secret key
177	177 …	* @param {TypedArray} array - the secret key as a 32 byte TypedArray
178	178 …	*/
179	179 …	exports.secretKeyDeserialize = wrapDeserialize(mod._blsSecretKeyDeserialize)
180	180 …
181	181 …	/**
182		- * write a secretKey to memory and returns a pointer to it
	182 …	+ * Writes a secretKey to memory and returns a pointer to it
183	183 …	* @param {number} sk - a pointer to a secret key
184	184 …	* @param {TypedArray} array - the secret key as a 32 byte TypedArray
185	185 …	* @return {Number}
186	186 …	*/
		@@ -190,16 +190,16 @@
190	190 …	return sk
191	191 …	}
192	192 …
193	193 …	/**
194		- * write a publicKey to memory
	194 …	+ * Writes a publicKey to memory
195	195 …	* @param {number} sk - a pointer to a public key
196	196 …	* @param {TypedArray} array - the secret key as a 64 byte TypedArray
197	197 …	*/
198	198 …	exports.publicKeyDeserialize = wrapDeserialize(mod._blsPublicKeyDeserialize)
199	199 …
200	200 …	/**
201		- * write a publicKey to memory and returns a pointer to it
	201 …	+ * Writes a publicKey to memory and returns a pointer to it
202	202 …	* @param {TypedArray} array - the secret key as a 64 byte TypedArray
203	203 …	* @return {Number}
204	204 …	*/
205	205 …	exports.publicKeyImport = function (buf) {
		@@ -208,16 +208,16 @@
208	208 …	return pk
209	209 …	}
210	210 …
211	211 …	/**
212		- * write a signature to memory
	212 …	+ * Writes a signature to memory
213	213 …	* @param {number} sig - a pointer to a signature
214	214 …	* @param {TypedArray} array - the signature as a 32 byte TypedArray
215	215 …	*/
216	216 …	exports.signatureDeserialize = wrapDeserialize(mod._blsSignatureDeserialize)
217	217 …
218	218 …	/**
219		- * write a signature to memory and returns a pointer to it
	219 …	+ * Writes a signature to memory and returns a pointer to it
220	220 …	* @param {TypedArray} array - the signature as a 32 byte TypedArray
221	221 …	* @return {Number}
222	222 …	*/
223	223 …	exports.signatureImport = function (buf) {
		@@ -226,15 +226,15 @@
226	226 …	return sig
227	227 …	}
228	228 …
229	229 …	/**
230		- * Initialize a secret key by a Cryptographically Secure Pseudo Random Number Generator
	230 …	+ * Initializes a secret key by a Cryptographically Secure Pseudo Random Number Generator
231	231 …	* @param {TypedArray} array - the secret key as a TypedArray
232	232 …	*/
233	233 …	exports.secretKeySetByCSPRNG = mod._blsSecretKeySetByCSPRNG
234	234 …
235	235 …	/**
WritePreview
236		- * Create a public key from the secret key
	236 …	+ * Creates a public key from the secret key
237	237 …	* @param {TypedArray} array - the public key as a TypedArray
238	238 …	* @param {TypedArray} array - the secret key as a TypedArray
239	239 …	*/
240	240 …	exports.getPublicKey = mod._blsGetPublicKey
		@@ -263,39 +263,39 @@
263	263 …	*/
264	264 …	exports.signatureRecover = wrapRecover(mod._blsSignatureRecover, G1_SIZE, ID_SIZE)
265	265 …
266	266 …	/**
267		- * 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
	267 …	+ * Creates a secret key share for a group member given the groups members id (which is the secret key) and array of master secret keys
268	268 …	* @param {number} skshare - a pointer to a secret key that will be generated
269		- * @param {Array<number>} msk - an array of master secret keys. The number of keys is the threshould of the group.
	269 …	+ * @param {Array<number>} msk - an array of master secret keys. The number of keys is the threshold of the group.
270	270 …	* @param {number} id - the id of the member
271	271 …	*/
272	272 …	exports.secretKeyShare = wrapKeyShare(mod._blsSecretKeyShare, FR_SIZE)
273	273 …
274	274 …	/**
275	275 …	* 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
276	276 …	* @param {number} pkshare - a pointer to a secret key that will be generated
277		- * @param {Array<number>} mpk - an array of master public keys. The number of keys is the threshould of the group.
	277 …	+ * @param {Array<number>} mpk - an array of master public keys. The number of keys is the threshold of the group.
278	278 …	* @param {number} id - the id of the member
279	279 …	*/
280	280 …	exports.publicKeyShare = wrapKeyShare(mod._blsPublicKeyShare, G2_SIZE)
281	281 …
282	282 …	/**
283		- * Take two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2
	283 …	+ * Takes two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2
284	284 …	* @param {number} pubkey1 - a pointer to a public key
285	285 …	* @param {number} pubkey2 - a pointer to a public key
286	286 …	*/
287	287 …	exports.publicKeyAdd = mod._blsPublicKeyAdd
288	288 …
289	289 …	/**
290		- * Take two secretKeys and adds them together. seckey1 = seckey1 + seckey2
	290 …	+ * Takes two secretKeys and adds them together. seckey1 = seckey1 + seckey2
291	291 …	* @param {number} seckey1 - a pointer to a secret key
292	292 …	* @param {number} seckey2 - a pointer to a secret key
293	293 …	*/
294	294 …	exports.secretKeyAdd = mod._blsSecretKeyAdd
295	295 …
296	296 …	/**
297		- * Take two publicKeys and tests thier equality
	297 …	+ * Takes two publicKeys and tests their equality
298	298 …	* @param {number} pubkey1 - a pointer to a public key
299	299 …	* @param {number} pubkey2 - a pointer to a public key
300	300 …	* return {Boolean}
301	301 …	*/

package.jsonView
		@@ -1,8 +1,8 @@
1	1 …	{
2	2 …	"name": "bls-lib",
3	3 …	"version": "0.3.1",
4		- "description": "this libary provides primitives for creating and verify BLS threshold signatures",
	4 …	+ "description": "this library provides primitives for creating and verifying BLS threshold signatures",
5	5 …	"main": "index.js",
6	6 …	"scripts": {
7	7 …	"coveralls": "npm run coverage && nyc report --reporter=text-lcov \| coveralls",
8	8 …	"coverage": "nyc npm test",

Built with git-ssb-web

wanderer🌟 / bls-lib

Commit fd809fb0134868c1f4d481a16255753af43fe5f6

Merge pull request #7 from FloorLamp/fix-typos

Files changed