Merge pull request #642 from pastelnetwork/PSL-928_broadcastingStorageChallengeResult

[PSL-928] implement storage challenge broadcasting

Author: j-rafique

common/types/storage_challenge.go

@@ -1,8 +1,9 @@
 package types
 
 import (
-	"github.com/pastelnetwork/gonode/common/errors"
 	"time"
+
+	"github.com/pastelnetwork/gonode/common/errors"
 )
 
 // MessageType represents the type of message
@@ -17,6 +18,8 @@ const (
 	EvaluationMessageType
 	// AffirmationMessageType represents the affirmation message
 	AffirmationMessageType
+	//BroadcastMessageType represents the message that needs to be broadcast
+	BroadcastMessageType
 )
 
 // String returns the message string
@@ -51,15 +54,23 @@ func MessageTypeFromString(str string) (MessageType, error) {
 	}
 }
 
+// StorageChallengeSignatures represents the signature struct for broadcasting
+type StorageChallengeSignatures struct {
+	Challenger map[string]string `json:"challenger,omitempty"`
+	Recipient  map[string]string `json:"recipient,omitempty"`
+	Obs        map[string]string `json:"obs,omitempty"`
+}
+
 // Message represents the storage challenge message
 type Message struct {
-	MessageType     MessageType `json:"message_type"`
-	ChallengeID     string      `json:"challenge_id"`
-	Data            MessageData `json:"data"`
-	Sender          string      `json:"sender"`
-	SenderSignature []byte      `json:"sender_signature"`
-	CreatedAt       time.Time   `json:"created_at"`
-	UpdatedAt       time.Time   `json:"updated_at"`
+	MessageType                MessageType `json:"message_type"`
+	ChallengeID                string      `json:"challenge_id"`
+	Data                       MessageData `json:"data"`
+	Sender                     string      `json:"sender"`
+	SenderSignature            []byte      `json:"sender_signature"`
+	StorageChallengeSignatures StorageChallengeStatus
+	CreatedAt                  time.Time `json:"created_at"`
+	UpdatedAt                  time.Time `json:"updated_at"`
 }
 
 // MessageData represents the storage challenge message data

proto/supernode/protobuf/storage_challenge.proto

