@bsv/wallet-toolbox 1.4.0 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/monitor/tasks/TaskCheckForProofs.ts

@@ -50,6 +50,11 @@ export class TaskCheckForProofs extends WalletMonitorTask {
     const countsAsAttempt = TaskCheckForProofs.checkNow
     TaskCheckForProofs.checkNow = false
 
+    const maxAcceptableHeight = this.monitor.lastNewHeader?.height
+    if (maxAcceptableHeight === undefined) {
+      return log
+    }
+
     const limit = 100
     let offset = 0
     for (;;) {
@@ -60,7 +65,7 @@ export class TaskCheckForProofs extends WalletMonitorTask {
       })
       if (reqs.length === 0) break
       log += `${reqs.length} reqs with status 'callback', 'unmined', 'sending', 'unknown', or 'unconfirmed'\n`
-      const r = await getProofs(this, reqs, 2, countsAsAttempt)
+      const r = await getProofs(this, reqs, 2, countsAsAttempt, false, maxAcceptableHeight)
       log += `${r.log}\n`
       //console.log(log);
       if (reqs.length < limit) break
@@ -90,7 +95,8 @@ export async function getProofs(
   reqs: TableProvenTxReq[],
   indent = 0,
   countsAsAttempt = false,
-  ignoreStatus = false
+  ignoreStatus = false,
+  maxAcceptableHeight: number
 ): Promise<{
   proven: TableProvenTxReq[]
   invalid: TableProvenTxReq[]
@@ -179,6 +185,11 @@ export async function getProofs(
     // one more time.
     //
     r = await task.monitor.services.getMerklePath(req.txid)
+    if (r.header && r.header.height > maxAcceptableHeight) {
+      // Ignore proofs from bleeding edge of new blocks as these are the most often re-orged.
+      log += ` ignoring possible proof from very new block at height ${r.header.height} ${r.header.hash}\n`
+      continue
+    }
     ptx = await EntityProvenTx.fromReq(req, r, countsAsAttempt && req.status !== 'nosend')
 
     if (ptx) {

package/src/monitor/tasks/TaskCheckNoSends.ts

@@ -47,6 +47,12 @@ export class TaskCheckNoSends extends WalletMonitorTask {
     const countsAsAttempt = TaskCheckNoSends.checkNow
     TaskCheckNoSends.checkNow = false
 
+    const maxAcceptableHeight = this.monitor.lastNewHeader?.height
+    if (maxAcceptableHeight === undefined) {
+      return log
+    }
+
+
     const limit = 100
     let offset = 0
     for (;;) {
@@ -57,7 +63,7 @@ export class TaskCheckNoSends extends WalletMonitorTask {
       })
       if (reqs.length === 0) break
       log += `${reqs.length} reqs with status 'nosend'\n`
-      const r = await getProofs(this, reqs, 2, countsAsAttempt)
+      const r = await getProofs(this, reqs, 2, countsAsAttempt, false, maxAcceptableHeight)
       log += `${r.log}\n`
       //console.log(log);
       if (reqs.length < limit) break

package/src/monitor/tasks/TaskNewHeader.ts

@@ -2,9 +2,29 @@ import { BlockHeader } from '../../services/chaintracker/chaintracks/Api/BlockHe
 import { Monitor } from '../Monitor'
 import { WalletMonitorTask } from './WalletMonitorTask'
 
+/**
+ * This task polls for new block headers performing two essential functions:
+ * 1. The arrival of a new block is the right time to check for proofs for recently broadcast transactions.
+ * 2. The height of the block is used to limit which proofs are accepted with the aim of avoiding re-orged proofs.
+ * 
+ * The most common new block orphan is one which is almost immediately orphaned.
+ * Waiting a minute before pursuing proof requests avoids almost all the re-org work that could be done.
+ * Thus this task queues new headers for one cycle.
+ * If a new header arrives during that cycle, it replaces the queued header and delays again.
+ * Only when there is an elapsed cycle without a new header does proof solicitation get triggered,
+ * with that header height as the limit for which proofs are accepted.
+ */
 export class TaskNewHeader extends WalletMonitorTask {
   static taskName = 'NewHeader'
+  /**
+   * This is always the most recent chain tip header returned from the chaintracker.
+   */
   header?: BlockHeader
+  /**
+   * Tracks the value of `header` except that it is set to undefined
+   * when a cycle without a new header occurs and `processNewBlockHeader` is called.
+   */
+  queuedHeader?: BlockHeader
 
   constructor(
     monitor: Monitor,
@@ -38,7 +58,13 @@ export class TaskNewHeader extends WalletMonitorTask {
     } else {
       isNew = false
     }
-    if (isNew) this.monitor.processNewBlockHeader(this.header)
+    if (isNew) {
+      this.queuedHeader = this.header
+    } else if (this.queuedHeader) {
+      // Only process new block header if it has remained the chain tip for a full cycle
+      this.monitor.processNewBlockHeader(this.queuedHeader)
+      this.queuedHeader = undefined
+    }
     return log
   }
 }

package/test/monitor/Monitor.test.ts

@@ -143,6 +143,17 @@ describe('Monitor tests', () => {
     for (const { activeStorage: storage, monitor } of ctxs) {
       if (!monitor) throw new sdk.WERR_INTERNAL('test requires setup with monitor')
 
+      monitor.lastNewHeader = {
+        height: 999999999,
+        hash: '',
+        time: 0,
+        version: 0,
+        previousHash: '',
+        merkleRoot: '',
+        bits: 0,
+        nonce: 0
+      }
+
       {
         for (const txid of expectedTxids) {
           // no matching ProvenTx exists.