Removed regtest-dev-tools.ts.

Added startParamCheck, dummyRandomSeed, shuffle & isFunction methods to utils/helpers.ts.
Implemented startParamCheck in start method in lightning-manager.ts

Author: coreyphillips

src/lightning-manager.ts

@@ -37,8 +37,11 @@ import {
 	DefaultTransactionDataShape,
 	TTransactionData,
 } from './utils/types';
-import { dummyRandomSeed } from './utils/regtest-dev-tools';
-import { getDefaultLdkStorageShape } from './utils/helpers';
+import {
+	dummyRandomSeed,
+	getDefaultLdkStorageShape,
+	startParamCheck,
+} from './utils/helpers';
 
 //TODO startup steps
 // Step 0: Listen for events ✅
@@ -199,18 +202,28 @@ class LightningManager {
 		if (!getTransactionData) {
 			return err('getTransactionData is not set in start method.');
 		}
+
+		// Ensure the start params function as expected.
+		const paramCheckResponse = await startParamCheck({
+			seed,
+			genesisHash,
+			getBestBlock,
+			getItem,
+			setItem,
+			getTransactionData,
+			network,
+		});
+		if (paramCheckResponse.isErr()) {
+			return err(paramCheckResponse.error.message);
+		}
+
 		this.getBestBlock = getBestBlock;
 		this.seed = seed;
 		this.network = network;
 		this.setItem = setItem;
 		this.getItem = getItem;
 		this.getTransactionData = getTransactionData;
 		const bestBlock = await this.getBestBlock();
-		if (!bestBlock?.hash || !bestBlock?.hex || !bestBlock?.height) {
-			return err(
-				'The getBestBlock method is not providing the appropriate block hex, hash or height.',
-			);
-		}
 		this.currentBlock = bestBlock;
 
 		const ldkData = await this.getLdkData();

src/utils/helpers.ts

@@ -1,4 +1,10 @@
-import { DefaultLdkDataShape, TLdkStorage } from './types';
+import {
+	DefaultLdkDataShape,
+	ENetworks,
+	TLdkStart,
+	TLdkStorage,
+} from './types';
+import { err, ok, Result } from './result';
 
 /**
  * Convert string to bytes
@@ -90,3 +96,155 @@ export const getDefaultLdkStorageShape = (seed: string): TLdkStorage => {
 		[seed]: DefaultLdkDataShape,
 	};
 };
+
+/**
+ * This method runs a check on each parameter passed to the start method
+ * to ensure that they are providing the expected data.
+ * @param {string} seed
+ * @param {string} genesisHash
+ * @param {TGetBestBlock} getBestBlock
+ * @param {TStorage} getItem
+ * @param {TStorage} setItem
+ * @param {TGetTransactionData} getTransactionData
+ * @param {ENetworks} network
+ * @returns {Promise<Result<string>>}
+ */
+export const startParamCheck = async ({
+	seed,
+	genesisHash,
+	getBestBlock,
+	getItem,
+	setItem,
+	getTransactionData,
+	network = ENetworks.regtest,
+}: TLdkStart): Promise<Result<string>> => {
+	try {
+		// Test Network
+		if (typeof network !== 'string') {
+			return err('network must be a string.');
+		}
+		if (
+			!(
+				network === ENetworks.mainnet ||
+				network === ENetworks.testnet ||
+				network === ENetworks.regtest
+			)
+		) {
+			return err(
+				`The provided network (${network}) is invalid. It must be either '${ENetworks.mainnet}', '${ENetworks.testnet}' or '${ENetworks.regtest}'.`,
+			);
+		}
+
+		// Test seed
+		if (typeof seed !== 'string') {
+			return err('seed must be a string.');
+		}
+
+		// Test genesisHash
+		if (typeof genesisHash !== 'string') {
+			return err('genesisHash must be a string.');
+		}
+		if (typeof genesisHash !== 'string') {
+			return err('genesisHash must be a string.');
+		}
+
+		// Test getBestBlock
+		if (!isFunction(getBestBlock)) {
+			return err('getBestBlock must be a function.');
+		}
+		const bestBlock = await getBestBlock();
+		if (!bestBlock?.hex || !bestBlock.height || !bestBlock.hash) {
+			return err('getBestBlock is not providing the expected data.}');
+		}
+
+		// Test setItem & getItem
+		if (!isFunction(setItem)) {
+			return err('setItem must be a function.');
+		}
+		if (!isFunction(getItem)) {
+			return err('getItem must be a function.');
+		}
+		const rand = Math.random().toString();
+		await setItem('ldkstoragetest', rand);
+		const getTest = await getItem('ldkstoragetest');
+		if (getTest !== rand) {
+			return err('setItem & getItem are not able to access storage.');
+		}
+
+		// Test getTransactionData
+		if (!isFunction(getTransactionData)) {
+			return err('getTransactionData must be a function.');
+		}
+		// Test getTransactionData response if using mainnet or testnet.
+		if (network !== ENetworks.regtest) {
+			const expectedData = {
+				[ENetworks.mainnet]: {
+					txid: 'f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16',
+					data: {
+						header:
+							'01000000696aa63f0f22d9189c8536bb83b18737ae8336c25a67937f79957e5600000000982db9870a5e30d8f0b2a4ebccc5852b5a1e2413e9274c4947bfec6bdaa9b9d75bb76a49ffff001d2b719fdd',
+						height: 170,
+						transaction:
+							'0100000001c997a5e56e104102fa209c6a852dd90660a20b2d9c352423edce25857fcd3704000000004847304402204e45e16932b8af514961a1d3a1a25fdf3f4f7732e9d624c6c61548ab5fb8cd410220181522ec8eca07de4860a4acdd12909d831cc56cbbac4622082221a8768d1d0901ffffffff0200ca9a3b00000000434104ae1a62fe09c5f51b13905f07f06b99a2f7159b2225f374cd378d71302fa28414e7aab37397f554a7df5f142c21c1b7303b8a0626f1baded5c72a704f7e6cd84cac00286bee0000000043410411db93e1dcdb8a016b49840f8c53bc1eb68a382e97b1482ecad7b148a6909a5cb2e0eaddfb84ccf9744464f82e160bfa9b8b64f9d4c03f999b8643f656b412a3ac00000000',
+					},
+				},
+				[ENetworks.testnet]: {
+					txid: '3757bc9ac72b4aba0babe9c5ee94373c6b8c675766b7c188af4c5e75068b78e3',
+					data: {
+						header:
+							'0100000098fbe05200b867e000286338ee405f70ce4362f54769db2bc9d919db0000000078b787d3d8da61dce5a9fe4d4a9232e804021e439906e6fd52cf8f041f948b3d919d4a4dffff001d05774a61',
+						height: 420,
+						transaction:
+							'0100000001d604a444f1b98c382cb0557c4972d2d0050e19a570f0c9592a8afd40e6eea450000000006a47304402205df0be0956dcd01ab514a6965faabe6a0202289ef9ca16a60fb17612ba23598902202c877276bb12e5c7e27f377e926bebe3afa6629c1785a732a26df4322a83eae7012102219f426bcf9151bb514807f6c1796361a6abf6e094a2e75da0ed91f587c07b37ffffffff02302f1526010000001976a9145c7f849d51b5708ec29d38fdce2e995da069e01588ac5dfd01000000000017a914c925e02c0560da5d9cd263481347b025b8f196f48700000000',
+					},
+				},
+			};
+			const transactionData = await getTransactionData(
+				expectedData[network].txid,
+			);
+			if (
+				JSON.stringify(transactionData) !==
+				JSON.stringify(expectedData[network].data)
+			) {
+				return err('getTransactionData is not returning the expected data.');
+			}
+		}
+		return ok('Params passed all checks.');
+	} catch (e) {
+		return err(e);
+	}
+};
+
+const isFunction = (f: any): boolean => {
+	try {
+		return f && {}.toString.call(f) === '[object Function]';
+	} catch {
+		return false;
+	}
+};
+
+const shuffle = (array: string[]): string[] => {
+	let currentIndex = array.length,
+		randomIndex;
+	while (currentIndex !== 0) {
+		randomIndex = Math.floor(Math.random() * currentIndex);
+		currentIndex--;
+		[array[currentIndex], array[randomIndex]] = [
+			array[randomIndex],
+			array[currentIndex],
+		];
+	}
+
+	return array;
+};
+
+export const dummyRandomSeed = (): string => {
+	if (!__DEV__) {
+		throw new Error('Use random bytes instead of dummyRandomSeed');
+	}
+
+	const bytes =
+		'8a bd ac 77 55 2a 6e a6 0a 47 2f bf 6c d8 d5 af b4 78 19 96 a4 d2 e2 81 7c ae 6e 2b 38 ae 56 fd';
+
+	return shuffle(bytes.split(' ')).join('');
+};