Merge pull request #56 from bitcoin-sv/feat/api-extension

Feat/api extension

Author: rohenaz

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file. The format
 
 ## Table of Contents
 
+- [1.1.10 - 2024-10-20](#119---2024-10-20)
 - [1.1.9 - 2024-10-01](#118---2024-10-01)
 - [1.1.8 - 2024-09-17](#118---2024-09-17)
 - [1.1.7 - 2024-09-10](#117---2024-09-10)
@@ -16,6 +17,34 @@ 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.1.10] - 2024-10-20
+  Big thanks for contributions from @wregulski
+
+  ### Changed
+  - `pubKey.ToDER()` now returns bytes
+  - `pubKey.ToHash()` is now `pubKey.Hash()` 
+  - `pubKey.SerializeCompressed()` is now `pubKey.Compressed()`
+  - `pubKey.SerializeUncompressed()` is now `pubKey.Uncompressed()`
+  - `pubKey.SerializeHybrid()` is now `pubKey.Hybrid()`
+  - updated `merklepath.go` to use new helper functions from `transaction.merkletreeparent.go`
+  
+  ### Added
+  - files `spv/verify.go`, `spv/verify_test.go` - chain tracker for whatsonchain.com
+    - `spv.Verify()` ensures transaction scripts, merkle paths and fees are valid
+    - `spv.VerifyScripts()` ensures transaction scripts are valid
+  - file `docs/examples/verify_transaction/verify_transaction.go`
+  - `publickey.ToDERHex()` returns a hex encoded public key
+  - `script.Chunks()` helper method for `DecodeScript(scriptBytes)`
+  - `script.PubKey()` returns a `*ec.PublicKey`
+  - `script.PubKeyHex()` returns a hex string
+  - `script.Address()` and `script.Addresses()` helpers
+  - file `transaction.merkletreeparent.go` which contains helper functions
+    - `transaction.MerkleTreeParentStr()`
+    - `transaction.MerkleTreeParentBytes()`
+    - `transaction.MerkleTreeParents()`
+  - file `transaction/chaintracker/whatsonchain.go`, `whatsonchain_test.go` - chain tracker for whatsonchain.com
+    - `chaintracker.NewWhatsOnChain` chaintracker
+
 ## [1.1.9] - 2024-10-01
   ### Changed
   - Updated readme

compat/bip32/derive.go

@@ -88,7 +88,7 @@ func (k *ExtendedKey) DerivePublicKeyFromPath(derivationPath string) ([]byte, er
 	if err != nil {
 		return nil, fmt.Errorf("failed to generate public key %w", err)
 	}
-	return pubKey.SerializeCompressed(), nil
+	return pubKey.Compressed(), nil
 }
 
 func childInt(child string) (uint32, error) {

compat/bip32/derive_test.go

@@ -198,7 +198,7 @@ func TestDerivePublicKeyFromPath(t *testing.T) {
 				require.NoError(t, err)
 				pubKey, err := xpubKey.ECPubKey()
 				require.NoError(t, err)
-				return pubKey.SerializeCompressed()
+				return pubKey.Compressed()
 			}(),
 			expectedErr: nil,
 		},
@@ -215,7 +215,7 @@ func TestDerivePublicKeyFromPath(t *testing.T) {
 				require.NoError(t, err)
 				pubKey, err := xpubKey.ECPubKey()
 				require.NoError(t, err)
-				return pubKey.SerializeCompressed()
+				return pubKey.Compressed()
 			}(),
 			expectedErr: nil,
 		},

compat/bip32/extendedkey.go

@@ -158,7 +158,7 @@ func (k *ExtendedKey) pubKeyBytes() []byte {
 		if len(k.pubKey) == 0 {
 			pkx, pky := ec.S256().ScalarBaseMult(k.key)
 			pubKey := ec.PublicKey{Curve: ec.S256(), X: pkx, Y: pky}
-			k.pubKey = pubKey.SerializeCompressed()
+			k.pubKey = pubKey.Compressed()
 		}
 	})
 
@@ -324,7 +324,7 @@ func (k *ExtendedKey) Child(i uint32) (*ExtendedKey, error) {
 		// childKey = serP(point(parse256(Il)) + parentKey)
 		childX, childY := ec.S256().Add(ilx, ily, pubKey.X, pubKey.Y)
 		pk := ec.PublicKey{Curve: ec.S256(), X: childX, Y: childY}
-		childKey = pk.SerializeCompressed()
+		childKey = pk.Compressed()
 	}
 
 	// The fingerprint of the parent for the derived child is the first 4

compat/bip32/hd_key_test.go

@@ -643,8 +643,8 @@ func TestGetPublicKeyFromHDKey(t *testing.T) {
 			t.Fatalf("%s Failed: [%v] inputted and was nil but not expected", t.Name(), test.input)
 		} else if publicKey != nil && test.expectedNil {
 			t.Fatalf("%s Failed: [%v] inputted and was NOT nil but expected to be nil", t.Name(), test.input)
-		} else if publicKey != nil && hex.EncodeToString(publicKey.SerializeCompressed()) != test.expectedKey {
-			t.Fatalf("%s Failed: [%v] inputted [%s] expected but got: %s", t.Name(), test.input, test.expectedKey, hex.EncodeToString(publicKey.SerializeCompressed()))
+		} else if publicKey != nil && hex.EncodeToString(publicKey.Compressed()) != test.expectedKey {
+			t.Fatalf("%s Failed: [%v] inputted [%s] expected but got: %s", t.Name(), test.input, test.expectedKey, hex.EncodeToString(publicKey.Compressed()))
 		}
 	}
 }
