beignet 0.0.21 → 0.0.23

package/docs/markdown/interfaces/IWalletData.md

@@ -14,7 +14,6 @@
 - [boostedTransactions](IWalletData.md#boostedtransactions)
 - [changeAddressIndex](IWalletData.md#changeaddressindex)
 - [changeAddresses](IWalletData.md#changeaddresses)
-- [exchangeRates](IWalletData.md#exchangerates)
 - [feeEstimates](IWalletData.md#feeestimates)
 - [header](IWalletData.md#header)
 - [id](IWalletData.md#id)
@@ -34,7 +33,7 @@
 
 #### Defined in
 
-[types/wallet.ts:155](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L155)
+[types/wallet.ts:158](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L158)
 
 ___
 
@@ -44,7 +43,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:151](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L151)
+[types/wallet.ts:154](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L154)
 
 ___
 
@@ -54,7 +53,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:153](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L153)
+[types/wallet.ts:156](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L156)
 
 ___
 
@@ -64,7 +63,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:165](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L165)
+[types/wallet.ts:168](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L168)
 
 ___
 
@@ -74,7 +73,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:160](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L160)
+[types/wallet.ts:163](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L163)
 
 ___
 
@@ -84,7 +83,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:163](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L163)
+[types/wallet.ts:166](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L166)
 
 ___
 
@@ -94,7 +93,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:156](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L156)
+[types/wallet.ts:159](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L159)
 
 ___
 
@@ -104,17 +103,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:154](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L154)
-
-___
-
-### exchangeRates
-
-• **exchangeRates**: [`IExchangeRates`](IExchangeRates.md)
-
-#### Defined in
-
-[types/wallet.ts:167](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L167)
+[types/wallet.ts:157](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L157)
 
 ___
 
@@ -124,7 +113,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:168](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L168)
+[types/wallet.ts:170](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L170)
 
 ___
 
@@ -134,7 +123,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:152](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L152)
+[types/wallet.ts:155](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L155)
 
 ___
 
@@ -144,7 +133,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:150](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L150)
+[types/wallet.ts:153](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L153)
 
 ___
 
@@ -154,7 +143,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:157](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L157)
+[types/wallet.ts:160](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L160)
 
 ___
 
@@ -164,7 +153,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:158](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L158)
+[types/wallet.ts:161](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L161)
 
 ___
 
@@ -174,7 +163,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:166](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L166)
+[types/wallet.ts:169](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L169)
 
 ___
 
@@ -184,7 +173,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:164](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L164)
+[types/wallet.ts:167](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L167)
 
 ___
 
@@ -194,7 +183,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:162](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L162)
+[types/wallet.ts:165](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L165)
 
 ___
 
@@ -204,7 +193,7 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:161](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L161)
+[types/wallet.ts:164](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L164)
 
 ___
 
@@ -214,4 +203,4 @@ ___
 
 #### Defined in
 
