Add new validation interface callbacks

Author: stringintech

kernel/context_options.go

@@ -15,6 +15,9 @@ extern void go_notify_warning_unset_bridge(void* user_data, btck_Warning warning
 extern void go_notify_flush_error_bridge(void* user_data, const char* message, size_t message_len);
 extern void go_notify_fatal_error_bridge(void* user_data, const char* message, size_t message_len);
 extern void go_validation_interface_block_checked_bridge(void* user_data, btck_Block* block, const btck_BlockValidationState* state);
+extern void go_validation_interface_pow_valid_block_bridge(void* user_data, const btck_BlockTreeEntry* entry, btck_Block* block);
+extern void go_validation_interface_block_connected_bridge(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);
+extern void go_validation_interface_block_disconnected_bridge(void* user_data, btck_Block* block, const btck_BlockTreeEntry* entry);
 
 extern void go_delete_handle(void* user_data);
 */
@@ -89,9 +92,12 @@ func (opts *ContextOptions) SetNotifications(callbacks *NotificationCallbacks) {
 //   - callbacks: The callbacks used for passing validation information to the user.
 func (opts *ContextOptions) SetValidationInterface(callbacks *ValidationInterfaceCallbacks) {
 	validationCallbacks := C.btck_ValidationInterfaceCallbacks{
-		user_data:         unsafe.Pointer(cgo.NewHandle(callbacks)),
-		user_data_destroy: C.btck_DestroyCallback(C.go_delete_handle),
-		block_checked:     C.btck_ValidationInterfaceBlockChecked(C.go_validation_interface_block_checked_bridge),
+		user_data:          unsafe.Pointer(cgo.NewHandle(callbacks)),
+		user_data_destroy:  C.btck_DestroyCallback(C.go_delete_handle),
+		block_checked:      C.btck_ValidationInterfaceBlockChecked(C.go_validation_interface_block_checked_bridge),
+		pow_valid_block:    C.btck_ValidationInterfacePowValidBlock(C.go_validation_interface_pow_valid_block_bridge),
+		block_connected:    C.btck_ValidationInterfaceBlockConnected(C.go_validation_interface_block_connected_bridge),
+		block_disconnected: C.btck_ValidationInterfaceBlockDisconnected(C.go_validation_interface_block_disconnected_bridge),
 	}
 	C.btck_context_options_set_validation_interface((*C.btck_ContextOptions)(opts.ptr), validationCallbacks)
 }

kernel/validation_interface_callbacks.go

@@ -9,9 +9,14 @@ import (
 	"unsafe"
 )
 
-// ValidationInterfaceCallbacks contains all the Go callback function types for validation interface.
+// ValidationInterfaceCallbacks holds the validation interface callbacks.
+//
+// Note that these callbacks block any further validation execution when they are called.
 type ValidationInterfaceCallbacks struct {
-	OnBlockChecked func(block *Block, state *BlockValidationState)
+	OnBlockChecked      func(block *Block, state *BlockValidationState) // Called when a new block has been fully validated. Contains the result of its validation.
+	OnPowValidBlock     func(entry *BlockTreeEntry, block *Block)       // Called when a new block extends the header chain and has a valid transaction and segwit merkle root.
+	OnBlockConnected    func(block *Block, entry *BlockTreeEntry)       // Called when a block is valid and has now been connected to the best chain.
+	OnBlockDisconnected func(block *Block, entry *BlockTreeEntry)       // Called during a re-org when a block has been removed from the best chain.
 }
 
 //export go_validation_interface_block_checked_bridge
@@ -22,3 +27,30 @@ func go_validation_interface_block_checked_bridge(user_data unsafe.Pointer, bloc
 		callbacks.OnBlockChecked(newBlock(block, true), &BlockValidationState{ptr: state})
 	}
 }
+
+//export go_validation_interface_pow_valid_block_bridge
+func go_validation_interface_pow_valid_block_bridge(user_data unsafe.Pointer, entry *C.btck_BlockTreeEntry, block *C.btck_Block) {
+	handle := cgo.Handle(user_data)
+	callbacks := handle.Value().(*ValidationInterfaceCallbacks)
+	if callbacks.OnPowValidBlock != nil {
+		callbacks.OnPowValidBlock(&BlockTreeEntry{ptr: entry}, newBlock(block, true))
+	}
+}
+
+//export go_validation_interface_block_connected_bridge
+func go_validation_interface_block_connected_bridge(user_data unsafe.Pointer, block *C.btck_Block, entry *C.btck_BlockTreeEntry) {
+	handle := cgo.Handle(user_data)
+	callbacks := handle.Value().(*ValidationInterfaceCallbacks)
+	if callbacks.OnBlockConnected != nil {
+		callbacks.OnBlockConnected(newBlock(block, true), &BlockTreeEntry{ptr: entry})
+	}
+}
+
+//export go_validation_interface_block_disconnected_bridge
+func go_validation_interface_block_disconnected_bridge(user_data unsafe.Pointer, block *C.btck_Block, entry *C.btck_BlockTreeEntry) {
+	handle := cgo.Handle(user_data)
+	callbacks := handle.Value().(*ValidationInterfaceCallbacks)
+	if callbacks.OnBlockDisconnected != nil {
+		callbacks.OnBlockDisconnected(newBlock(block, true), &BlockTreeEntry{ptr: entry})
+	}
+}

kernel/validation_interface_callbacks_test.go

@@ -6,38 +6,56 @@ import (
 )
 
 func TestValidationInterfaceCallbacks(t *testing.T) {
-	var blockCheckedCalled bool
+
+	var lastBlockCheckedBlockData []byte
 	var lastValidationMode ValidationMode
-	var lastBlockData []byte
 
-	callbacks := &ValidationInterfaceCallbacks{
-		OnBlockChecked: func(block *Block, state *BlockValidationState) {
-			blockCheckedCalled = true
-			lastValidationMode = state.ValidationMode()
-			var err error
-			lastBlockData, err = block.Bytes()
-			if err != nil {
-				t.Fatal(err)
-			}
-		},
-	}
+	var lastBlockConnectedBlockData []byte
+	var lastBlockConnectedBlockHeight int32
 
 	suite := ChainstateManagerTestSuite{
 		MaxBlockHeightToImport: 2,
-		ValidationCallbacks:    callbacks,
+		ValidationCallbacks: &ValidationInterfaceCallbacks{
+			OnBlockChecked: func(block *Block, state *BlockValidationState) {
+				lastValidationMode = state.ValidationMode()
+				var err error
+				lastBlockCheckedBlockData, err = block.Bytes()
+				if err != nil {
+					t.Fatal(err)
+				}
+			},
+			OnBlockConnected: func(block *Block, entry *BlockTreeEntry) {
+				lastBlockConnectedBlockHeight = entry.Height()
+				var err error
+				lastBlockConnectedBlockData, err = block.Bytes()
+				if err != nil {
+					t.Fatal(err)
+				}
+			},
+		},
 	}
 	suite.Setup(t)
 
-	if !blockCheckedCalled {
+	// OnBlockChecked
+	if lastBlockCheckedBlockData == nil {
 		t.Error("OnBlockChecked callback was not called")
 	}
-
 	if lastValidationMode != ValidationStateValid {
 		t.Errorf("Expected validation mode %d, got %d", ValidationStateValid, lastValidationMode)
 	}
-
-	lastBlockDataHex := hex.EncodeToString(lastBlockData)
-	if lastBlockDataHex != "00000020a629da61ccd6c9de14dd22d4dcf06ac4b98828801fb58275af1ed2c89e361b79677daedb5fc7781c5907a88133cd461b4865e9a4881fecfb362304ad1806acf3a7242d66ffff7f200100000001020000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff025200ffffffff0200f2052a010000001600141409745405c4e8310a875bcd602db6b9b3dc0cf90000000000000000266a24aa21a9ede2f61c3f71d1defd3fa999dfa36953755c690689799962b48bebd836974e8cf90120000000000000000000000000000000000000000000000000000000000000000000000000" {
+	expectedLastBlockDataHex := "00000020a629da61ccd6c9de14dd22d4dcf06ac4b98828801fb58275af1ed2c89e361b79677daedb5fc7781c5907a88133cd461b4865e9a4881fecfb362304ad1806acf3a7242d66ffff7f200100000001020000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff025200ffffffff0200f2052a010000001600141409745405c4e8310a875bcd602db6b9b3dc0cf90000000000000000266a24aa21a9ede2f61c3f71d1defd3fa999dfa36953755c690689799962b48bebd836974e8cf90120000000000000000000000000000000000000000000000000000000000000000000000000"
+	if hex.EncodeToString(lastBlockCheckedBlockData) != expectedLastBlockDataHex {
 		t.Errorf("Unexpected block data for last block")
 	}
+
+	// OnBlockConnected
+	if lastBlockConnectedBlockData == nil {
+		t.Error("OnBlockConnected callback was not called")
+	}
+	if lastBlockConnectedBlockHeight != 2 {
+		t.Errorf("Expected connected block height 2, got %d", lastBlockConnectedBlockHeight)
+	}
+	if hex.EncodeToString(lastBlockConnectedBlockData) != expectedLastBlockDataHex {
+		t.Errorf("Unexpected block data for connected block")
+	}
 }