Add extra data to GetBlockTemplate request (#1995)

app/appmessage/rpc_get_block_template.go

@@ -5,6 +5,7 @@ package appmessage
 type GetBlockTemplateRequestMessage struct {
 	baseMessage
 	PayAddress string
+	ExtraData  string
 }
 
 // Command returns the protocol command string for the message
@@ -13,9 +14,10 @@ func (msg *GetBlockTemplateRequestMessage) Command() MessageCommand {
 }
 
 // NewGetBlockTemplateRequestMessage returns a instance of the message
-func NewGetBlockTemplateRequestMessage(payAddress string) *GetBlockTemplateRequestMessage {
+func NewGetBlockTemplateRequestMessage(payAddress, extraData string) *GetBlockTemplateRequestMessage {
 	return &GetBlockTemplateRequestMessage{
 		PayAddress: payAddress,
+		ExtraData:  extraData,
 	}
 }
 

app/rpc/rpchandlers/get_block_template.go

@@ -26,7 +26,7 @@ func HandleGetBlockTemplate(context *rpccontext.Context, _ *router.Router, reque
 		return nil, err
 	}
 
-	coinbaseData := &externalapi.DomainCoinbaseData{ScriptPublicKey: scriptPublicKey, ExtraData: []byte(version.Version())}
+	coinbaseData := &externalapi.DomainCoinbaseData{ScriptPublicKey: scriptPublicKey, ExtraData: []byte(version.Version() + "/" + getBlockTemplateRequest.ExtraData)}
 
 	templateBlock, err := context.Domain.MiningManager().GetBlockTemplate(coinbaseData)
 	if err != nil {

cmd/kaspaminer/mineloop.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	nativeerrors "errors"
+	"github.com/kaspanet/kaspad/version"
 	"math/rand"
 	"sync/atomic"
 	"time"
@@ -187,7 +188,7 @@ func getBlockForMining(mineWhenNotSynced bool) (*externalapi.DomainBlock, *pow.S
 
 func templatesLoop(client *minerClient, miningAddr util.Address, errChan chan error) {
 	getBlockTemplate := func() {
-		template, err := client.GetBlockTemplate(miningAddr.String())
+		template, err := client.GetBlockTemplate(miningAddr.String(), "kaspaminer-"+version.Version())
 		if nativeerrors.Is(err, router.ErrTimeout) {
 			log.Warnf("Got timeout while requesting block template from %s: %s", client.Address(), err)
 			reconnectErr := client.Reconnect()

infrastructure/network/netadapter/server/grpcserver/protowire/messages.pb.go

@@ -1,12 +1,13 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // versions:
-// 	protoc-gen-go v1.26.0
+// 	protoc-gen-go v1.25.0
 // 	protoc        v3.12.3
 // source: messages.proto
 
 package protowire
 
 import (
+	proto "github.com/golang/protobuf/proto"
 	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
 	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
 	reflect "reflect"
@@ -20,6 +21,10 @@ const (
 	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
 )
 
+// This is a compile-time assertion that a sufficiently up-to-date version
+// of the legacy proto package is being used.
+const _ = proto.ProtoPackageIsVersion4
+
 type KaspadMessage struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache

infrastructure/network/netadapter/server/grpcserver/protowire/messages_grpc.pb.go

@@ -11,8 +11,7 @@ import (
 
 // This is a compile-time assertion to ensure that this generated file
 // is compatible with the grpc package it is being compiled against.
-// Requires gRPC-Go v1.32.0 or later.
-const _ = grpc.SupportPackageIsVersion7
+const _ = grpc.SupportPackageIsVersion6
 
 // P2PClient is the client API for P2P service.
 //
@@ -30,7 +29,7 @@ func NewP2PClient(cc grpc.ClientConnInterface) P2PClient {
 }
 
 func (c *p2PClient) MessageStream(ctx context.Context, opts ...grpc.CallOption) (P2P_MessageStreamClient, error) {
-	stream, err := c.cc.NewStream(ctx, &P2P_ServiceDesc.Streams[0], "/protowire.P2P/MessageStream", opts...)
+	stream, err := c.cc.NewStream(ctx, &_P2P_serviceDesc.Streams[0], "/protowire.P2P/MessageStream", opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -72,20 +71,13 @@ type P2PServer interface {
 type UnimplementedP2PServer struct {
 }
 
-func (UnimplementedP2PServer) MessageStream(P2P_MessageStreamServer) error {
+func (*UnimplementedP2PServer) MessageStream(P2P_MessageStreamServer) error {
 	return status.Errorf(codes.Unimplemented, "method MessageStream not implemented")
 }
-func (UnimplementedP2PServer) mustEmbedUnimplementedP2PServer() {}
+func (*UnimplementedP2PServer) mustEmbedUnimplementedP2PServer() {}
 
-// UnsafeP2PServer may be embedded to opt out of forward compatibility for this service.
-// Use of this interface is not recommended, as added methods to P2PServer will
-// result in compilation errors.
-type UnsafeP2PServer interface {
-	mustEmbedUnimplementedP2PServer()
-}
-
-func RegisterP2PServer(s grpc.ServiceRegistrar, srv P2PServer) {
-	s.RegisterService(&P2P_ServiceDesc, srv)
+func RegisterP2PServer(s *grpc.Server, srv P2PServer) {
+	s.RegisterService(&_P2P_serviceDesc, srv)
 }
 
 func _P2P_MessageStream_Handler(srv interface{}, stream grpc.ServerStream) error {
@@ -114,10 +106,7 @@ func (x *p2PMessageStreamServer) Recv() (*KaspadMessage, error) {
 	return m, nil
 }
 
-// P2P_ServiceDesc is the grpc.ServiceDesc for P2P service.
-// It's only intended for direct use with grpc.RegisterService,
-// and not to be introspected or modified (even as a copy)
-var P2P_ServiceDesc = grpc.ServiceDesc{
+var _P2P_serviceDesc = grpc.ServiceDesc{
 	ServiceName: "protowire.P2P",
 	HandlerType: (*P2PServer)(nil),
 	Methods:     []grpc.MethodDesc{},
@@ -148,7 +137,7 @@ func NewRPCClient(cc grpc.ClientConnInterface) RPCClient {
 }
 
 func (c *rPCClient) MessageStream(ctx context.Context, opts ...grpc.CallOption) (RPC_MessageStreamClient, error) {
-	stream, err := c.cc.NewStream(ctx, &RPC_ServiceDesc.Streams[0], "/protowire.RPC/MessageStream", opts...)
+	stream, err := c.cc.NewStream(ctx, &_RPC_serviceDesc.Streams[0], "/protowire.RPC/MessageStream", opts...)
 	if err != nil {
 		return nil, err
 	}
@@ -190,20 +179,13 @@ type RPCServer interface {
 type UnimplementedRPCServer struct {
 }
 
-func (UnimplementedRPCServer) MessageStream(RPC_MessageStreamServer) error {
+func (*UnimplementedRPCServer) MessageStream(RPC_MessageStreamServer) error {
 	return status.Errorf(codes.Unimplemented, "method MessageStream not implemented")
 }
-func (UnimplementedRPCServer) mustEmbedUnimplementedRPCServer() {}
+func (*UnimplementedRPCServer) mustEmbedUnimplementedRPCServer() {}
 
-// UnsafeRPCServer may be embedded to opt out of forward compatibility for this service.
-// Use of this interface is not recommended, as added methods to RPCServer will
-// result in compilation errors.
-type UnsafeRPCServer interface {
-	mustEmbedUnimplementedRPCServer()
-}
-
-func RegisterRPCServer(s grpc.ServiceRegistrar, srv RPCServer) {
-	s.RegisterService(&RPC_ServiceDesc, srv)
+func RegisterRPCServer(s *grpc.Server, srv RPCServer) {
+	s.RegisterService(&_RPC_serviceDesc, srv)
 }
 
 func _RPC_MessageStream_Handler(srv interface{}, stream grpc.ServerStream) error {
@@ -232,10 +214,7 @@ func (x *rPCMessageStreamServer) Recv() (*KaspadMessage, error) {
 	return m, nil
 }
 
-// RPC_ServiceDesc is the grpc.ServiceDesc for RPC service.
-// It's only intended for direct use with grpc.RegisterService,
-// and not to be introspected or modified (even as a copy)
-var RPC_ServiceDesc = grpc.ServiceDesc{
+var _RPC_serviceDesc = grpc.ServiceDesc{
 	ServiceName: "protowire.RPC",
 	HandlerType: (*RPCServer)(nil),
 	Methods:     []grpc.MethodDesc{},

infrastructure/network/netadapter/server/grpcserver/protowire/p2p.pb.go

@@ -1,12 +1,13 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // versions:
-// 	protoc-gen-go v1.26.0
+// 	protoc-gen-go v1.25.0
 // 	protoc        v3.12.3
 // source: p2p.proto
 
 package protowire
 
 import (
+	proto "github.com/golang/protobuf/proto"
 	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
 	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
 	reflect "reflect"
@@ -20,6 +21,10 @@ const (
 	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
 )
 
+// This is a compile-time assertion that a sufficiently up-to-date version
+// of the legacy proto package is being used.
+const _ = proto.ProtoPackageIsVersion4
+
 type RequestAddressesMessage struct {
 	state         protoimpl.MessageState
 	sizeCache     protoimpl.SizeCache

infrastructure/network/netadapter/server/grpcserver/protowire/rpc.md

@@ -454,6 +454,7 @@ See: SubmitBlockRequestMessage
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | payAddress | [string](#string) |  | Which kaspa address should the coinbase block reward transaction pay into |
+| extraData | [string](#string) |  |  |
 
 
 

infrastructure/network/netadapter/server/grpcserver/protowire/rpc.proto

@@ -152,6 +152,7 @@ message SubmitBlockResponseMessage{
 message GetBlockTemplateRequestMessage{
   // Which kaspa address should the coinbase block reward transaction pay into
   string payAddress = 1;
+  string extraData = 2;
 }
 
 message GetBlockTemplateResponseMessage{

infrastructure/network/netadapter/server/grpcserver/protowire/rpc_get_block_template.go

@@ -15,6 +15,7 @@ func (x *KaspadMessage_GetBlockTemplateRequest) toAppMessage() (appmessage.Messa
 func (x *KaspadMessage_GetBlockTemplateRequest) fromAppMessage(message *appmessage.GetBlockTemplateRequestMessage) error {
 	x.GetBlockTemplateRequest = &GetBlockTemplateRequestMessage{
 		PayAddress: message.PayAddress,
+		ExtraData:  message.ExtraData,
 	}
 	return nil
 }
@@ -25,6 +26,7 @@ func (x *GetBlockTemplateRequestMessage) toAppMessage() (appmessage.Message, err
 	}
 	return &appmessage.GetBlockTemplateRequestMessage{
 		PayAddress: x.PayAddress,
+		ExtraData:  x.ExtraData,
 	}, nil
 }
 

infrastructure/network/rpcclient/rpc_get_block_template.go

@@ -3,8 +3,8 @@ package rpcclient
 import "github.com/kaspanet/kaspad/app/appmessage"
 
 // GetBlockTemplate sends an RPC request respective to the function's name and returns the RPC server's response
-func (c *RPCClient) GetBlockTemplate(miningAddress string) (*appmessage.GetBlockTemplateResponseMessage, error) {
-	err := c.rpcRouter.outgoingRoute().Enqueue(appmessage.NewGetBlockTemplateRequestMessage(miningAddress))
+func (c *RPCClient) GetBlockTemplate(miningAddress, extraData string) (*appmessage.GetBlockTemplateResponseMessage, error) {
+	err := c.rpcRouter.outgoingRoute().Enqueue(appmessage.NewGetBlockTemplateRequestMessage(miningAddress, extraData))
 	if err != nil {
 		return nil, err
 	}

stability-tests/daa/daa_test.go

@@ -252,7 +252,7 @@ func runDAATest(t *testing.T, testName string, runDuration time.Duration,
 }
 
 func fetchBlockForMining(t *testing.T, rpcClient *rpcclient.RPCClient) *externalapi.DomainBlock {
-	getBlockTemplateResponse, err := rpcClient.GetBlockTemplate(miningAddress)
+	getBlockTemplateResponse, err := rpcClient.GetBlockTemplate(miningAddress, "")
 	if err != nil {
 		t.Fatalf("GetBlockTemplate: %s", err)
 	}

stability-tests/many-tips/main.go

@@ -64,7 +64,7 @@ func realMain() error {
 	defer rpcClient.Disconnect()
 
 	// Mine block that its timestamp is one second after the genesis timestamp.
-	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress())
+	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress(), "")
 	if err != nil {
 		return err
 	}
@@ -174,7 +174,7 @@ func generateAddress() (util.Address, error) {
 }
 
 func mineBlock(rpcClient *rpc.Client, miningAddress util.Address) error {
-	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress())
+	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress(), "")
 	if err != nil {
 		return err
 	}
@@ -191,7 +191,7 @@ func mineBlock(rpcClient *rpc.Client, miningAddress util.Address) error {
 }
 
 func mineTips(numOfTips int, miningAddress util.Address, rpcClient *rpc.Client) error {
-	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress())
+	blockTemplate, err := rpcClient.GetBlockTemplate(miningAddress.EncodeAddress(), "")
 	if err != nil {
 		return err
 	}

stability-tests/mempool-limits/transactions.go

@@ -98,7 +98,7 @@ func submitAnAmountOfTransactionsToTheMempool(t *testing.T, rpcClient *rpcclient
 }
 
 func mineBlockAndGetCoinbaseTransaction(t *testing.T, rpcClient *rpcclient.RPCClient) *externalapi.DomainTransaction {
-	getBlockTemplateResponse, err := rpcClient.GetBlockTemplate(payAddress)
+	getBlockTemplateResponse, err := rpcClient.GetBlockTemplate(payAddress, "")
 	if err != nil {
 		t.Fatalf("GetBlockTemplate: %+v", err)
 	}

stability-tests/netsync/node.go

@@ -185,7 +185,7 @@ func mineOnTips(client *rpc.Client) (appmessage.RejectReason, error) {
 		return appmessage.RejectReasonNone, err
 	}
 
-	template, err := client.GetBlockTemplate(addr.String())
+	template, err := client.GetBlockTemplate(addr.String(), "")
 	if err != nil {
 		return appmessage.RejectReasonNone, err
 	}

testing/integration/ibd_test.go

@@ -115,7 +115,7 @@ func TestIBDWithPruning(t *testing.T) {
 		}
 
 		// Checking that the syncee can generate block templates before resolving the virtual
-		_, err = syncee.rpcClient.GetBlockTemplate(syncee.miningAddress)
+		_, err = syncee.rpcClient.GetBlockTemplate(syncee.miningAddress, "")
 		if err != nil {
 			t.Fatalf("Error getting block template: %+v", err)
 		}
@@ -210,7 +210,7 @@ var currentMockTimestamp int64 = 0
 // between every two blocks. This is done to avoid the timestamp threshold validation
 // of ibd-with-headers-proof
 func mineNextBlockWithMockTimestamps(t *testing.T, harness *appHarness, rd *rand.Rand) *externalapi.DomainBlock {
-	blockTemplate, err := harness.rpcClient.GetBlockTemplate(harness.miningAddress)
+	blockTemplate, err := harness.rpcClient.GetBlockTemplate(harness.miningAddress, "")
 	if err != nil {
 		t.Fatalf("Error getting block template: %+v", err)
 	}

testing/integration/mining_test.go

@@ -11,7 +11,7 @@ import (
 )
 
 func mineNextBlock(t *testing.T, harness *appHarness) *externalapi.DomainBlock {
-	blockTemplate, err := harness.rpcClient.GetBlockTemplate(harness.miningAddress)
+	blockTemplate, err := harness.rpcClient.GetBlockTemplate(harness.miningAddress, "integration")
 	if err != nil {
 		t.Fatalf("Error getting block template: %+v", err)
 	}