Refactor/cryptonote utils (#17)

* Change parse to be a static property

* First passthrough

* Change mutability of const -> let where needed

* Fix redundant type checks / global variables

* Reorg codebase + fix majority imports

* Add more types

* Add moment dep

* Add types to test

* More type err fixes

* Loop refactoring + more types

* Convert more errors to objects, fix more type errs, use functional constructs over loops

* Remove unused functions

* Add typescript dep

* Change string errors to obj

* Fix more tsc errors

* skirt around tsc errors for unimplemented bulletproofs

* Fix biginteger error

* Add ts-jest

* Fix rest of tsc errors, fix tests

Author: HenryNguyen5

.gitignore

@@ -3,4 +3,5 @@ node_modules/
 coverage
 .vscode
 yarn-error.log
-tests/fixtures
+tests/fixtures
+dist

tests/MG_sigs.spec.js renamed to __test__/MG_sigs.spec.ts

@@ -1,3 +1,13 @@
+import {
+	skGen,
+	ge_scalarmult_base,
+	identity,
+	ge_scalarmult,
+	hashToPoint,
+	MLSAG_Gen,
+	MLSAG_ver,
+} from "cryptonote_utils";
+
 // Copyright (c) 2014-2018, MyMonero.com
 //
 // All rights reserved.
@@ -26,21 +36,19 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../").monero_utils;
-
 it("MG_sigs", () => {
-	function skvGen(len) {
-		let skVec = [];
+	function skvGen(len: number) {
+		const skVec: string[] = [];
 		for (let i = 0; i < len; i++) {
-			skVec.push(monero_utils.skGen());
+			skVec.push(skGen());
 		}
 		return skVec;
 	}
 	//initializes a key matrix;
 	//first parameter is rows,
 	//second is columns
-	function keyMInit(rows, cols) {
-		let rv = [];
+	function keyMInit(cols: number) {
+		let rv: string[][] = [];
 		for (let i = 0; i < cols; i++) {
 			rv.push([]);
 		}
@@ -53,7 +61,7 @@ it("MG_sigs", () => {
 	let N = 3; // cols
 	let R = 2; // rows
 
-	let xm = keyMInit(R, N); // = [[None]*N] #just used to generate test public keys
+	let xm = keyMInit(N); // = [[None]*N] #just used to generate test public keys
 	let sk = skvGen(R);
 
 	// [
@@ -63,15 +71,15 @@ it("MG_sigs", () => {
 	// [pubkeyn, commitmentn]]
 	// // Gen creates a signature which proves that for some column in the keymatrix "pk"
 	//  the signer knows a secret key for each row in that column
-	let P = keyMInit(R, N); // = keyM[[None]*N] #stores the public keys;
+	let P = keyMInit(N); // = keyM[[None]*N] #stores the public keys;
 
 	let ind = 2;
 	let i = 0;
 
 	for (j = 0; j < R; j++) {
 		for (i = 0; i < N; i++) {
-			xm[i][j] = monero_utils.skGen();
-			P[i][j] = monero_utils.ge_scalarmult_base(xm[i][j]); // generate fake [pubkey, commit]
+			xm[i][j] = skGen();
+			P[i][j] = ge_scalarmult_base(xm[i][j]); // generate fake [pubkey, commit]
 		}
 	}
 
@@ -80,34 +88,27 @@ it("MG_sigs", () => {
 		sk[j] = xm[ind][j];
 	}
 
-	let message = monero_utils.identity();
-	let kimg = monero_utils.ge_scalarmult(
-		monero_utils.hashToPoint(P[ind][0]),
-		sk[0],
-	);
-	let rv = monero_utils.MLSAG_Gen(message, P, sk, kimg, ind);
-	let c = monero_utils.MLSAG_ver(message, P, rv, kimg);
+	let message = identity();
+	let kimg = ge_scalarmult(hashToPoint(P[ind][0]), sk[0]);
+	let rv = MLSAG_Gen(message, P, sk, kimg, ind);
+	let c = MLSAG_ver(message, P, rv, kimg);
 
 	expect(c).toEqual(true);
 
-	xtmp = skvGen(R);
-	xm = keyMInit(R, N); // = [[None]*N] #just used to generate test public keys
+	xm = keyMInit(N); // = [[None]*N] #just used to generate test public keys
 	sk = skvGen(R);
 
 	for (j = 0; j < R; j++) {
 		for (i = 0; i < N; i++) {
-			xm[i][j] = monero_utils.skGen();
-			P[i][j] = monero_utils.ge_scalarmult_base(xm[i][j]); // generate fake [pubkey, commit]
+			xm[i][j] = skGen();
+			P[i][j] = ge_scalarmult_base(xm[i][j]); // generate fake [pubkey, commit]
 		}
 	}
 
 	sk[1] = skGen(); //assume we don't know one of the private keys..
-	kimg = monero_utils.ge_scalarmult(
-		monero_utils.hashToPoint(P[ind][0]),
-		sk[0],
-	);
-	rv = monero_utils.MLSAG_Gen(message, P, sk, kimg, ind);
-	c = monero_utils.MLSAG_ver(message, P, rv, kimg);
+	kimg = ge_scalarmult(hashToPoint(P[ind][0]), sk[0]);
+	rv = MLSAG_Gen(message, P, sk, kimg, ind);
+	c = MLSAG_ver(message, P, rv, kimg);
 
 	expect(c).toEqual(false);
 });

tests/borromean/borromean_1.spec.js renamed to __test__/borromean/borromean_1.spec.ts

@@ -1,3 +1,6 @@
+import { generate_parameters } from "./test_parameters";
+import { genBorromean, verifyBorromean } from "cryptonote_utils";
+
 // Copyright (c) 2014-2018, MyMonero.com
 //
 // All rights reserved.
@@ -26,13 +29,11 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../../").monero_utils;
-const { generate_parameters } = require("./test_parameters");
 const { indi, P1v, P2v, xv, N } = generate_parameters();
 
 it("borromean_3", () => {
 	// #true one
-	const bb = monero_utils.genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
-	const valid = monero_utils.verifyBorromean(bb, P1v, P2v); /*?.*/
+	const bb = genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
+	const valid = verifyBorromean(bb, P1v, P2v); /*?.*/
 	expect(valid).toBe(true);
 });

tests/borromean/borromean_2.spec.js renamed to __test__/borromean/borromean_2.spec.ts

@@ -26,14 +26,14 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../../").monero_utils;
-const { generate_parameters } = require("./test_parameters");
+import { generate_parameters } from "./test_parameters";
+import { genBorromean, verifyBorromean } from "cryptonote_utils";
 const { indi, P1v, P2v, xv, N } = generate_parameters();
 
 it("borromean_2", () => {
 	//#false one
 	indi[3] = `${(+indi[3] + 1) % 2}`;
-	const bb = monero_utils.genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
-	const valid = monero_utils.verifyBorromean(bb, P1v, P2v); /*?.*/
+	const bb = genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
+	const valid = verifyBorromean(bb, P1v, P2v); /*?.*/
 	expect(valid).toBe(false);
 });

tests/borromean/borromean_3.spec.js renamed to __test__/borromean/borromean_3.spec.ts

@@ -26,16 +26,16 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../../").monero_utils;
-const { generate_parameters } = require("./test_parameters");
+import { generate_parameters } from "./test_parameters";
+import { genBorromean, verifyBorromean } from "cryptonote_utils";
 const { indi, P1v, P2v, xv, N } = generate_parameters();
 
 it("borromean_3", () => {
 	//#true one again
 	indi[3] = `${(+indi[3] + 1) % 2}`;
 	indi[3] = `${(+indi[3] + 1) % 2}`;
 
-	const bb = monero_utils.genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
-	const valid = monero_utils.verifyBorromean(bb, P1v, P2v); /*?.*/
+	const bb = genBorromean(xv, [P1v, P2v], indi, 2, N); /*?.*/
+	const valid = verifyBorromean(bb, P1v, P2v); /*?.*/
 	expect(valid).toBe(true);
 });

tests/borromean/borromean_4.spec.js renamed to __test__/borromean/borromean_4.spec.ts

@@ -1,3 +1,5 @@
+import { genBorromean, verifyBorromean } from "cryptonote_utils";
+
 // Copyright (c) 2014-2018, MyMonero.com
 //
 // All rights reserved.
@@ -26,13 +28,12 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../../").monero_utils;
-const { generate_parameters } = require("./test_parameters");
+import { generate_parameters } from "./test_parameters";
 const { indi, P1v, P2v, xv, N } = generate_parameters();
 
 it("borromean_4", () => {
 	// #false one
-	const bb = monero_utils.genBorromean(xv, [P2v, P1v], indi, 2, N); /*?.*/
-	const valid = monero_utils.verifyBorromean(bb, P1v, P2v); /*?.*/
+	const bb = genBorromean(xv, [P2v, P1v], indi, 2, N); /*?.*/
+	const valid = verifyBorromean(bb, P1v, P2v); /*?.*/
 	expect(valid).toBe(false);
 });

tests/borromean/test_parameters.js renamed to __test__/borromean/test_parameters.ts

@@ -26,36 +26,35 @@
 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-const monero_utils = require("../../").monero_utils;
-const { randomBytes } = require("crypto");
+import { randomBytes } from "crypto";
+import {
+	skGen,
+	ge_scalarmult_base,
+	ge_add,
+	ge_sub,
+	H2,
+} from "cryptonote_utils";
+import { padLeft } from "cryptonote_utils/formatters";
 
 function randomBit() {
 	// get random 8 bits in hex
 	const rand8bits = randomBytes(1).toString("hex");
 	// take 4 bits "nibble" and convert to binary
 	// then take last index
-	return monero_utils.padLeft(
-		parseInt(rand8bits[0], 16).toString(2),
-		4,
-		0,
-	)[3];
+	return padLeft(parseInt(rand8bits[0], 16).toString(2), 4, "0")[3];
 }
 
 //Tests for Borromean signatures
 //#boro true one, false one, C != sum Ci, and one out of the range..
 const N = 64;
-let xv = [], // vector of secret keys, 1 per ring (nrings)
-	P1v = [], //key64, arr of commitments Ci
-	P2v = [], //key64
-	indi = []; // vector of secret indexes, 1 per ring (nrings), can be a string
-
-let indi_2 = [];
-let indi_3 = [];
-let indi_4 = [];
+let xv: string[] = [], // vector of secret keys, 1 per ring (nrings)
+	P1v: string[] = [], //key64, arr of commitments Ci
+	P2v: string[] = [], //key64
+	indi: string[] = []; // vector of secret indexes, 1 per ring (nrings), can be a string
 
 let generated = false;
 
-function generate_parameters() {
+export function generate_parameters() {
 	if (generated) {
 		const indiCopy = [...indi];
 
@@ -64,20 +63,18 @@ function generate_parameters() {
 		for (let j = 0; j < N; j++) {
 			indi[j] = randomBit(); /*?.*/
 
-			xv[j] = monero_utils.skGen(); /*?.*/
+			xv[j] = skGen(); /*?.*/
 
 			if (+indi[j] === 0) {
-				P1v[j] = monero_utils.ge_scalarmult_base(xv[j]); /*?.*/
+				P1v[j] = ge_scalarmult_base(xv[j]); /*?.*/
 			} else {
-				P1v[j] = monero_utils.ge_scalarmult_base(xv[j]); // calculate aG = xv[j].G /*?.*/
-				P1v[j] = monero_utils.ge_add(P1v[j], monero_utils.H2[j]); // calculate aG + H2 /*?.*/
+				P1v[j] = ge_scalarmult_base(xv[j]); // calculate aG = xv[j].G /*?.*/
+				P1v[j] = ge_add(P1v[j], H2[j]); // calculate aG + H2 /*?.*/
 			}
 
-			P2v[j] = monero_utils.ge_sub(P1v[j], monero_utils.H2[j]); /*?.*/
+			P2v[j] = ge_sub(P1v[j], H2[j]); /*?.*/
 		}
 		generated = true;
 		return { xv, P1v, P2v, indi, N };
 	}
 }
-
-module.exports = { generate_parameters };