@@ -674,7 +674,7 @@ func ExampleGetPublicKeyFromHDKey() {
 		return
 	}
 
-	fmt.Printf("public key: %s", hex.EncodeToString(publicKey.SerializeCompressed()))
+	fmt.Printf("public key: %s", hex.EncodeToString(publicKey.Compressed()))
 	// Output:public key: 03a25f6c10eedcd41eebac22c6bbc5278690fa1aab3afc2bbe8f2277c85e5c5def
 }
 
@@ -856,10 +856,10 @@ func TestGetPublicKeysForPath(t *testing.T) {
 			t.Fatalf("%s Failed: [%v] [%d] inputted and was nil but not expected", t.Name(), test.input, test.inputNum)
 		} else if pubKeys != nil && test.expectedNil {
 			t.Fatalf("%s Failed: [%v] [%d] inputted and was NOT nil but expected to be nil", t.Name(), test.input, test.inputNum)
-		} else if pubKeys != nil && hex.EncodeToString(pubKeys[0].SerializeCompressed()) != test.expectedPubKey1 {
-			t.Fatalf("%s Failed: [%v] [%d] inputted key 1 [%s] expected but got: %s", t.Name(), test.input, test.inputNum, test.expectedPubKey1, hex.EncodeToString(pubKeys[0].SerializeCompressed()))
-		} else if pubKeys != nil && hex.EncodeToString(pubKeys[1].SerializeCompressed()) != test.expectedPubKey2 {
-			t.Fatalf("%s Failed: [%v] [%d] inputted key 2 [%s] expected but got: %s", t.Name(), test.input, test.inputNum, test.expectedPubKey2, hex.EncodeToString(pubKeys[1].SerializeCompressed()))
+		} else if pubKeys != nil && hex.EncodeToString(pubKeys[0].Compressed()) != test.expectedPubKey1 {
+			t.Fatalf("%s Failed: [%v] [%d] inputted key 1 [%s] expected but got: %s", t.Name(), test.input, test.inputNum, test.expectedPubKey1, hex.EncodeToString(pubKeys[0].Compressed()))
+		} else if pubKeys != nil && hex.EncodeToString(pubKeys[1].Compressed()) != test.expectedPubKey2 {
+			t.Fatalf("%s Failed: [%v] [%d] inputted key 2 [%s] expected but got: %s", t.Name(), test.input, test.inputNum, test.expectedPubKey2, hex.EncodeToString(pubKeys[1].Compressed()))
 		}
 	}
 }