@@ -14,7 +14,7 @@ service StorageChallenge {
   rpc ProcessStorageChallenge(ProcessStorageChallengeRequest) returns (ProcessStorageChallengeReply);
   rpc VerifyStorageChallenge(VerifyStorageChallengeRequest) returns (VerifyStorageChallengeReply);
   rpc VerifyEvaluationResult(VerifyEvaluationResultRequest) returns (VerifyEvaluationResultReply);
-
+  rpc BroadcastStorageChallengeResult(BroadcastStorageChallengeRequest) returns (BroadcastStorageChallengeResponse);
 }
 
 message StorageChallengeData {
@@ -77,6 +77,17 @@ message VerifyEvaluationResultReply {
   StorageChallengeMessage data = 1;
 }
 
+message BroadcastStorageChallengeRequest {
+  StorageChallengeMessage data = 1;
+  map<string, bytes> challenger = 2;
+  map<string, bytes> recipient = 3;
+  map<string, bytes> obs = 4;
+}
+
+message BroadcastStorageChallengeResponse {
+  StorageChallengeMessage data = 1;
+}
+
 
 message StorageChallengeMessage {
   enum messageType {

proto/supernode/storage_challenge.pb.go

@@ -3,11 +3,11 @@ package client
 import (
 	"context"
 	"encoding/json"
-	"github.com/pastelnetwork/gonode/common/types"
 	"io"
 
 	"github.com/pastelnetwork/gonode/common/errors"
 	"github.com/pastelnetwork/gonode/common/log"
+	"github.com/pastelnetwork/gonode/common/types"
 	pb "github.com/pastelnetwork/gonode/proto/supernode"
 	"github.com/pastelnetwork/gonode/supernode/node"
 	"google.golang.org/grpc/codes"
@@ -120,6 +120,19 @@ func (service *storageChallengeGRPCClient) VerifyEvaluationResult(ctx context.Co
 	return msg, nil
 }
 
+// BroadcastStorageChallengeResult broadcast the result to the entire network
+func (service *storageChallengeGRPCClient) BroadcastStorageChallengeResult(ctx context.Context, req *pb.BroadcastStorageChallengeRequest) error {
+	ctx = contextWithLogPrefix(ctx, service.conn.id)
+	ctx = contextWithMDSessID(ctx, service.sessID)
+
+	_, err := service.client.BroadcastStorageChallengeResult(ctx, req)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func newStorageChallengeGRPCClient(conn *clientConn) node.StorageChallengeInterface {
 	return &storageChallengeGRPCClient{
 		conn:   conn,

proto/supernode/storage_challenge_grpc.pb.go

@@ -3,11 +3,11 @@ package supernode
 import (
 	"context"
 	"encoding/json"
-	"github.com/pastelnetwork/gonode/common/types"
 	"io"
 
 	"github.com/pastelnetwork/gonode/common/errors"
 	"github.com/pastelnetwork/gonode/common/log"
+	"github.com/pastelnetwork/gonode/common/types"
 	pb "github.com/pastelnetwork/gonode/proto/supernode"
 	"github.com/pastelnetwork/gonode/supernode/node/grpc/server/services/common"
 	"github.com/pastelnetwork/gonode/supernode/services/storagechallenge"
@@ -179,6 +179,27 @@ func (service *StorageChallengeGRPC) VerifyEvaluationResult(ctx context.Context,
 	}}, nil
 }
 
+// BroadcastStorageChallengeResult broadcast the message to the entire network
+func (service *StorageChallengeGRPC) BroadcastStorageChallengeResult(ctx context.Context, scRequest *pb.BroadcastStorageChallengeRequest) (*pb.BroadcastStorageChallengeResponse, error) {
+	log.WithContext(ctx).WithField("req", scRequest).Debugf("broadcast storage challenge result request received from gRpc client")
+	task := service.NewSCTask()
+
+	msg := types.Message{
+		ChallengeID:     scRequest.Data.ChallengeId,
+		MessageType:     types.MessageType(scRequest.Data.MessageType),
+		Sender:          scRequest.Data.SenderId,
+		SenderSignature: scRequest.Data.SenderSignature,
+	}
+
+	_, err := task.BroadcastStorageChallengeResult(ctx, msg)
+	if err != nil {
+		log.WithContext(ctx).WithError(err).Error("Error verifying evaluation result")
+		return nil, errors.Errorf("error verifying evaluation report")
+	}
+
+	return nil, err
+}
+
 // NewStorageChallengeGRPC returns a new StorageChallenge instance.
 func NewStorageChallengeGRPC(service *storagechallenge.SCService) *StorageChallengeGRPC {
 	return &StorageChallengeGRPC{

supernode/node/grpc/client/storage_challenge.go

@@ -12,9 +12,9 @@ package node
 
 import (
 	"context"
-	"github.com/pastelnetwork/gonode/common/types"
 
 	"github.com/pastelnetwork/gonode/common/service/userdata"
+	"github.com/pastelnetwork/gonode/common/types"
 	pb "github.com/pastelnetwork/gonode/proto/supernode"
 )
 
@@ -109,6 +109,9 @@ type StorageChallengeInterface interface {
 
 	//VerifyEvaluationResult verifies the evaluation report by challenger
 	VerifyEvaluationResult(ctx context.Context, challengeMessage *pb.StorageChallengeMessage) (types.Message, error)
+
+	//BroadcastStorageChallengeResult broadcast the result to all SNs
+	BroadcastStorageChallengeResult(ctx context.Context, req *pb.BroadcastStorageChallengeRequest) error
 }
 
 // SelfHealingChallengeInterface represents an interaction stream with supernodes for self-healing challenge communications

supernode/node/grpc/server/services/supernode/storage_challenge.go

@@ -1,9 +1,9 @@
 package test
 
 import (
-	pb "github.com/pastelnetwork/gonode/proto/supernode"
 	"testing"
 
+	"github.com/pastelnetwork/gonode/common/types"
 	"github.com/pastelnetwork/gonode/supernode/node/mocks"
 	"github.com/stretchr/testify/mock"
 )
@@ -36,8 +36,14 @@ const (
 	//VerifyStorageChallengeMethod intercepts the VerifyStorageChallenge method
 	VerifyStorageChallengeMethod = "VerifyStorageChallenge"
 
+	//VerifyEvaluationResultMethod intercepts the VerifyEvaluationResult Method
+	VerifyEvaluationResultMethod = "VerifyEvaluationResult"
+
 	//StorageChallengeInterfaceMethod intercepts the StorageChallenge interface
 	StorageChallengeInterfaceMethod = "StorageChallenge"
+
+	//BroadcastStorageChallengeResultMethod intercepts the BroadcastStorageChallengeResult Method
+	BroadcastStorageChallengeResultMethod = "BroadcastStorageChallengeResult"
 )
 
 // Client implementing node.Client mock for testing purpose
@@ -83,8 +89,22 @@ func (client *Client) ListenOnProcessStorageChallengeFunc(returnErr error) *Clie
 }
 
 // ListenOnVerifyStorageChallengeFunc returns returnErr
-func (client *Client) ListenOnVerifyStorageChallengeFunc(data *pb.StorageChallengeData, returnErr error) *Client {
-	client.StorageChallengeInterface.On(VerifyStorageChallengeMethod, mock.Anything, mock.Anything).Return(data, returnErr)
+func (client *Client) ListenOnVerifyStorageChallengeFunc(returnErr error) *Client {
+	client.StorageChallengeInterface.On(VerifyStorageChallengeMethod, mock.Anything, mock.Anything).Return(returnErr)
+
+	return client
+}
+
+// ListenOnVerifyEvaluationResultFunc returns affirmations & returnErr
+func (client *Client) ListenOnVerifyEvaluationResultFunc(data types.Message, returnErr error) *Client {
+	client.StorageChallengeInterface.On(VerifyEvaluationResultMethod, mock.Anything, mock.Anything).Return(data, returnErr)
+
+	return client
+}
+
+// ListenOnBroadcastStorageChallengeResultFunc returns error
+func (client *Client) ListenOnBroadcastStorageChallengeResultFunc(returnErr error) *Client {
+	client.StorageChallengeInterface.On(BroadcastStorageChallengeResultMethod, mock.Anything, mock.Anything).Return(returnErr)
 
 	return client
 }

supernode/node/node_client_interface.go

@@ -0,0 +1,16 @@
+package storagechallenge
+
+import (
+	"context"
+	"github.com/pastelnetwork/gonode/common/log"
+
+	"github.com/pastelnetwork/gonode/common/types"
+)
+
+// BroadcastStorageChallengeResult receives and process the storage challenge result
+func (task *SCTask) BroadcastStorageChallengeResult(ctx context.Context, incomingEvaluationResult types.Message) (types.Message, error) {
+	log.WithContext(ctx).WithField("method", "BroadcastStorageChallengeResult").
+		WithField("challengeID", incomingEvaluationResult.ChallengeID).
+		Debug("Start processing broadcasting message") // Incoming challenge message validation
+	return types.Message{}, nil
+}

supernode/node/test/storage_challenge/mock_client.go

@@ -16,6 +16,9 @@ const (
 
 	// ChallengeFailuresThreshold is a threshold which when exceeds will send the challenge for self-healing
 	defaultChallengeFailuresThreshold = 5
+
+	// SuccessfulEvaluationThreshold is the affirmation threshold required for broadcasting
+	SuccessfulEvaluationThreshold = 2
 )
 
 // Config storage challenge config
@@ -26,9 +29,10 @@ type Config struct {
 	NumberOfVerifyingNodes        int   `mapstructure:"number_of_verifying_nodes" json:"number_of_verifying_nodes"`
 
 	// raptorq service
-	RaptorQServiceAddress      string `mapstructure:"-" json:"-"`
-	RqFilesDir                 string
-	ChallengeFailuresThreshold int
+	RaptorQServiceAddress         string `mapstructure:"-" json:"-"`
+	RqFilesDir                    string
+	ChallengeFailuresThreshold    int
+	SuccessfulEvaluationThreshold int
 }
 
 // NewConfig returns a new Config instance.
@@ -44,5 +48,6 @@ func NewConfig() *Config {
 		NumberOfChallengeReplicas:     defaultNumberOfChallengeReplicas,
 		NumberOfVerifyingNodes:        defaultNumberOfVerifyingNodes,
 		ChallengeFailuresThreshold:    challengeFailuresThreshold,
+		SuccessfulEvaluationThreshold: SuccessfulEvaluationThreshold,
 	}
 }