@bsv/sdk 1.2.18 → 1.2.19

package/docs/transaction.md

@@ -160,12 +160,16 @@ const chainTracker = {
   isValidRootForHeight: async (root, height) => {
     // Implementation to check if the Merkle root is valid for the specified block height.
   }
+ currentHeight: async () => {
+   // Implementation to get the current block height.
+ }
 };
 ```
 
 ```ts
 export default interface ChainTracker {
     isValidRootForHeight: (root: string, height: number) => Promise<boolean>;
+    currentHeight: () => Promise<number>;
 }
 ```
 
@@ -1101,7 +1105,7 @@ isParty(party: string)
 
 Returns
 
-`true` if `party` has already beed added to this `BeefParty`.
+`true` if `party` has already been added to this `BeefParty`.
 
 #### Method mergeBeefFromParty
 
@@ -2076,6 +2080,7 @@ export default class WhatsOnChain implements ChainTracker {
     readonly apiKey: string;
     constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {}) 
     async isValidRootForHeight(root: string, height: number): Promise<boolean> 
+    async currentHeight(): Promise<number> 
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.2.18",
+  "version": "1.2.19",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/transaction/ChainTracker.ts

@@ -10,13 +10,19 @@
  * @function isValidRootForHeight - A method to verify the validity of a Merkle root
  *          for a given block height.
  *
+ * @function currentHeight - A method to get the current block height.
+ *
  * @example
  * const chainTracker = {
  *   isValidRootForHeight: async (root, height) => {
  *     // Implementation to check if the Merkle root is valid for the specified block height.
  *   }
+ *  currentHeight: async () => {
+*     // Implementation to get the current block height.
+*   }
  * };
  */
 export default interface ChainTracker {
   isValidRootForHeight: (root: string, height: number) => Promise<boolean>
+  currentHeight: () => Promise<number>
 }

package/src/transaction/MerklePath.ts

@@ -192,6 +192,11 @@ export default class MerklePath {
     return toHex(this.toBinary())
   }
 
+  //
+  private indexOf (txid: string): number {
+    return this.path[0].find(l => l.hash === txid).offset
+  }
+
   /**
    * Computes the Merkle root from the provided transaction ID.
    *
@@ -204,7 +209,7 @@ export default class MerklePath {
       txid = this.path[0].find(leaf => Boolean(leaf?.hash)).hash
     }
     // Find the index of the txid at the lowest level of the Merkle tree
-    const index = this.path[0].find(l => l.hash === txid).offset
+    const index = this.indexOf(txid)
     if (typeof index !== 'number') {
       throw new Error(`This proof does not contain the txid: ${txid}`)
     }
@@ -282,6 +287,13 @@ export default class MerklePath {
    */
   async verify (txid: string, chainTracker: ChainTracker): Promise<boolean> {
     const root = this.computeRoot(txid)
+    if (this.indexOf(txid) === 0) {
+      // Coinbase transaction outputs can only be spent once they're 100 blocks deep.
+      const height = await chainTracker.currentHeight()
+      if (this.blockHeight + 100 < height) {
+        return false
+      }
+    }
     // Use the chain tracker to determine whether this is a valid merkle root at the given block height
     return await chainTracker.isValidRootForHeight(root, this.blockHeight)
   }

package/src/transaction/__tests/MerklePath.test.ts

@@ -1,4 +1,5 @@
-import MerklePath from '../../../dist/cjs/src/transaction/MerklePath'
+import ChainTracker from '../ChainTracker'
+import MerklePath from '../../../dist/cjs/src/transaction/MerklePath.js'
 import invalidBumps from './bump.invalid.vectors'
 import validBumps from './bump.valid.vectors'
 
@@ -111,6 +112,15 @@ const BRC74TXID1 = '304e737fdfcb017a1a322e78b067ecebb5e07b44f0a36ed1f01264d2014f
 const BRC74TXID2 = 'd888711d588021e588984e8278a2decf927298173a06737066e43f3e75534e00'
 const BRC74TXID3 = '98c9c5dd79a18f40837061d5e0395ffb52e700a2689e641d19f053fc9619445e'
 
+class FakeChainTracker implements ChainTracker {
+  async isValidRootForHeight (root: string, height: number): Promise<boolean> {
+    return root === 'd5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02' && height === 10000
+  }
+  async currentHeight (): Promise<number> {
+    return 10100
+  }
+}
+
 describe('MerklePath', () => {
   it('Parses from hex', () => {
     const path = MerklePath.fromHex(BRC74Hex)
@@ -129,7 +139,8 @@ describe('MerklePath', () => {
   it('Verifies using a ChainTracker', async () => {
     const path = new MerklePath(BRC74JSON.blockHeight, BRC74JSON.path)
     const tracker = {
-      isValidRootForHeight: jest.fn((root, height) => root === BRC74Root && height === BRC74JSON.blockHeight)
+      isValidRootForHeight: jest.fn(async (root, height) => root === BRC74Root && height === BRC74JSON.blockHeight),
+      currentHeight: jest.fn(async () => 2029209)
     }
     const result = await path.verify(BRC74TXID1, tracker)
     expect(result).toBe(true)
@@ -192,4 +203,14 @@ describe('MerklePath', () => {
   it('Creates a valid MerklePath from a txid', () => {
     expect(() => MerklePath.fromCoinbaseTxidAndHeight('d5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02', 1)).not.toThrowError()
   })
+  it('Valid for Coinbase if currentHeight is more than 100 blocks prior', async () => {
+    const mp = MerklePath.fromCoinbaseTxidAndHeight('d5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02', 10000)
+    const isValid = await mp.verify('d5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02', new FakeChainTracker())
+    expect(isValid).toBe(true)
+  })
+  it('Invalid for Coinbase if currentheight is less than 100 blocks prior ', async () => {
+    const mp = MerklePath.fromCoinbaseTxidAndHeight('d5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02', 10099)
+    const isValid = await mp.verify('d5377a7aba0c0e0dbaef230f8917217b453484c83579e11a14c8299faa57ef02', new FakeChainTracker())
+    expect(isValid).toBe(false)
+  })
 })

package/src/transaction/chaintrackers/WhatsOnChain.ts

@@ -40,7 +40,7 @@ export default class WhatsOnChain implements ChainTracker {
   async isValidRootForHeight (root: string, height: number): Promise<boolean> {
     const requestOptions = {
       method: 'GET',
-      headers: this.getHeaders()
+      headers: this.getHttpHeaders()
     }
 
     const response = await this.httpClient.request<WhatsOnChainBlockHeader>(`${this.URL}/block/${height}/header`, requestOptions)
@@ -54,7 +54,25 @@ export default class WhatsOnChain implements ChainTracker {
     }
   }
 
-  private getHeaders () {
+  async currentHeight (): Promise<number> {
+    try {
+      const requestOptions = {
+        method: 'GET',
+        headers: this.getHttpHeaders()
+      }
+
+      const response = await this.httpClient.request<{ height: number }>(`${this.URL}/block/headers`, requestOptions)
+      if (response.ok) {
+        return response.data[0].height
+      } else {
+        throw new Error(`Failed to get current height because of an error: ${JSON.stringify(response.data)} `)
+      }
+    } catch (error) {
+      throw new Error(`Failed to get current height because of an error: ${error?.message}`)
+    }
+  }
+
+  private getHttpHeaders () {
     const headers: Record<string, string> = {
       Accept: 'application/json'
     }

package/src/transaction/chaintrackers/__tests/WhatsOnChainChainTracker.test.ts

@@ -29,7 +29,7 @@ describe('WhatsOnChain ChainTracker', () => {
   it('should verify merkleroot successfully using Node.js https', async () => {
     // Mocking Node.js https module
     mockedHttps(successResponse)
-    delete global.window
+    if (global.window) global.window = {} as any
 
     const chainTracker = new WhatsOnChain(network)
     const response = await chainTracker.isValidRootForHeight(merkleroot, height)
@@ -87,6 +87,37 @@ describe('WhatsOnChain ChainTracker', () => {
     await expect(chainTracker.isValidRootForHeight(merkleroot, height)).rejects.toThrow(/Failed to verify merkleroot for height \d+ because of an error: .*/)
   })
 
+  it('should return the current height', async () => {
+    const mockFetch = mockedFetch({
+      status: 200,
+      data: [
+        {
+          hash: '00000000000000000af9958a79fd4dbac1b04a553cc00c80e108718561ccb5a5',
+          confirmations: 1,
+          size: 29605652,
+          height: 875904,
+          version: 704643072,
+          versionHex: '2a000000',
+          merkleroot: '8af5a2d4325ec30e30103b1f365c303d4b49d11e42d26b0d7e9b6866724392e9',
+          time: 1734667612,
+          mediantime: 1734663717,
+          nonce: 157007350,
+          bits: '180f2b74',
+          difficulty: 72479484799.59058,
+          chainwork: '00000000000000000000000000000000000000000160c2f41c8793b90f4500dd',
+          previousblockhash: '00000000000000000128f312a7c62ef5f9a91a3f845a4464d10cfbaaecd233a0',
+          nextblockhash: '',
+          nTx: 0,
+          num_tx: 167567
+        }
+      ]
+    })
+
+    const chainTracker = new WhatsOnChain(network, { httpClient: new FetchHttpClient(mockFetch) })
+
+    await expect(await chainTracker.currentHeight()).toBe(875904)
+  })
+
   function mockedFetch (response) {
     return jest.fn().mockResolvedValue({
       ok: response.status === 200,