@@ -890,7 +890,7 @@ func ExampleGetPublicKeysForPath() {
 		return
 	}
 
-	fmt.Printf("found [%d] keys! Key 1: %s Key 2: %s", len(publicKeys), hex.EncodeToString(publicKeys[0].SerializeCompressed()), hex.EncodeToString(publicKeys[1].SerializeCompressed()))
+	fmt.Printf("found [%d] keys! Key 1: %s Key 2: %s", len(publicKeys), hex.EncodeToString(publicKeys[0].Compressed()), hex.EncodeToString(publicKeys[1].Compressed()))
 	// Output:found [2] keys! Key 1: 03f87ac38fb0cfca12988b51a2f1cd3e85bb4aeb1b05f549682190ac8205a67d30 Key 2: 02e78303aeef1acce1347c6493fadc1914e6d85ef3189a8856afb3accd53fbd9c5
 }
 

compat/bsm/sign.go

@@ -2,6 +2,7 @@ package compat
 
 import (
 	"bytes"
+	"encoding/base64"
 	"errors"
 
 	ec "github.com/bitcoin-sv/go-sdk/primitives/ec"
@@ -43,3 +44,13 @@ func SignMessageWithCompression(privateKey *ec.PrivateKey, message []byte, sigRe
 	// Sign
 	return ec.SignCompact(ec.S256(), privateKey, messageHash, sigRefCompressedKey)
 }
+
+// SignMessageString signs the message and returns the signature as a base64-encoded string
+func SignMessageString(privateKey *ec.PrivateKey, message []byte) (string, error) {
+	sigBytes, err := SignMessageWithCompression(privateKey, message, true)
+	if err != nil {
+		return "", err
+	}
+
+	return base64.StdEncoding.EncodeToString(sigBytes), nil
+}

compat/bsm/sign_test.go

@@ -31,7 +31,7 @@ func TestSigningCompression(t *testing.T) {
 	}
 }
 
