Differential D15784 Diff 46588 cashtab/src/components/fixtures/helpers.js

Changeset View

Standalone View

cashtab/src/components/fixtures/helpers.js

// Copyright (c) 2024 The Bitcoin developers		// Copyright (c) 2024 The Bitcoin developers
// Distributed under the MIT software license, see the accompanying		// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.		// file COPYING or http://www.opensource.org/licenses/mit-license.php.

import { MockChronikClient } from '../../../../modules/mock-chronik-client';		import { MockChronikClient } from '../../../../modules/mock-chronik-client';
import { CashtabSettings } from 'config/cashtabSettings';		import { CashtabSettings } from 'config/cashtabSettings';
import CashtabCache from 'config/CashtabCache';		import CashtabCache from 'config/CashtabCache';
import { cashtabCacheToJSON } from 'helpers';		import { cashtabCacheToJSON, cashtabWalletToJSON } from 'helpers';

/**		/**
* Get expected mock values for chronik client for a given mock wallet		* Get expected mock values for chronik client for a given mock wallet
* Used to support integration testing in Cashtab		* Used to support integration testing in Cashtab
* Default methods may be overwritten in individual unit tests to test special conditions		* Default methods may be overwritten in individual unit tests to test special conditions
* @param {array \| object \| boolean} wallets Array of wallets stored in localforage.		* @param {array \| object \| boolean} wallets Array of wallets stored in localforage.
* If object, convert to array of length 1.		* If object, convert to array of length 1.
* False if user has not yet created a wallet.		* False if user has not yet created a wallet.
Show All 13 Lines	if (wallets === false) {
// No info to give to chronik, do not populate mocks		// No info to give to chronik, do not populate mocks
return chronikClient;		return chronikClient;
// We do not expect anything in localforage for this case		// We do not expect anything in localforage for this case
}		}

wallets = Array.isArray(wallets) ? wallets : [wallets];		wallets = Array.isArray(wallets) ? wallets : [wallets];

// Set wallets in localforage		// Set wallets in localforage
await localforage.setItem('wallets', wallets);
		// If wallet is post-2.9.0, make sure the JSON is in localforage and not the actual wallet
		let localforageWallets = [];
		for (const wallet of wallets) {
		if (
		// Pre 2.1.0 wallet
		'Path145' in wallet \|\|
		// Pre 2.9.0 wallet
		(Array.isArray(wallet.paths) &&
		wallet.paths.length > 0 &&
		typeof wallet.paths[0].path !== 'undefined')
		) {
		// Pre-2.9.0 wallet, expected to be in localforage as-is
		localforageWallets.push(wallet);
		} else {
		// Post-2.9.0 wallet, expected to be in localforage as JSON
		localforageWallets.push(cashtabWalletToJSON(wallet));
		}
		}

		await localforage.setItem('wallets', localforageWallets);

// All other localforage items will be unset unless the user has customized them		// All other localforage items will be unset unless the user has customized them
// Cashtab will use defaults		// Cashtab will use defaults
// localforage may be modified in individual test cases to test cases of user with		// localforage may be modified in individual test cases to test cases of user with
// non-default settings, cashtabCache, or contactList		// non-default settings, cashtabCache, or contactList

// Mock returns for chronik calls expected in useWallet's update routine for all wallets		// Mock returns for chronik calls expected in useWallet's update routine for all wallets
for (const wallet of wallets) {		for (const wallet of wallets) {
prepareMockedChronikCallsForWallet(chronikClient, wallet, apiError);		prepareMockedChronikCallsForWallet(chronikClient, wallet, apiError);
}		}

return chronikClient;		return chronikClient;
};		};

/**		/**
		* Get expected mock values for chronik client for a given mock wallet created before Cashtab 2.9.0
		* Used to support integration testing in Cashtab
		* Default methods may be overwritten in individual unit tests to test special conditions
		* @param {array \| object \| boolean} wallets Array of wallets stored in localforage.
		* If object, convert to array of length 1.
		* False if user has not yet created a wallet.
		* @param {object} localforage the localforage instance used in your test
		* @param {boolean} apiError Default false. If true, return a mockedChronik that throws errors.
		* @returns {object} mockChronikClient, a mock chronik client instance prepopulated for expected Cashtab API calls
		*/
		export const initializeCashtabStateAtPre2_9_0ForTests = async (
		wallets,
		localforage,
		apiError = false,
		) => {
		// Mock successful utxos calls in chronik
		const chronikClient = new MockChronikClient();

		if (wallets === false) {
		// No info to give to chronik, do not populate mocks
		return chronikClient;
		// We do not expect anything in localforage for this case
		}

		wallets = Array.isArray(wallets) ? wallets : [wallets];

		// Set wallets in localforage
		await localforage.setItem('wallets', wallets);

		// All other localforage items will be unset unless the user has customized them
		// Cashtab will use defaults
		// localforage may be modified in individual test cases to test cases of user with
		// non-default settings, cashtabCache, or contactList

		// Mock returns for chronik calls expected in useWallet's update routine for all wallets
		for (const wallet of wallets) {
		prepareMockedChronikCallsForPre_2_9_0Wallet(
		chronikClient,
		wallet,
		apiError,
		);
		}

		return chronikClient;
		};

		/**
* Get expected mock values for chronik client for a given mock wallet for a pre 2.0.0 Cashtab user		* Get expected mock values for chronik client for a given mock wallet for a pre 2.0.0 Cashtab user
* Used to support integration testing in Cashtab		* Used to support integration testing in Cashtab
* Default methods may be overwritten in individual unit tests to test special conditions		* Default methods may be overwritten in individual unit tests to test special conditions
* @param {object \| boolean} wallet A mock Cashtab wallet		* @param {object \| boolean} wallet A mock Cashtab wallet
* @param {object} localforage the localforage instance used in your test		* @param {object} localforage the localforage instance used in your test
* @param {boolean} apiError Default false. If true, return a mockedChronik that throws errors.		* @param {boolean} apiError Default false. If true, return a mockedChronik that throws errors.
* @returns {object} mockChronikClient, a mock chronik client instance prepopulated for expected Cashtab API calls		* @returns {object} mockChronikClient, a mock chronik client instance prepopulated for expected Cashtab API calls
*/		*/
▲ Show 20 Lines • Show All 42 Lines • ▼ Show 20 Lines
) => {		) => {
// mock chronik endpoint returns		// mock chronik endpoint returns
const CASHTAB_TESTS_TIPHEIGHT = 800000;		const CASHTAB_TESTS_TIPHEIGHT = 800000;
chronikClient.setMock('blockchainInfo', {		chronikClient.setMock('blockchainInfo', {
output: apiError		output: apiError
? new Error('Error fetching blockchainInfo')		? new Error('Error fetching blockchainInfo')
: { tipHeight: CASHTAB_TESTS_TIPHEIGHT },		: { tipHeight: CASHTAB_TESTS_TIPHEIGHT },
});		});

// Mock scriptutxos to match context		// Mock scriptutxos to match context
// Cashtab only supports p2pkh addresses		chronikClient.setAddress(wallet.Path1899.cashAddress);
const CASHTAB_ADDRESS_TYPE = 'p2pkh';		chronikClient.setUtxosByAddress(
chronikClient.setScript(CASHTAB_ADDRESS_TYPE, wallet.Path1899.hash160);		wallet.Path1899.cashAddress,
chronikClient.setUtxos(
CASHTAB_ADDRESS_TYPE,
wallet.Path1899.hash160,
apiError		apiError
? new Error('Error fetching utxos')		? new Error('Error fetching utxos')
: {		: {
outputScript: `76a914${wallet.Path1899.hash160}88ac`,		outputScript: `76a914${wallet.Path1899.hash160}88ac`,
utxos: wallet.state.nonSlpUtxos.concat(wallet.state.slpUtxos),		utxos: wallet.state.nonSlpUtxos.concat(wallet.state.slpUtxos),
},		},
);		);

// We set legacy paths to contain no utxos		// We set legacy paths to contain no utxos
chronikClient.setScript(CASHTAB_ADDRESS_TYPE, wallet.Path145.hash160);		chronikClient.setAddress(wallet.Path145.cashAddress);
chronikClient.setUtxos(		chronikClient.setUtxosByAddress(
CASHTAB_ADDRESS_TYPE,		wallet.Path145.cashAddress,
wallet.Path145.hash160,
apiError		apiError
? new Error('Error fetching utxos')		? new Error('Error fetching utxos')
: {		: {
outputScript: `76a914${wallet.Path145.hash160}88ac`,		outputScript: `76a914${wallet.Path145.hash160}88ac`,
utxos: [],		utxos: [],
},		},
);		);
chronikClient.setScript(CASHTAB_ADDRESS_TYPE, wallet.Path245.hash160);		chronikClient.setAddress(wallet.Path245.cashAddress);
chronikClient.setUtxos(		chronikClient.setUtxosByAddress(
CASHTAB_ADDRESS_TYPE,		wallet.Path245.cashAddress,
wallet.Path245.hash160,
apiError		apiError
? new Error('Error fetching utxos')		? new Error('Error fetching utxos')
: {		: {
outputScript: `76a914${wallet.Path245.hash160}88ac`,		outputScript: `76a914${wallet.Path245.hash160}88ac`,
utxos: [],		utxos: [],
},		},
);		);

// TX history mocks		// TX history mocks
chronikClient.setTxHistory(		chronikClient.setTxHistoryByAddress(
CASHTAB_ADDRESS_TYPE,		wallet.Path1899.cashAddress,
wallet.Path1899.hash160,
apiError		apiError
? new Error('Error fetching history')		? new Error('Error fetching history')
: wallet.state.parsedTxHistory,		: wallet.state.parsedTxHistory,
);		);
// We set legacy paths to contain no utxos		// We set legacy paths to contain no utxos
chronikClient.setTxHistory(		chronikClient.setTxHistoryByAddress(
CASHTAB_ADDRESS_TYPE,		wallet.Path145.cashAddress,
wallet.Path145.hash160,
apiError ? new Error('Error fetching history') : [],		apiError ? new Error('Error fetching history') : [],
);		);
chronikClient.setTxHistory(		chronikClient.setTxHistoryByAddress(
CASHTAB_ADDRESS_TYPE,		wallet.Path245.cashAddress,
wallet.Path245.hash160,
apiError ? new Error('Error fetching history') : [],		apiError ? new Error('Error fetching history') : [],
);		);

// Mock chronik.tx(tokenId) calls for tokens in tx history
for (const tx of wallet.state.parsedTxHistory) {
const mockedTokenResponse = {
genesisInfo: tx.parsed.genesisInfo,
};
if (tx.parsed.isEtokenTx) {
chronikClient.setMock('token', {
input:
'tokenEntries' in tx.parsed
? tx.parsed.tokenEntries[0].tokenId
: tx.parsed.slpMeta.tokenId,
output: mockedTokenResponse,
});
}
}
};		};

