SHARD-1149: fix case for timestamp fetching failing or timing out (#342)

* add `getTxTimestampTimeoutOffset` config for controlling timeout of `binary/get_tx_timestamp` call * fix: correctly check for injectedTimestamp existence + add logging context to timestamp function for easier debugging * fix: build * rename variable
shardeum · Dec 6, 2024 · 994140d · 994140d
1 parent 4744a5b
commit 994140d
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 9 deletions.
diff --git a/src/config/server.ts b/src/config/server.ts
@@ -155,7 +155,8 @@ const SERVER_CONFIG: StrictServerConfiguration = {
     requiredVotesPercentage: 2 / 3.0,
     timestampCacheFix: true,
     useAjvCycleRecordValidation: true,
-    networkTransactionsToProcessPerCycle: 20
+    networkTransactionsToProcessPerCycle: 20,
+    getTxTimestampTimeoutOffset: 0
   },
   ip: {
     externalIp: '0.0.0.0',

diff --git a/src/shardus/index.ts b/src/shardus/index.ts
@@ -1059,7 +1059,7 @@ class Shardus extends EventEmitter {
     }
   }
 
-  async _timestampAndQueueTransaction(tx: ShardusTypes.OpaqueTransaction, appData: any, global = false, noConsensus = false) {
+  async _timestampAndQueueTransaction(tx: ShardusTypes.OpaqueTransaction, appData: any, global = false, noConsensus = false, loggingContext = '') {
     // Give the dapp an opportunity to do some up front work and generate
     // appData metadata for the applied TX
     const { status: preCrackSuccess, reason } = await this.app.txPreCrackData(tx, appData)
@@ -1075,7 +1075,8 @@ class Shardus extends EventEmitter {
 
     const txId = this.app.calculateTxId(tx);
     let timestampReceipt: ShardusTypes.TimestampReceipt;
-    if (!injectedTimestamp || injectedTimestamp === -1) {
+    let isMissingInjectedTimestamp = !injectedTimestamp || injectedTimestamp === -1
+    if (isMissingInjectedTimestamp) {
       if (injectedTimestamp === -1) {
         /* prettier-ignore */
         if (logFlags.p2pNonFatal && logFlags.console) console.log("Dapp request to generate a new timestmap for the tx");
@@ -1085,13 +1086,13 @@ class Shardus extends EventEmitter {
       if (logFlags.p2pNonFatal && logFlags.console) console.log("Network generated a" +
         " timestamp", txId, timestampReceipt);
     }
-    if (!injectedTimestamp && !timestampReceipt) {
+    if (isMissingInjectedTimestamp && !timestampReceipt) {
       this.shardus_fatal(
         "put_noTimestamp",
         `Transaction timestamp cannot be determined ${utils.stringifyReduce(tx)} `
       );
       this.statistics.incrementCounter("txRejected");
-      nestedCountersInstance.countEvent("rejected", "_timestampNotDetermined");
+      nestedCountersInstance.countEvent("rejected", `_timestampNotDetermined-${loggingContext}`);
       return {
         success: false,
         reason: "Transaction timestamp cannot be determined.",
@@ -1139,7 +1140,7 @@ class Shardus extends EventEmitter {
 
     if (inRangeOfCurrentTime(timestamp, txExpireTimeMs, txExpireTimeMs) === false) {
       /* prettier-ignore */
-      this.shardus_fatal(`tx_outofrange`, `Transaction timestamp out of range: timestamp:${timestamp} now:${shardusGetTime()} diff(now-ts):${shardusGetTime() - timestamp}  ${utils.stringifyReduce(tx)} our offset: ${getNetworkTimeOffset()} `);
+      this.shardus_fatal(`tx_outofrange`, `Transaction timestamp out of range: timestamp:${timestamp} now:${shardusGetTime()} diff(now-ts):${shardusGetTime() - timestamp}  ${utils.stringifyReduce(tx)} our offset: ${getNetworkTimeOffset()} loggingContext: ${loggingContext}`);
       this.statistics.incrementCounter("txRejected");
       nestedCountersInstance.countEvent("rejected", "transaction timestamp out of range");
       return { success: false, reason: "Transaction timestamp out of range", status: 400 };
@@ -1609,7 +1610,7 @@ class Shardus extends EventEmitter {
         }
       } else {
         // tx nonce is equal to account nonce
-        let result = await this._timestampAndQueueTransaction(tx, appData, global, noConsensus)
+        let result = await this._timestampAndQueueTransaction(tx, appData, global, noConsensus, 'immediateQueue')
 
         // start of timestamp logging
         if (logFlags.important_as_error) {

diff --git a/src/shardus/shardus-types.ts b/src/shardus/shardus-types.ts
@@ -943,6 +943,7 @@ export interface ServerConfiguration {
     // /** The number of network transactions to try to process per cycle from txAdd in cycle record */
     networkTransactionsToProcessPerCycle: number
     useAjvCycleRecordValidation: boolean
+    getTxTimestampTimeoutOffset?: number // default timeout is 5 seconds so this can be used to add or subtract time from that
   }
   /** Server IP configuration */
   ip?: {

diff --git a/src/state-manager/TransactionConsensus.ts b/src/state-manager/TransactionConsensus.ts
@@ -1889,7 +1889,10 @@ class TransactionConsenus {
             },
             serializeGetTxTimestampReq,
             deserializeGetTxTimestampResp,
-            {}
+            {},
+            '',
+            false,
+            this.config.p2p.getTxTimestampTimeoutOffset ?? 0
           )
 
           timestampReceipt = serialized_res

diff --git a/src/state-manager/TransactionQueue.ts b/src/state-manager/TransactionQueue.ts
@@ -1115,7 +1115,13 @@ class TransactionQueue {
           }
           // end of timestamp logging.
 
-          await this.stateManager.shardus._timestampAndQueueTransaction(item.tx, item.appData, item.global, item.noConsensus)
+          await this.stateManager.shardus._timestampAndQueueTransaction(
+            item.tx,
+            item.appData,
+            item.global,
+            item.noConsensus,
+            'nonceQueue'
+          )
 
           // start of timestamp logging
           if (logFlags.important_as_error) {