-// TestSignMessage will test the method SignMessage()
+// TestSignMessage will test the method SignMessage() and SignMessageString()
 func TestSignMessage(t *testing.T) {
 	t.Parallel()
 	var tests = []struct {
@@ -108,14 +108,26 @@ func TestSignMessage(t *testing.T) {
 		},
 	}
 
+	const failedUnexpectedError = "%d %s Failed: [%s] [%s] inputted and error not expected but got: %s"
+	const failedExpectedError = "%d %s Failed: [%s] [%s] inputted and error was expected"
+	const failedExpectedSignature = "%d %s Failed: [%s] [%s] inputted [%s] expected but got: %s"
+
 	for idx, test := range tests {
 		testPk, errKey := ec.PrivateKeyFromHex(test.inputKey)
 		if signature, err := compat.SignMessage(testPk, []byte(test.inputMessage)); err != nil && !test.expectedError {
-			t.Fatalf("%d %s Failed: [%s] [%s] inputted and error not expected but got: %s", idx, t.Name(), test.inputKey, test.inputMessage, err.Error())
+			t.Fatalf(failedUnexpectedError, idx, t.Name(), test.inputKey, test.inputMessage, err.Error())
 		} else if err == nil && errKey == nil && test.expectedError {
-			t.Fatalf("%d %s Failed: [%s] [%s] inputted and error was expected", idx, t.Name(), test.inputKey, test.inputMessage)
+			t.Fatalf(failedExpectedError, idx, t.Name(), test.inputKey, test.inputMessage)
 		} else if base64.StdEncoding.EncodeToString(signature) != test.expectedSignature {
-			t.Fatalf("%d %s Failed: [%s] [%s] inputted [%s] expected but got: %s", idx, t.Name(), test.inputKey, test.inputMessage, test.expectedSignature, signature)
+			t.Fatalf(failedExpectedSignature, idx, t.Name(), test.inputKey, test.inputMessage, test.expectedSignature, signature)
+		}
+
+		if sigStr, err := compat.SignMessageString(testPk, []byte(test.inputMessage)); err != nil && !test.expectedError {
+			t.Fatalf(failedUnexpectedError, idx, t.Name(), test.inputKey, test.inputMessage, err.Error())
+		} else if err == nil && errKey == nil && test.expectedError {
+			t.Fatalf(failedExpectedError, idx, t.Name(), test.inputKey, test.inputMessage)
+		} else if sigStr != test.expectedSignature {
+			t.Fatalf(failedExpectedSignature, idx, t.Name(), test.inputKey, test.inputMessage, test.expectedSignature, sigStr)
 		}
 
 	}

compat/ecies/ecies.go

@@ -75,7 +75,7 @@ func ElectrumEncrypt(message []byte,
 
 	// Derive ECDH key
 	x, y := toPublicKey.Curve.ScalarMult(toPublicKey.X, toPublicKey.Y, ephemeralPrivateKey.D.Bytes())
-	ecdhKey := (&ec.PublicKey{X: x, Y: y}).SerializeCompressed()
+	ecdhKey := (&ec.PublicKey{X: x, Y: y}).Compressed()
 
 	// SHA512(ECDH_KEY)
 	key := c.Sha512(ecdhKey)
@@ -94,7 +94,7 @@ func ElectrumEncrypt(message []byte,
 		encrypted = append([]byte("BIE1"), cipherText...)
 	} else {
 		// encrypted = magic_bytes(4 bytes) + ephemeral_public_key(33 bytes) + cipher
-		encrypted = append(append([]byte("BIE1"), ephemeralPublicKey.SerializeCompressed()...), cipherText...)
+		encrypted = append(append([]byte("BIE1"), ephemeralPublicKey.Compressed()...), cipherText...)
 	}
 
 	mac := c.Sha256HMAC(encrypted, keyM)
@@ -119,7 +119,7 @@ func ElectrumDecrypt(encryptedData []byte, toPrivateKey *ec.PrivateKey, fromPubl
 	if fromPublicKey != nil {
 		// Use counterparty public key to derive shared secret
 		x, y := toPrivateKey.Curve.ScalarMult(fromPublicKey.X, fromPublicKey.Y, toPrivateKey.D.Bytes())
-		sharedSecret = (&ec.PublicKey{X: x, Y: y}).SerializeCompressed()
+		sharedSecret = (&ec.PublicKey{X: x, Y: y}).Compressed()
 		if len(encryptedData) > 69 { // 4 (magic) + 33 (pubkey) + 32 (mac)
 			cipherText = encryptedData[37 : len(encryptedData)-32]
 		} else {
@@ -132,7 +132,7 @@ func ElectrumDecrypt(encryptedData []byte, toPrivateKey *ec.PrivateKey, fromPubl
 			return nil, err
 		}
 		x, y := ephemeralPublicKey.Curve.ScalarMult(ephemeralPublicKey.X, ephemeralPublicKey.Y, toPrivateKey.D.Bytes())
-		sharedSecret = (&ec.PublicKey{X: x, Y: y}).SerializeCompressed()
+		sharedSecret = (&ec.PublicKey{X: x, Y: y}).Compressed()
 		cipherText = encryptedData[37 : len(encryptedData)-32]
 	}
 
@@ -172,7 +172,7 @@ func BitcoreEncrypt(message []byte,
 		fromPrivateKey, _ = ec.NewPrivateKey()
 	}
 
-	RBuf := fromPrivateKey.PubKey().ToDERBytes()
+	RBuf := fromPrivateKey.PubKey().ToDER()
 	P := toPublicKey.Mul(fromPrivateKey.D)
 
 	Sbuf := P.X.Bytes()

docs/examples/keyshares_pk_to_backup/to_backup.go

@@ -9,7 +9,7 @@ import (
 
 func main() {
 	pk, _ := ec.PrivateKeyFromWif("KxPEP4DCP2a4g3YU5amfXjFH4kWmz8EHWrTugXocGWgWBbhGsX7a")
-	log.Println("Private key:", hex.EncodeToString(pk.PubKey().ToHash())[:8])
+	log.Println("Private key:", hex.EncodeToString(pk.PubKey().Hash())[:8])
 	totalShares := 5
 	threshold := 3
 	shares, _ := pk.ToBackupShares(threshold, totalShares)

docs/examples/verify_beef/verify_beef.go

@@ -1,17 +1,10 @@
 package main
 
 import (
-	"github.com/bitcoin-sv/go-sdk/chainhash"
+	"github.com/bitcoin-sv/go-sdk/spv"
 	"github.com/bitcoin-sv/go-sdk/transaction"
 )
 
-type GullibleHeadersClient struct{}
-
-func (g *GullibleHeadersClient) IsValidRootForHeight(merkleRoot *chainhash.Hash, height uint32) bool {
-	// DO NOT USE IN A REAL PROJECT due to security risks of accepting any merkle root as valid without verification
-	return true
-}
-
 // Replace with the BEEF structure you'd like to check
 const BEEFHex = "0100beef01fe636d0c0007021400fe507c0c7aa754cef1f7889d5fd395cf1f785dd7de98eed895dbedfe4e5bc70d1502ac4e164f5bc16746bb0868404292ac8318bbac3800e4aad13a014da427adce3e010b00bc4ff395efd11719b277694cface5aa50d085a0bb81f613f70313acd28cf4557010400574b2d9142b8d28b61d88e3b2c3f44d858411356b49a28a4643b6d1a6a092a5201030051a05fc84d531b5d250c23f4f886f6812f9fe3f402d61607f977b4ecd2701c19010000fd781529d58fc2523cf396a7f25440b409857e7e221766c57214b1d38c7b481f01010062f542f45ea3660f86c013ced80534cb5fd4c19d66c56e7e8c5d4bf2d40acc5e010100b121e91836fd7cd5102b654e9f72f3cf6fdbfd0b161c53a9c54b12c841126331020100000001cd4e4cac3c7b56920d1e7655e7e260d31f29d9a388d04910f1bbd72304a79029010000006b483045022100e75279a205a547c445719420aa3138bf14743e3f42618e5f86a19bde14bb95f7022064777d34776b05d816daf1699493fcdf2ef5a5ab1ad710d9c97bfb5b8f7cef3641210263e2dee22b1ddc5e11f6fab8bcd2378bdd19580d640501ea956ec0e786f93e76ffffffff013e660000000000001976a9146bfd5c7fbe21529d45803dbcf0c87dd3c71efbc288ac0000000001000100000001ac4e164f5bc16746bb0868404292ac8318bbac3800e4aad13a014da427adce3e000000006a47304402203a61a2e931612b4bda08d541cfb980885173b8dcf64a3471238ae7abcd368d6402204cbf24f04b9aa2256d8901f0ed97866603d2be8324c2bfb7a37bf8fc90edd5b441210263e2dee22b1ddc5e11f6fab8bcd2378bdd19580d640501ea956ec0e786f93e76ffffffff013c660000000000001976a9146bfd5c7fbe21529d45803dbcf0c87dd3c71efbc288ac0000000000"
 
@@ -22,6 +15,6 @@ func main() {
 		panic(err)
 	}
 	// This ensures the BEEF structure is legitimate
-	verified, _ := tx.MerklePath.Verify(tx.TxID(), &GullibleHeadersClient{})
+	verified, _ := tx.MerklePath.Verify(tx.TxID(), &spv.GullibleHeadersClient{})
 	println(verified)
 }