/**		/**
*		*
* @param {object} chronikClient a mockedChronikClient object		* @param {object} chronikClient a mockedChronikClient object
* @param {object} wallet a valid cashtab wallet object		* @param {object} wallet a valid cashtab wallet object from before cashtab 2.9.0 and after 2.1.0
* @param {boolean} apiError true if we want to set api errors in mocked chronik		* @param {boolean} apiError true if we want to set api errors in mocked chronik
* @returns modifies chronikClient in place to have expected API calls for wallet loading available		* @returns modifies chronikClient in place to have expected API calls for wallet loading available
*/		*/
export const prepareMockedChronikCallsForWallet = (		export const prepareMockedChronikCallsForPre_2_9_0Wallet = (
chronikClient,		chronikClient,
wallet,		wallet,
apiError = false,		apiError = false,
) => {		) => {
// mock chronik endpoint returns		// mock chronik endpoint returns
const CASHTAB_TESTS_TIPHEIGHT = 800000;		const CASHTAB_TESTS_TIPHEIGHT = 800000;
chronikClient.setMock('blockchainInfo', {		chronikClient.setMock('blockchainInfo', {
output: apiError		output: apiError
? new Error('Error fetching blockchainInfo')		? new Error('Error fetching blockchainInfo')
: { tipHeight: CASHTAB_TESTS_TIPHEIGHT },		: { tipHeight: CASHTAB_TESTS_TIPHEIGHT },
});		});

// Cashtab only supports p2pkh addresses
const CASHTAB_ADDRESS_TYPE = 'p2pkh';

// If you are mocking a legacy wallet to test a migration, return prepareMockedChronikCallsForLegacyWallet		// If you are mocking a legacy wallet to test a migration, return prepareMockedChronikCallsForLegacyWallet
if (!('paths' in wallet)) {		if (!('paths' in wallet)) {
return prepareMockedChronikCallsForLegacyWallet(		return prepareMockedChronikCallsForLegacyWallet(
chronikClient,		chronikClient,
wallet,		wallet,
apiError,		apiError,
);		);
}		}

// Iterate over paths to create chronik mocks		// Iterate over paths to create chronik mocks
for (const path of wallet.paths) {		for (const path of wallet.paths) {
// Mock scriptutxos to match context		// Mock scriptutxos to match context
chronikClient.setScript(CASHTAB_ADDRESS_TYPE, path.hash);		chronikClient.setAddress(path.address);
chronikClient.setUtxos(		chronikClient.setUtxosByAddress(
CASHTAB_ADDRESS_TYPE,		path.address,
path.hash,
apiError		apiError
? new Error('Error fetching utxos')		? new Error('Error fetching utxos')
: {		: {
outputScript: `76a914${path.hash}88ac`,		outputScript: `76a914${path.hash}88ac`,
utxos:		utxos:
path.path === 1899		path.path === 1899
? wallet.state.nonSlpUtxos.concat(		? wallet.state.nonSlpUtxos.concat(
wallet.state.slpUtxos,		wallet.state.slpUtxos,
)		)
: [],		: [],
},		},
);		);

// Mock tx history		// Mock tx history
chronikClient.setTxHistory(		chronikClient.setTxHistoryByAddress(
CASHTAB_ADDRESS_TYPE,		path.address,
path.hash,
apiError		apiError
? new Error('Error fetching history')		? new Error('Error fetching history')
: path.path === 1899		: path.path === 1899
? wallet.state.parsedTxHistory		? wallet.state.parsedTxHistory
: // No tx history at legacy paths		: // No tx history at legacy paths
[],		[],
);		);
}		}
		};

		/**
		* Prepare chronik calls for a wallet of Cashtab version >= 2.9.0
		* @param {object} chronikClient a mockedChronikClient object
		* @param {object} wallet a valid cashtab wallet object
		* @param {boolean} apiError true if we want to set api errors in mocked chronik
		* @returns modifies chronikClient in place to have expected API calls for wallet loading available
		*/
		export const prepareMockedChronikCallsForWallet = (
		chronikClient,
		wallet,
		apiError = false,
		) => {
		// mock chronik endpoint returns
		const CASHTAB_TESTS_TIPHEIGHT = 800000;
		chronikClient.setMock('blockchainInfo', {
		output: apiError
		? new Error('Error fetching blockchainInfo')
		: { tipHeight: CASHTAB_TESTS_TIPHEIGHT },
		});

// Mock chronik.tx(tokenId) calls for tokens in tx history		// Mock token calls
		// This info is same shape for all wallets supported in these functions
		// Get tokenIds you need chronik.tx(tokenId) and chronik.token(tokenId) calls for
		// These can come from tx history and slpUtxos
		const tokenIdsToMock = new Set();
		for (const utxo of wallet.state.slpUtxos) {
		tokenIdsToMock.add(utxo.token.tokenId);
		}
for (const tx of wallet.state.parsedTxHistory) {		for (const tx of wallet.state.parsedTxHistory) {
const mockedTokenResponse = {
genesisInfo: tx.parsed.genesisInfo,
};
if (tx.parsed.isEtokenTx) {		if (tx.parsed.isEtokenTx) {
chronikClient.setMock('token', {		const tokenId =
input:
'tokenEntries' in tx.parsed		'tokenEntries' in tx.parsed
? tx.parsed.tokenEntries[0].tokenId		? tx.parsed.tokenEntries[0].tokenId
: tx.parsed.slpMeta.tokenId,		: tx.parsed.slpMeta.tokenId;
		tokenIdsToMock.add(tokenId);
		}
		}

		for (const tokenId of [...tokenIdsToMock]) {
		const mockedTokenResponse = {
		tokenId: tokenId,
		tokenType: {
		protocol: 'SLP',
		type: 'SLP_TOKEN_TYPE_FUNGIBLE',
		number: 1,
		},
		timeFirstSeen: 0,
		genesisInfo: {
		tokenTicker: 'BEAR',
		tokenName: 'BearNip',
		url: 'https://cashtab.com/',
		decimals: 0,
		hash: '',
		},
		block: {
		height: 782665,
		hash: '00000000000000001239831f90580c859ec174316e91961cf0e8cde57c0d3acb',
		timestamp: 1678408305,
		},
		};
		chronikClient.setMock('token', {
		input: tokenId,
output: mockedTokenResponse,		output: mockedTokenResponse,
});		});
		const mockedTxResponse = {
		txid: tokenId,
		version: 2,
		inputs: [
		{
		prevOut: {
		txid: '0e737a2f6373649341b406334341202a5ddbbdb389c55da40570b641dc23d036',
		outIdx: 1,
		},
		inputScript:
		'473044022055444db90f98b462ca29a6f51981da4015623ddc34dc1f575852426ccb785f0402206e786d4056be781ca1720a0a915b040e0a9e8716b8e4d30b0779852c191fdeb3412103771805b54969a9bea4e3eb14a82851c67592156ddb5e52d3d53677d14a40fba6',
		value: 6231556,
		sequenceNo: 4294967294,
		outputScript:
		'76a91495e79f51d4260bc0dc3ba7fb77c7be92d0fbdd1d88ac',
		},
		],
		outputs: [
		{
		value: 0,
		outputScript:
		'6a04534c500001010747454e45534953044245415207426561724e69701468747470733a2f2f636173687461622e636f6d2f4c0001004c0008000000000000115c',
		},
		{
		value: 546,
		outputScript:
		'76a91495e79f51d4260bc0dc3ba7fb77c7be92d0fbdd1d88ac',
		token: {
		tokenId:
		'3fee3384150b030490b7bee095a63900f66a45f2d8e3002ae2cf17ce3ef4d109',
		tokenType: {
		protocol: 'SLP',
		type: 'SLP_TOKEN_TYPE_FUNGIBLE',
		number: 1,
		},
		amount: '4444',
		isMintBaton: false,
		entryIdx: 0,
		},
		spentBy: {
		txid: '9e7f91826cfd3adf9867c1b3d102594eff4743825fad9883c35d26fb3bdc1693',
		outIdx: 1,
		},
		},
		{
		value: 6230555,
		outputScript:
		'76a91495e79f51d4260bc0dc3ba7fb77c7be92d0fbdd1d88ac',
		spentBy: {
		txid: '27a2471afab33d82b9404df12e1fa242488a9439a68e540dcf8f811ef39c11cf',
		outIdx: 0,
		},
		},
		],
		lockTime: 0,
		timeFirstSeen: 0,
		size: 299,
		isCoinbase: false,
		tokenEntries: [
		{
		tokenId:
		'3fee3384150b030490b7bee095a63900f66a45f2d8e3002ae2cf17ce3ef4d109',
		tokenType: {
		protocol: 'SLP',
		type: 'SLP_TOKEN_TYPE_FUNGIBLE',
		number: 1,
		},
		txType: 'GENESIS',
		isInvalid: false,
		burnSummary: '',
		failedColorings: [],
		actualBurnAmount: '0',
		intentionalBurn: '0',
		burnsMintBatons: false,
		},
		],
		tokenFailedParsings: [],
		tokenStatus: 'TOKEN_STATUS_NORMAL',
		block: {
		height: 782665,
		hash: '00000000000000001239831f90580c859ec174316e91961cf0e8cde57c0d3acb',
		timestamp: 1678408305,
		},
		};
		chronikClient.setMock('tx', {
		input: tokenId,
		output: mockedTxResponse,
		});
}		}

		// If you are mocking a legacy wallet to test a migration, return prepareMockedChronikCallsForLegacyWallet
		if (!('paths' in wallet)) {
		return prepareMockedChronikCallsForLegacyWallet(
		chronikClient,
		wallet,
		apiError,
		);
}		}
		// If paths is an array and not a map, call appropriate function
		if (Array.isArray(wallet.paths)) {
		return prepareMockedChronikCallsForPre_2_9_0Wallet(
		chronikClient,
		wallet,
		apiError,
		);
		}

		// Iterate over paths to create chronik mocks
		wallet.paths.forEach((pathInfo, path) => {
		// Mock scriptutxos to match context
		chronikClient.setAddress(pathInfo.address);
		chronikClient.setUtxosByAddress(
		pathInfo.address,
		apiError
		? new Error('Error fetching utxos')
		: {
		outputScript: `76a914${pathInfo.hash}88ac`,
		utxos:
		path === 1899
		? wallet.state.nonSlpUtxos.concat(
		wallet.state.slpUtxos,
		)
		: [],
		},
		);

		// Mock tx history
		chronikClient.setTxHistoryByAddress(
		pathInfo.address,
		apiError
		? new Error('Error fetching history')
		: path === 1899
		? wallet.state.parsedTxHistory
		: // No tx history at legacy paths
		[],
		);
		});
};		};

/**		/**
* Remove all keys individually as localforage.clear() occasionally returns before all storage is clear		* Remove all keys individually as localforage.clear() occasionally returns before all storage is clear
* @param {object} localforage the localforage instance used in your test		* @param {object} localforage the localforage instance used in your test
*/		*/
export const clearLocalForage = async localforage => {		export const clearLocalForage = async localforage => {
const SUPPORTED_CASHTAB_STORAGE_KEYS = [		const SUPPORTED_CASHTAB_STORAGE_KEYS = [
Show All 11 Lines