Merge pull request #197 from b-open-io/update/chaintracker-context

rohenaz · web-flow · commit c6e7b9d9783d · 2025-06-30T11:49:29.000-04:00
Add context parameter to ChainTracker interface
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file. The format
 
 ## Table of Contents
 
+- [1.2.4 - 2025-06-30](#124---2025-06-30)
 - [1.2.3 - 2025-06-30](#123---2025-06-30)
 - [1.2.2 - 2025-06-27](#122---2025-06-27)
 - [1.2.1 - 2025-06-12](#121---2025-06-12)
@@ -38,6 +39,15 @@ All notable changes to this project will be documented in this file. The format
 - [1.1.0 - 2024-08-19](#110---2024-08-19)
 - [1.0.0 - 2024-06-06](#100---2024-06-06)
 
+## [1.2.4] - 2025-06-30
+
+### Changed
+- Add context parameter to ChainTracker.IsValidRootForHeight for cancellation/timeout support
+- Update all ChainTracker implementations to take context (WhatsOnChain, HeadersClient, GullibleHeadersClient)
+- Update MerklePath.Verify and VerifyHex to take context
+- Update BEEF.Verify to take context
+- Update spv.Verify and VerifyScripts to take context
+
 ## [1.2.3] - 2025-06-30
 
 ### Added
diff --git a/docs/examples/validate_spv/validate_spv.go b/docs/examples/validate_spv/validate_spv.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"encoding/base64"
 	"fmt"
 
@@ -32,7 +33,8 @@ func main() {
 		return
 	}
 
-	valid, err := client.IsValidRootForHeight(root, tx.MerklePath.BlockHeight)
+	ctx := context.Background()
+	valid, err := client.IsValidRootForHeight(ctx, root, tx.MerklePath.BlockHeight)
 	if err != nil {
 		fmt.Println("Error validating root for height:", err)
 		return
diff --git a/docs/examples/verify_beef/verify_beef.go b/docs/examples/verify_beef/verify_beef.go
@@ -1,6 +1,8 @@
 package main
 
 import (
+	"context"
+
 	"github.com/bsv-blockchain/go-sdk/spv"
 	"github.com/bsv-blockchain/go-sdk/transaction"
 )
@@ -15,6 +17,7 @@ func main() {
 		panic(err)
 	}
 	// This ensures the BEEF structure is legitimate
-	verified, _ := tx.MerklePath.Verify(tx.TxID(), &spv.GullibleHeadersClient{})
+	ctx := context.Background()
+	verified, _ := tx.MerklePath.Verify(ctx, tx.TxID(), &spv.GullibleHeadersClient{})
 	println(verified)
 }
diff --git a/docs/examples/verify_transaction/verify_transaction.go b/docs/examples/verify_transaction/verify_transaction.go
@@ -1,6 +1,8 @@
 package main
 
 import (
+	"context"
+
 	"github.com/bsv-blockchain/go-sdk/spv"
 	"github.com/bsv-blockchain/go-sdk/transaction"
 )
@@ -16,6 +18,7 @@ func main() {
 	}
 	// This ensures the BEEF structure is legitimate, the scripts are valid, and the merkle path is correct
 	// Also optionally verifies fees
-	verified, _ := spv.Verify(tx, &spv.GullibleHeadersClient{}, nil)
+	ctx := context.Background()
+	verified, _ := spv.Verify(ctx, tx, &spv.GullibleHeadersClient{}, nil)
 	println(verified)
 }
diff --git a/spv/scripts_only.go b/spv/scripts_only.go
@@ -8,7 +8,7 @@ import (
 
 type GullibleHeadersClient struct{}
 
-func (g *GullibleHeadersClient) IsValidRootForHeight(merkleRoot *chainhash.Hash, height uint32) (bool, error) {
+func (g *GullibleHeadersClient) IsValidRootForHeight(ctx context.Context, merkleRoot *chainhash.Hash, height uint32) (bool, error) {
 	// DO NOT USE IN A REAL PROJECT due to security risks of accepting any merkle root as valid without verification
 	return true, nil
 }
diff --git a/spv/verify.go b/spv/verify.go
@@ -1,14 +1,15 @@
 package spv
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/bsv-blockchain/go-sdk/script/interpreter"
 	"github.com/bsv-blockchain/go-sdk/transaction"
 	"github.com/bsv-blockchain/go-sdk/transaction/chaintracker"
 )
 
-func Verify(t *transaction.Transaction,
+func Verify(ctx context.Context, t *transaction.Transaction,
 	chainTracker chaintracker.ChainTracker,
 	feeModel transaction.FeeModel) (bool, error) {
 	verifiedTxids := make(map[string]struct{})
@@ -28,7 +29,7 @@ func Verify(t *transaction.Transaction,
 		}
 
 		if tx.MerklePath != nil {
-			if isValid, err := tx.MerklePath.Verify(txid, chainTracker); err != nil {
+			if isValid, err := tx.MerklePath.Verify(ctx, txid, chainTracker); err != nil {
 				return false, err
 			} else if isValid {
 				verifiedTxids[txidStr] = struct{}{}
@@ -80,6 +81,6 @@ func Verify(t *transaction.Transaction,
 	return true, nil
 }
 
-func VerifyScripts(t *transaction.Transaction) (bool, error) {
-	return Verify(t, &GullibleHeadersClient{}, nil)
+func VerifyScripts(ctx context.Context, t *transaction.Transaction) (bool, error) {
+	return Verify(ctx, t, &GullibleHeadersClient{}, nil)
 }
diff --git a/spv/verify_test.go b/spv/verify_test.go
@@ -17,7 +17,8 @@ const BEEF = "AQC+7wH+kQYNAAcCVAIKXThHm90iVbs15AIfFQEYl5xesbHCXMkYy9SqoR1vNVUAAZ
 func TestSPVVerify(t *testing.T) {
 	tx, err := transaction.NewTransactionFromBEEFHex(BRC62Hex)
 	require.NoError(t, err)
-	verified, err := Verify(tx, &GullibleHeadersClient{}, nil)
+	ctx := t.Context()
+	verified, err := Verify(ctx, tx, &GullibleHeadersClient{}, nil)
 	require.NoError(t, err)
 	require.True(t, verified)
 }
@@ -27,7 +28,8 @@ func TestSPVVerifyScripts(t *testing.T) {
 	require.NoError(t, err)
 	tx, err := transaction.NewTransactionFromBEEF(buf)
 	require.NoError(t, err)
-	verified, err := VerifyScripts(tx)
+	ctx := t.Context()
+	verified, err := VerifyScripts(ctx, tx)
 	require.NoError(t, err)
 	require.True(t, verified)
 }
@@ -40,7 +42,8 @@ func TestSPVVerifyWithSufficientFee(t *testing.T) {
 		Satoshis: 10,
 	}
 
-	verified, err := Verify(tx, &GullibleHeadersClient{}, feeModel)
+	ctx := t.Context()
+	verified, err := Verify(ctx, tx, &GullibleHeadersClient{}, feeModel)
 	require.NoError(t, err)
 	require.True(t, verified)
 }
@@ -53,7 +56,8 @@ func TestSPVVerifyWithInsufficientFee(t *testing.T) {
 		Satoshis: 1,
 	}
 
-	verified, err := Verify(tx, &GullibleHeadersClient{}, feeModel)
+	ctx := t.Context()
+	verified, err := Verify(ctx, tx, &GullibleHeadersClient{}, feeModel)
 	require.Error(t, err)
 	require.Contains(t, err.Error(), "fee is too low")
 	require.False(t, verified)
diff --git a/transaction/beef.go b/transaction/beef.go
@@ -2,6 +2,7 @@ package transaction
 
 import (
 	"bytes"
+	"context"
 	"encoding/binary"
 	"encoding/hex"
 	"fmt"
@@ -780,7 +781,7 @@ func (b *Beef) IsValid(allowTxidOnly bool) bool {
 	return r.valid
 }
 
-func (b *Beef) Verify(chainTracker chaintracker.ChainTracker, allowTxidOnly bool) (bool, error) {
+func (b *Beef) Verify(ctx context.Context, chainTracker chaintracker.ChainTracker, allowTxidOnly bool) (bool, error) {
 	r := b.verifyValid(allowTxidOnly)
 	if !r.valid {
 		return false, nil
@@ -790,7 +791,7 @@ func (b *Beef) Verify(chainTracker chaintracker.ChainTracker, allowTxidOnly bool
 		if err != nil {
 			return false, err
 		}
-		ok, err := chainTracker.IsValidRootForHeight(h, height)
+		ok, err := chainTracker.IsValidRootForHeight(ctx, h, height)
 		if err != nil || !ok {
 			return false, err
 		}
diff --git a/transaction/chaintracker/chaintracker.go b/transaction/chaintracker/chaintracker.go
@@ -7,6 +7,6 @@ import (
 )
 
 type ChainTracker interface {
-	IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error)
+	IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error)
 	CurrentHeight(ctx context.Context) (uint32, error)
 }
diff --git a/transaction/chaintracker/headers_client/headers_client.go b/transaction/chaintracker/headers_client/headers_client.go
@@ -34,7 +34,7 @@ type Client struct {
 	ApiKey string
 }
 
-func (c Client) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error) {
+func (c Client) IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error) {
 	type requestBody struct {
 		MerkleRoot  string `json:"merkleRoot"`
 		BlockHeight uint32 `json:"blockHeight"`
@@ -46,7 +46,7 @@ func (c Client) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool,
 		return false, fmt.Errorf("error marshaling JSON: %v", err)
 	}
 
-	req, err := http.NewRequest("POST", c.Url+"/api/v1/chain/merkleroot/verify", bytes.NewBuffer(jsonPayload))
+	req, err := http.NewRequestWithContext(ctx, "POST", c.Url+"/api/v1/chain/merkleroot/verify", bytes.NewBuffer(jsonPayload))
 	if err != nil {
 		return false, fmt.Errorf("error creating request: %v", err)
 	}
diff --git a/transaction/chaintracker/whatsonchain.go b/transaction/chaintracker/whatsonchain.go
@@ -48,9 +48,9 @@ func NewWhatsOnChain(network Network, apiKey string) *WhatsOnChain {
 }
 
 // Assuming BlockHeader is defined elsewhere
-func (w *WhatsOnChain) GetBlockHeader(height uint32) (header *BlockHeader, err error) {
+func (w *WhatsOnChain) GetBlockHeader(ctx context.Context, height uint32) (header *BlockHeader, err error) {
 	url := fmt.Sprintf("%s/block/%d/header", w.baseURL, height)
-	req, err := http.NewRequestWithContext(context.Background(), "GET", url, nil)
+	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -78,8 +78,8 @@ func (w *WhatsOnChain) GetBlockHeader(height uint32) (header *BlockHeader, err e
 	return header, nil
 }
 
-func (w *WhatsOnChain) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error) {
-	if header, err := w.GetBlockHeader(height); err != nil {
+func (w *WhatsOnChain) IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error) {
+	if header, err := w.GetBlockHeader(ctx, height); err != nil {
 		return false, err
 	} else {
 		return header.MerkleRoot.IsEqual(root), nil
@@ -89,7 +89,7 @@ func (w *WhatsOnChain) IsValidRootForHeight(root *chainhash.Hash, height uint32)
 // Assuming BlockHeader is defined elsewhere
 func (w *WhatsOnChain) CurrentHeight(ctx context.Context) (height uint32, err error) {
 	url := fmt.Sprintf("%s/chain/info", w.baseURL)
-	req, err := http.NewRequestWithContext(context.Background(), "GET", url, nil)
+	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
 	if err != nil {
 		return
 	}
diff --git a/transaction/chaintracker/whatsonchain_test.go b/transaction/chaintracker/whatsonchain_test.go
@@ -53,7 +53,8 @@ func TestWhatsOnChainGetBlockHeaderSuccess(t *testing.T) {
 		client:  ts.Client(),
 	}
 
-	header, err := woc.GetBlockHeader(100)
+	ctx := t.Context()
+	header, err := woc.GetBlockHeader(ctx, 100)
 	if err != nil {
 		t.Fatalf("expected no error, got %v", err)
 		return // Add this return statement
@@ -81,7 +82,8 @@ func TestWhatsOnChainGetBlockHeaderNotFound(t *testing.T) {
 		client:  ts.Client(),
 	}
 
-	header, err := woc.GetBlockHeader(100)
+	ctx := t.Context()
+	header, err := woc.GetBlockHeader(ctx, 100)
 	if err != nil {
 		t.Fatalf("expected no error, got %v", err)
 	}
@@ -105,7 +107,8 @@ func TestWhatsOnChainGetBlockHeaderErrorResponse(t *testing.T) {
 		client:  ts.Client(),
 	}
 
-	header, err := woc.GetBlockHeader(100)
+	ctx := t.Context()
+	header, err := woc.GetBlockHeader(ctx, 100)
 	if err == nil {
 		t.Fatalf("expected error, got nil")
 	}
@@ -136,7 +139,8 @@ func TestWhatsOnChainIsValidRootForHeightSuccess(t *testing.T) {
 		client:  ts.Client(),
 	}
 
-	isValid, err := woc.IsValidRootForHeight(&merkleRootHash, 100)
+	ctx := t.Context()
+	isValid, err := woc.IsValidRootForHeight(ctx, &merkleRootHash, 100)
 	if err != nil {
 		t.Fatalf("expected no error, got %v", err)
 	}
@@ -168,7 +172,8 @@ func TestWhatsOnChainIsValidRootForHeightInvalidRoot(t *testing.T) {
 		client:  ts.Client(),
 	}
 
-	isValid, err := woc.IsValidRootForHeight(&differentMerkleRootHash, 100)
+	ctx := t.Context()
+	isValid, err := woc.IsValidRootForHeight(ctx, &differentMerkleRootHash, 100)
 	if err != nil {
 		t.Fatalf("expected no error, got %v", err)
 	}
diff --git a/transaction/merklepath.go b/transaction/merklepath.go
@@ -2,6 +2,7 @@ package transaction
 
 import (
 	"bytes"
+	"context"
 	"encoding/binary"
 	"encoding/hex"
 	"fmt"
@@ -263,20 +264,20 @@ func (mp *MerklePath) ComputeRoot(txid *chainhash.Hash) (*chainhash.Hash, error)
 
 // Verify checks if a given transaction ID is part of the Merkle tree
 // at the specified block height using a chain tracker
-func (mp *MerklePath) VerifyHex(txidStr string, ct chaintracker.ChainTracker) (bool, error) {
+func (mp *MerklePath) VerifyHex(ctx context.Context, txidStr string, ct chaintracker.ChainTracker) (bool, error) {
 	if txid, err := chainhash.NewHashFromHex(txidStr); err != nil {
 		return false, err
 	} else {
-		return mp.Verify(txid, ct)
+		return mp.Verify(ctx, txid, ct)
 	}
 }
 
-func (mp *MerklePath) Verify(txid *chainhash.Hash, ct chaintracker.ChainTracker) (bool, error) {
+func (mp *MerklePath) Verify(ctx context.Context, txid *chainhash.Hash, ct chaintracker.ChainTracker) (bool, error) {
 	root, err := mp.ComputeRoot(txid)
 	if err != nil {
 		return false, err
 	}
-	return ct.IsValidRootForHeight(root, mp.BlockHeight)
+	return ct.IsValidRootForHeight(ctx, root, mp.BlockHeight)
 }
 
 func (m *MerklePath) Combine(other *MerklePath) (err error) {
diff --git a/transaction/merklepath_test.go b/transaction/merklepath_test.go
@@ -97,7 +97,7 @@ func TestMerklePathComputeRootHex(t *testing.T) {
 type MyChainTracker struct{}
 
 // Implement the IsValidRootForHeight method on MyChainTracker.
-func (mct MyChainTracker) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error) {
+func (mct MyChainTracker) IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error) {
 	// Convert BRC74Root hex string to a byte slice for comparison
 	// expectedRoot, _ := hex.DecodeString(BRC74Root)
 
@@ -118,7 +118,8 @@ func TestMerklePath_Verify(t *testing.T) {
 			Path:        BRC74JSON.Path,
 		}
 		tracker := MyChainTracker{}
-		result, err := path.VerifyHex(BRC74TXID1, tracker)
+		ctx := t.Context()
+		result, err := path.VerifyHex(ctx, BRC74TXID1, tracker)
 		require.NoError(t, err)
 		require.True(t, result)
 	})

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`package main`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
	`5`	`+`
`4`	`6`	`"github.com/bsv-blockchain/go-sdk/spv"`
`5`	`7`	`"github.com/bsv-blockchain/go-sdk/transaction"`
`6`	`8`	`)`
`@@ -15,6 +17,7 @@ func main() {`
`15`	`17`	`panic(err)`
`16`	`18`	`}`
`17`	`19`	`// This ensures the BEEF structure is legitimate`
`18`		`- verified, _ := tx.MerklePath.Verify(tx.TxID(), &spv.GullibleHeadersClient{})`
	`20`	`+ ctx := context.Background()`
	`21`	`+ verified, _ := tx.MerklePath.Verify(ctx, tx.TxID(), &spv.GullibleHeadersClient{})`
`19`	`22`	`println(verified)`
`20`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`
`9`	`9`	`type GullibleHeadersClient struct{}`
`10`	`10`
`11`		`-func (g GullibleHeadersClient) IsValidRootForHeight(merkleRoot chainhash.Hash, height uint32) (bool, error) {`
	`11`	`+func (g GullibleHeadersClient) IsValidRootForHeight(ctx context.Context, merkleRoot chainhash.Hash, height uint32) (bool, error) {`
`12`	`12`	`// DO NOT USE IN A REAL PROJECT due to security risks of accepting any merkle root as valid without verification`
`13`	`13`	`return true, nil`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@ import (`
`7`	`7`	`)`
`8`	`8`
`9`	`9`	`type ChainTracker interface {`
`10`		`- IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error)`
	`10`	`+ IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error)`
`11`	`11`	`CurrentHeight(ctx context.Context) (uint32, error)`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ type Client struct {`
`34`	`34`	`ApiKey string`
`35`	`35`	`}`
`36`	`36`
`37`		`-func (c Client) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool, error) {`
	`37`	`+func (c Client) IsValidRootForHeight(ctx context.Context, root *chainhash.Hash, height uint32) (bool, error) {`
`38`	`38`	`type requestBody struct {`
`39`	`39`	MerkleRoot string `json:"merkleRoot"`
`40`	`40`	BlockHeight uint32 `json:"blockHeight"`
`@@ -46,7 +46,7 @@ func (c Client) IsValidRootForHeight(root *chainhash.Hash, height uint32) (bool,`
`46`	`46`	`return false, fmt.Errorf("error marshaling JSON: %v", err)`
`47`	`47`	`}`
`48`	`48`
`49`		`- req, err := http.NewRequest("POST", c.Url+"/api/v1/chain/merkleroot/verify", bytes.NewBuffer(jsonPayload))`
	`49`	`+ req, err := http.NewRequestWithContext(ctx, "POST", c.Url+"/api/v1/chain/merkleroot/verify", bytes.NewBuffer(jsonPayload))`
`50`	`50`	`if err != nil {`
`51`	`51`	`return false, fmt.Errorf("error creating request: %v", err)`
`52`	`52`	`}`