fix: avoid saving transactions and timber while syncing

Author: daveroga

nightfall-client/src/event-handlers/block-proposed.mjs

@@ -25,7 +25,7 @@ const { ZERO, HASH_TYPE, TIMBER_HEIGHT, TXHASH_TREE_HASH_TYPE, TXHASH_TREE_HEIGH
 /**
 This handler runs whenever a BlockProposed event is emitted by the blockchain
 */
-async function blockProposedEventHandler(data) {
+async function blockProposedEventHandler(data, syncing) {
 // ivk will be used to decrypt secrets whilst nsk will be used to calculate nullifiers for commitments and store them
 const { blockNumber: currentBlockCount, transactionHash: transactionHashL1 } = data;
 const { transactions, block } = await getProposeBlockCalldata(data);
@@ -38,15 +38,27 @@ async function blockProposedEventHandler(data) {
 // if ((await countCommitments(blockCommitments)) > 0) {
 await saveBlock({ blockNumber: currentBlockCount, transactionHashL1, ...block });
 logger.debug(`Saved L2 block ${block.blockNumberL2}, with tx hash ${transactionHashL1}`);
-await Promise.all(transactions.map(t => saveTransaction({ transactionHashL1, ...t })));
+await Promise.all(
+transactions.map(t =>
+saveTransaction({
+transactionHashL1,
+blockNumber: data.blockNumber,
+blockNumberL2: block.blockNumberL2,
+...t,
+}).catch(function (err) {
+if (!syncing || !err.message.includes('replay existing transaction')) throw err;
+logger.warn('Attempted to replay existing transaction. This is expected while syncing');
+}),
+),
+);
 // }
 
 const dbUpdates = transactions.map(async transaction => {
 // filter out non zero commitments and nullifiers
 const nonZeroCommitments = transaction.commitments.flat().filter(n => n !== ZERO);
 const nonZeroNullifiers = transaction.nullifiers.flat().filter(n => n !== ZERO);
 if (
-(transaction.transactionType === '1' || transaction.transactionType === '2') &&
+(Number(transaction.transactionType) === 1 || Number(transaction.transactionType) === 2) &&
 (await countCommitments(nonZeroCommitments)) === 0
 )
 await decryptCommitment(transaction, ivks, nsks);
@@ -69,7 +81,14 @@ async function blockProposedEventHandler(data) {
 HASH_TYPE,
 TIMBER_HEIGHT,
 );
-await saveTree(transactionHashL1, block.blockNumberL2, updatedTimber);
+
+try {
+await saveTree(transactionHashL1, block.blockNumberL2, updatedTimber);
+} catch (err) {
+// while initial syncing we avoid duplicates errors
+if (!syncing || !err.message.includes('duplicate key')) throw err;
+}
+
 logger.debug(`Saved tree for L2 block ${block.blockNumberL2}`);
 await Promise.all(
 // eslint-disable-next-line consistent-return

nightfall-client/src/services/state-sync.mjs

@@ -41,7 +41,7 @@ const syncState = async (fromBlock = 'earliest', toBlock = 'latest', eventFilter
 switch (pastStateEvents[i].event) {
 case 'BlockProposed':
 // eslint-disable-next-line no-await-in-loop
-await blockProposedEventHandler(pastStateEvents[i]);
+await blockProposedEventHandler(pastStateEvents[i], true);
 break;
 case 'Rollback':
 // eslint-disable-next-line no-await-in-loop

nightfall-client/start-client

@@ -16,6 +16,7 @@ usage()
 {
 echo "Usage:"
 echo " -d or --dev; to bind mount the filesystem and use it for development"
+echo " -r; to remove existing volumes for mongodb and abi contracts"
 }
 
 # delete env file
@@ -24,6 +25,8 @@ while [ -n "$1" ]; do
 case $1 in
 -d | --dev ) DEV="-f ../docker-compose.client.dev.yml"
 ;;
+-r ) REMOVE_VOLUMES="true"
+;;
 -h | --help ) usage
 ;;
 * ) usage
@@ -36,22 +39,25 @@ if [ -z "$FILE" ]; then
 usage
 exit 1
 fi
+
+if [ -n "$REMOVE_VOLUMES" ]; then
+# if-else block checks - volume exist and then removes it.
+if [[ $(echo $VOLUME_LIST | grep nightfall_3_mongodb1) ]]; then
+echo -n 'Removing '
+docker volume rm nightfall_3_mongodb1
+fi
+
+if [[ $(echo $VOLUME_LIST | grep nightfall_3_build) ]]; then
+echo -n 'Removing '
+docker volume rm nightfall_3_build
+fi
+fi
+
 # shut down cleanly in the event of a cntl-c etc. We don't want to leave containers running
 trap "docker-compose $FILE $DEV down --remove-orphans -t 1; exit 1" SIGHUP SIGINT SIGTERM
 
 docker-compose $FILE $DEV down --remove-orphans
 
-# if-else block checks - volume exist and then removes it.
-if [[ $(echo $VOLUME_LIST | grep nightfall_3_mongodb1) ]]; then
-echo -n 'Removing '
-docker volume rm nightfall_3_mongodb1
-fi
-
-if [[ $(echo $VOLUME_LIST | grep nightfall_3_build) ]]; then
-echo -n 'Removing '
-docker volume rm nightfall_3_build
-fi
-
 DIR=../common-files/node_modules
 if [[ -d "$DIR" ]]; then
 rm -dr common-files/node_modules