-[types/wallet.ts:159](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L159)
+[types/wallet.ts:162](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L162)

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "beignet",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "A self-custodial, JS Bitcoin wallet management library.",
   "main": "dist/index.js",
   "scripts": {
     "test": "yarn build && env mocha --exit -r ts-node/register 'tests/**/*.ts'",
     "test:wallet": "yarn build && env mocha --exit -r ts-node/register 'tests/wallet.test.ts'",
     "test:electrum": "yarn build && env mocha --exit -r ts-node/register 'tests/electrum.test.ts'",
-    "test:derivation": " yarn build && env mocha --exit -r ts-node/register 'tests/derivation.test.ts'",
-    "test:transaction": " yarn build && env mocha --exit -r ts-node/register 'tests/transaction.test.ts'",
+    "test:derivation": "yarn build && env mocha --exit -r ts-node/register 'tests/derivation.test.ts'",
+    "test:transaction": "yarn build && env mocha --exit -r ts-node/register 'tests/transaction.test.ts'",
     "test:storage": "yarn build && env mocha --exit -r ts-node/register 'tests/storage.test.ts'",
     "example": "ts-node example",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",

package/src/electrum/index.ts

@@ -1,11 +1,13 @@
 import {
+	EAddressType,
 	EAvailableNetworks,
+	EElectrumNetworks,
+	EScanningStrategy,
 	IAddress,
 	IAddresses,
-	TAddressTypeContent,
-	TConnectToElectrumRes,
 	IElectrumGetAddressBalanceRes,
 	IGetAddressHistoryResponse,
+	IGetAddressScriptHashBalances,
 	IGetAddressScriptHashesHistoryResponse,
 	IGetHeaderResponse,
 	IGetTransactions,
@@ -13,37 +15,39 @@ import {
 	IGetUtxosResponse,
 	IHeader,
 	INewBlock,
+	IPeerData,
 	ISubscribeToAddress,
 	ISubscribeToHeader,
 	ITransaction,
 	ITxHash,
 	IUtxo,
-	EElectrumNetworks,
+	TAddressTypeContent,
+	TConnectToElectrumRes,
+	TGetAddressHistory,
+	TOnMessage,
 	TServer,
 	TSubscribedReceive,
 	TTxResponse,
 	TTxResult,
-	TUnspentAddressScriptHashData,
-	IPeerData,
-	TGetAddressHistory,
-	TOnMessage,
-	IGetAddressScriptHashBalances
+	TUnspentAddressScriptHashData
 } from '../types';
 import * as electrum from 'rn-electrum-client/helpers';
 import {
 	err,
+	filterAddressesForGapLimit,
+	filterAddressesObjForGapLimit,
+	filterAddressesObjForSingleIndex,
+	filterAddressesObjForStartingIndex,
 	getAddressFromScriptPubKey,
 	getElectrumNetwork,
+	getScriptHash,
 	ok,
 	Result,
 	sleep
 } from '../utils';
 import { Wallet } from '../wallet';
-import { CHUNK_LIMIT, GAP_LIMIT } from '../wallet/constants';
-import { getScriptHash } from '../utils';
-import { POLLING_INTERVAL } from '../shapes';
+import { onMessageKeys, POLLING_INTERVAL } from '../shapes';
 import { Block } from 'bitcoinjs-lib';
-import { onMessageKeys } from '../shapes';
 import { Server } from 'net';
 import { TLSSocket } from 'tls';
 
@@ -68,13 +72,17 @@ export class Electrum {
 	public electrumNetwork: EElectrumNetworks;
 	public connectedToElectrum: boolean;
 	public onReceive?: (data: unknown) => void;
+	public batchLimit: number;
+	public batchDelay: number;
 	constructor({
 		wallet,
 		servers,
 		network,
 		onReceive,
 		tls: _tls,
-		net: _net
+		net: _net,
+		batchLimit = 20,
+		batchDelay = 50
 	}: {
 		wallet: Wallet;
 		servers?: TServer | TServer[];
@@ -82,6 +90,8 @@ export class Electrum {
 		onReceive?: (data: unknown) => void;
 		tls?: TLSSocket;
 		net?: Server;
+		batchLimit?: number;
+		batchDelay?: number;
 	}) {
 		this._wallet = wallet;
 		this.sendMessage = wallet.sendMessage;
@@ -92,6 +102,8 @@ export class Electrum {
 		this.onReceive = onReceive;
 		this.tls = _tls ?? tls;
 		this.net = _net ?? net;
+		this.batchLimit = batchLimit;
+		this.batchDelay = batchDelay;
 		if (!this.tls || !this.net) {
 			throw new Error(
 				'TLS and NET modules are not available and were not passed as instances'
@@ -286,15 +298,21 @@ export class Electrum {
 						addressIndex >= 0 &&
 						changeAddressIndex >= 0
 					) {
-						addressValues = addressValues.filter(
-							(a) => Math.abs(addressIndex - a.index) <= GAP_LIMIT
-						);
-						changeAddressValues = changeAddressValues.filter(
-							(a) => Math.abs(changeAddressIndex - a.index) <= GAP_LIMIT
-						);
+						addressValues = filterAddressesForGapLimit({
+							addresses: addressValues,
+							index: addressIndex,
+							gapLimitOptions: this._wallet.gapLimitOptions
+						});
+						changeAddressValues = filterAddressesForGapLimit({
+							addresses: changeAddressValues,
+							index: changeAddressIndex,
+							gapLimitOptions: this._wallet.gapLimitOptions
+						});
 					}
+					const utxoScriptHashes: IAddress[] = currentWallet.utxos;
 
 					scriptHashes = [
+						...utxoScriptHashes,
 						...scriptHashes,
 						...addressValues,
 						...changeAddressValues
@@ -312,10 +330,9 @@ export class Electrum {
 			const combinedResponse: TTxResponse[] = [];
 			const promises: Promise<IGetAddressScriptHashesHistoryResponse>[] = [];
 
-			const chunkLimit = CHUNK_LIMIT[this.network];
 			// split payload in chunks of 10 addresses per-request
-			for (let i = 0; i < scriptHashes.length; i += chunkLimit) {
-				const chunk = scriptHashes.slice(i, i + chunkLimit);
+			for (let i = 0; i < scriptHashes.length; i += this.batchLimit) {
+				const chunk = scriptHashes.slice(i, i + this.batchLimit);
 				const payload = {
 					key: 'scriptHash',
 					data: chunk
@@ -326,14 +343,14 @@ export class Electrum {
 						network: this.electrumNetwork
 					})
 				);
-				await sleep(50);
+				await sleep(this.batchDelay);
 				promises.push(
 					electrum.getAddressScriptHashesMempool({
 						scriptHashes: payload,
 						network: this.electrumNetwork
 					})
 				);
-				await sleep(50);
+				await sleep(this.batchDelay);
 			}
 
 			const responses = await Promise.all(promises);
@@ -403,13 +420,22 @@ export class Electrum {
 
 	/**
 	 * Returns UTXO's for a given wallet and network along with the available balance.
-	 * @param {boolean} [scanAllAddresses]
+	 * @param {EScanningStrategy} [scanningStrategy]
+	 * @param {number} addressIndex
+	 * @param {number} changeAddressIndex
+	 * @param {EAddressType[]} [addressTypesToCheck]
 	 * @returns {Promise<Result<IGetUtxosResponse>>}
 	 */
 	async getUtxos({
-		scanAllAddresses = false
+		scanningStrategy = EScanningStrategy.gapLimit,
+		addressIndex,
+		changeAddressIndex,
+		addressTypesToCheck = this._wallet.addressTypesToMonitor
 	}: {
-		scanAllAddresses?: boolean;
+		scanningStrategy?: EScanningStrategy;
+		addressIndex?: number;
+		changeAddressIndex?: number;
+		addressTypesToCheck?: EAddressType[];
 	}): Promise<Result<IGetUtxosResponse>> {
 		try {
 			if (!this.connectedToElectrum)
@@ -419,12 +445,11 @@ export class Electrum {
 				});
 			const currentWallet = this._wallet.data;
 
-			const addressTypeKeys = this._wallet.addressTypesToMonitor;
 			let addresses = {} as IAddresses;
 			let changeAddresses = {} as IAddresses;
 			const existingUtxos: { [key: string]: IUtxo } = {};
 
-			for (const addressType of addressTypeKeys) {
+			for (const addressType of addressTypesToCheck) {
 				const addressCount = Object.keys(currentWallet.addresses[addressType])
 					?.length;
 
@@ -433,30 +458,66 @@ export class Electrum {
 					break;
 				}
 
-				// Grab the current index for both addresses and change addresses.
-				const addressIndex = currentWallet.addressIndex[addressType].index;
-				const changeAddressIndex =
-					currentWallet.changeAddressIndex[addressType].index;
-
 				// Grab all addresses and change addresses.
 				const allAddresses = currentWallet.addresses[addressType];
 				const allChangeAddresses = currentWallet.changeAddresses[addressType];
 
-				// Instead of scanning all addresses, adhere to the gap limit.
-				if (!scanAllAddresses && addressIndex >= 0 && changeAddressIndex >= 0) {
-					Object.values(allAddresses).map((a) => {
-						if (Math.abs(a.index - addressIndex) <= GAP_LIMIT) {
-							addresses[a.scriptHash] = a;
-						}
-					});
-					Object.values(allChangeAddresses).map((a) => {
-						if (Math.abs(a.index - changeAddressIndex) <= GAP_LIMIT) {
-							changeAddresses[a.scriptHash] = a;
-						}
-					});
-				} else {
+				if (scanningStrategy === EScanningStrategy.all) {
 					addresses = { ...addresses, ...allAddresses };
 					changeAddresses = { ...changeAddresses, ...allChangeAddresses };
+				} else {
+					// Grab the current index for address/change addresses if none were provided.
+					if (!addressIndex)
+						addressIndex = currentWallet.addressIndex[addressType].index;
+					if (!changeAddressIndex)
+						changeAddressIndex =
+							currentWallet.changeAddressIndex[addressType].index;
+
+					// Use the lowest index to ensure we're not starting above our current index.
+					// TODO: Consider removing this entirely or at least updating it to allow up to the max stored address/change address index.
+					const lowestAddressIndex = Math.min(
+						addressIndex,
+						currentWallet.addressIndex[addressType].index
+					);
+					const lowestChangeAddressIndex = Math.min(
+						changeAddressIndex,
+						currentWallet.changeAddressIndex[addressType].index
+					);
+
+					switch (scanningStrategy) {
+						case EScanningStrategy.gapLimit:
+							addresses = filterAddressesObjForGapLimit({
+								addresses: allAddresses,
+								index: lowestAddressIndex,
+								gapLimitOptions: this._wallet.gapLimitOptions
+							});
+							changeAddresses = filterAddressesObjForGapLimit({
+								addresses: allChangeAddresses,
+								index: lowestChangeAddressIndex,
+								gapLimitOptions: this._wallet.gapLimitOptions
+							});
+							break;
+						case EScanningStrategy.startingIndex:
+							addresses = filterAddressesObjForStartingIndex({
+								addresses: allAddresses,
+								index: lowestAddressIndex
+							});
+							changeAddresses = filterAddressesObjForStartingIndex({
+								addresses: allChangeAddresses,
+								index: lowestChangeAddressIndex
+							});
+							break;
+						case EScanningStrategy.singleIndex:
+							addresses = filterAddressesObjForSingleIndex({
+								addresses: allAddresses,
+								addressIndex
+							});
+							changeAddresses = filterAddressesObjForSingleIndex({
+								addresses: allChangeAddresses,
+								addressIndex: changeAddressIndex
+							});
+							break;
+					}
 				}
 			}
 
@@ -501,10 +562,9 @@ export class Electrum {
 			const result: ITransaction<IUtxo>[] = [];
 			const promises: Promise<IGetTransactions>[] = [];
 
-			const chunkLimit = CHUNK_LIMIT[this.network];
 			// split payload in chunks of 10 transactions per-request
-			for (let i = 0; i < txHashes.length; i += chunkLimit) {
-				const chunk = txHashes.slice(i, i + chunkLimit);
+			for (let i = 0; i < txHashes.length; i += this.batchLimit) {
+				const chunk = txHashes.slice(i, i + this.batchLimit);
 
 				const data = {
 					key: 'tx_hash',
@@ -517,7 +577,7 @@ export class Electrum {
 						network: this.electrumNetwork
 					})
 				);
-				await sleep(50);
+				await sleep(this.batchDelay);
 			}
 			const responses = await Promise.all(promises);
 			responses.forEach((response) => {
@@ -704,6 +764,7 @@ export class Electrum {
 		scriptHashes?: string[];
 		onReceive?: (data: TSubscribedReceive) => void;
 	} = {}): Promise<Result<string>> {
+		const allUtxos: IUtxo[] = [];
 		const currentWallet = this._wallet.data;
 		const addressTypeKeys = this._wallet.addressTypesToMonitor;
 		// Gather the receiving address scripthash for each address type if no scripthashes were provided.
@@ -718,20 +779,27 @@ export class Electrum {
 					addressIndex = addressIndex > 0 ? addressIndex : 0;
 
 					// Only subscribe up to the gap limit.
-					const addressesInRange = Object.values(addresses).filter(
-						(address) => Math.abs(address.index - addressIndex) <= GAP_LIMIT
-					);
-					const addressesToSubscribe = addressesInRange.slice(-GAP_LIMIT);
-					const addressScriptHashes = addressesToSubscribe.map(
-						({ scriptHash }) => scriptHash
+					const addressesInRangeToSubscribe = filterAddressesForGapLimit({
+						addresses: Object.values(addresses),
+						index: addressIndex,
+						gapLimitOptions: this._wallet.gapLimitOptions
+					});
+					const _scriptHashes = addressesInRangeToSubscribe.map(
+						(address) => address.scriptHash
 					);
-					scriptHashes.push(...addressScriptHashes);
+					scriptHashes.push(..._scriptHashes);
 				}
 			}
+			// Keep an eye on existing UTXO's regardless of the gap limit.
+			currentWallet.utxos.forEach((utxo) => {
+				if (!scriptHashes.includes(utxo.scriptHash)) {
+					allUtxos.push(utxo);
+				}
+			});
 		}
 
 		// Subscribe to all provided script hashes.
-		const promises = scriptHashes.map(async (scriptHash) => {
+		const allScriptHashesPromise = scriptHashes.map(async (scriptHash) => {
 			const response: ISubscribeToAddress = await electrum.subscribeAddress({
 				scriptHash,
 				network: this.electrumNetwork,
@@ -745,8 +813,27 @@ export class Electrum {
 			}
 		});
 
+		const allUtxosPromise = allUtxos.map(async (utxo) => {
+			const response: ISubscribeToAddress = await electrum.subscribeAddress({
+				scriptHash: utxo.scriptHash,
+				network: this.electrumNetwork,
+				onReceive: async (data: TSubscribedReceive): Promise<void> => {
+					onReceive?.(data);
+					await this.getUtxos({
+						scanningStrategy: EScanningStrategy.singleIndex,
+						addressIndex: utxo.index,
+						changeAddressIndex: utxo.index
+					});
+					this._wallet.refreshWallet({});
+				}
+			});
+			if (response.error) {
+				throw Error('Unable to subscribe to receiving addresses.');
+			}
+		});
+
 		try {
-			await Promise.all(promises);
+			await Promise.all([allScriptHashesPromise, allUtxosPromise]);
 		} catch (e) {
 			return err(e);
 		}

package/src/types/electrum.ts

@@ -30,6 +30,13 @@ export enum EProtocol {
 	ssl = 'ssl'
 }
 
+export enum EScanningStrategy {
+	all = 'all', // Scan all addresses/scripthashes
+	gapLimit = 'gapLimit', // Adhere to the gap limit within range of the provided index when scanning addresses/scripthashes. If higher than the current index, it will be ignored
+	startingIndex = 'startingIndex', // Scan all addresses/scripthashes starting from the provided index. If higher than the current index, it will be ignored
+	singleIndex = 'singleIndex' // Scan the single provided address/scripthash
+}
+
 export interface IGetUtxosResponse {
 	utxos: IUtxo[];
 	balance: number;

package/src/types/transaction.ts

@@ -58,3 +58,8 @@ export type TGetTotalFeeObj = {
 	satsPerByte: number;
 	maxSatPerByte: number; // Max sats per byte that can be used for a given transaction without exceeding 50% of the balance.
 };
+
+export type TGapLimitOptions = {
+	lookAhead: number;
+	lookBehind: number;
+};

package/src/types/wallet.ts

@@ -6,7 +6,7 @@ import {
 	TServer,
 	TTxResult
 } from './electrum';
-import { EFeeId } from './transaction';
+import { EFeeId, TGapLimitOptions } from './transaction';
 import { TLSSocket } from 'tls';
 import { Server } from 'net';
 import { ECPairInterface } from 'ecpair';
@@ -67,6 +67,7 @@ export interface IUtxo {
 	tx_hash: string;
 	tx_pos: number;
 	value: number;
+	publicKey: string;
 	keyPair?: BIP32Interface | ECPairInterface;
 }
 
@@ -193,6 +194,8 @@ export interface IWallet {
 		servers?: TServer | TServer[];
 		tls?: TLSSocket;
 		net?: Server;
+		batchLimit?: number; // Maximum number of requests to be sent in a single batch
+		batchDelay?: number; // Delay (in milliseconds) between each batch of requests
 	};
 	remainOffline?: boolean;
 	onMessage?: TOnMessage;
@@ -205,6 +208,9 @@ export interface IWallet {
 	disableMessages?: boolean;
 	disableMessagesOnCreate?: boolean;
 	addressTypesToMonitor?: EAddressType[];
+	gapLimitOptions?: TGapLimitOptions;
+	addressLookBehind?: number;
+	addressLookAhead?: number;
 }
 
 export interface IAddressData {

package/src/utils/helpers.ts

@@ -331,3 +331,17 @@ export const sleep = (ms): Promise<void> => {
 		setTimeout(resolve, ms);
 	});
 };
+
+/**
+ * Returns the difference between two address indexes.
+ * @param addrIndex1
+ * @param addrIndex2
+ * @returns number
+ */
+export const getAddressIndexDiff = (addrIndex1 = 0, addrIndex2 = 0): number => {
+	if (addrIndex1 < 0) addrIndex1 = -1;
+	if (addrIndex2 < 0) addrIndex2 = -1;
+	return Math.abs(addrIndex1 - addrIndex2);
+};
+
+export const isPositive = (num: number): boolean => num > 0;