Deduplicate partial and full GMessage validation logic (#1010)

* Deduplicate partial and full GMessage validation logic

Prior to launch the partial message validation logic was copied from the
core of GPBFT to work within the activation timescale leaving a
technical debt behind. The work pays back that debt by unifying the two
validation logics into one. It:

* alters the core GPBFT validation logic to understand the notion of
  partial messages.
* changes the basic validation logic to worth with and without partial
  information.
* moves GPBFT basic types into their own Go file to reduce clutter in
  the core GPBFT implementation
* enhances tests to exercise both partial+full and full message
 validation in tests.

Fixes #826

* Update docs on GMessage to clarify signature paylaod signing

* Incorporate the entire message in computing cache key for messages

Author: masih

cmd/f3/aider.go

@@ -17,7 +17,6 @@ import (
 	"github.com/filecoin-project/go-f3/internal/psutil"
 	"github.com/filecoin-project/go-f3/manifest"
 	"github.com/filecoin-project/go-f3/observer"
-	"github.com/filecoin-project/go-f3/pmsg"
 	"github.com/libp2p/go-libp2p"
 	pubsub "github.com/libp2p/go-libp2p-pubsub"
 	"github.com/libp2p/go-libp2p/p2p/net/connmgr"
@@ -230,7 +229,7 @@ func aid(c *cli.Context, f3Chatter *pubsub.Topic) error {
 	}
 	fmt.Printf("⚙️ Found %d distinct senders\n", len(senders))
 
-	msgEncoding, err := encoding.NewZSTD[*pmsg.PartialGMessage]()
+	msgEncoding, err := encoding.NewZSTD[*gpbft.PartialGMessage]()
 	if err != nil {
 		return fmt.Errorf("failed to create zstd message encoding: %w", err)
 	}

encoding_bench_test.go

@@ -7,7 +7,6 @@ import (
 	"github.com/filecoin-project/go-bitfield"
 	"github.com/filecoin-project/go-f3/gpbft"
 	"github.com/filecoin-project/go-f3/internal/encoding"
-	"github.com/filecoin-project/go-f3/pmsg"
 	"github.com/ipfs/go-cid"
 	"github.com/multiformats/go-multihash"
 	"github.com/stretchr/testify/require"
@@ -17,7 +16,7 @@ const seed = 1413
 
 func BenchmarkCborEncoding(b *testing.B) {
 	rng := rand.New(rand.NewSource(seed))
-	encoder := encoding.NewCBOR[*pmsg.PartialGMessage]()
+	encoder := encoding.NewCBOR[*gpbft.PartialGMessage]()
 	msg := generateRandomPartialGMessage(b, rng)
 
 	b.ResetTimer()
@@ -33,7 +32,7 @@ func BenchmarkCborEncoding(b *testing.B) {
 
 func BenchmarkCborDecoding(b *testing.B) {
 	rng := rand.New(rand.NewSource(seed))
-	encoder := encoding.NewCBOR[*pmsg.PartialGMessage]()
+	encoder := encoding.NewCBOR[*gpbft.PartialGMessage]()
 	msg := generateRandomPartialGMessage(b, rng)
 	data, err := encoder.Encode(msg)
 	require.NoError(b, err)
@@ -42,7 +41,7 @@ func BenchmarkCborDecoding(b *testing.B) {
 	b.ReportAllocs()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
-			var got pmsg.PartialGMessage
+			var got gpbft.PartialGMessage
 			require.NoError(b, encoder.Decode(data, &got))
 			requireEqualPartialMessages(b, msg, &got)
 		}
@@ -51,7 +50,7 @@ func BenchmarkCborDecoding(b *testing.B) {
 
 func BenchmarkZstdEncoding(b *testing.B) {
 	rng := rand.New(rand.NewSource(seed))
-	encoder, err := encoding.NewZSTD[*pmsg.PartialGMessage]()
+	encoder, err := encoding.NewZSTD[*gpbft.PartialGMessage]()
 	require.NoError(b, err)
 	msg := generateRandomPartialGMessage(b, rng)
 
@@ -68,7 +67,7 @@ func BenchmarkZstdEncoding(b *testing.B) {
 
 func BenchmarkZstdDecoding(b *testing.B) {
 	rng := rand.New(rand.NewSource(seed))
-	encoder, err := encoding.NewZSTD[*pmsg.PartialGMessage]()
+	encoder, err := encoding.NewZSTD[*gpbft.PartialGMessage]()
 	require.NoError(b, err)
 	msg := generateRandomPartialGMessage(b, rng)
 	data, err := encoder.Encode(msg)
@@ -78,14 +77,14 @@ func BenchmarkZstdDecoding(b *testing.B) {
 	b.ReportAllocs()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
-			var got pmsg.PartialGMessage
+			var got gpbft.PartialGMessage
 			require.NoError(b, encoder.Decode(data, &got))
 			requireEqualPartialMessages(b, msg, &got)
 		}
 	})
 }
 
-func requireEqualPartialMessages(b *testing.B, expected, actual *pmsg.PartialGMessage) {
+func requireEqualPartialMessages(b *testing.B, expected, actual *gpbft.PartialGMessage) {
 	// Because empty ECChain gets marshaled as null, we need to use ECChain.Eq for
 	// checking equality. Hence, the custom equality check.
 	require.Equal(b, expected.Sender, actual.Sender)
@@ -103,8 +102,8 @@ func requireEqualPartialMessages(b *testing.B, expected, actual *pmsg.PartialGMe
 	}
 }
 
-func generateRandomPartialGMessage(b *testing.B, rng *rand.Rand) *pmsg.PartialGMessage {
-	var pgmsg pmsg.PartialGMessage
+func generateRandomPartialGMessage(b *testing.B, rng *rand.Rand) *gpbft.PartialGMessage {
+	var pgmsg gpbft.PartialGMessage
 	pgmsg.GMessage = generateRandomGMessage(b, rng)
 	pgmsg.GMessage.Vote.Value = nil
 	if pgmsg.Justification != nil {

gen/main.go

@@ -8,7 +8,6 @@ import (
 	"github.com/filecoin-project/go-f3/certs"
 	"github.com/filecoin-project/go-f3/chainexchange"
 	"github.com/filecoin-project/go-f3/gpbft"
-	"github.com/filecoin-project/go-f3/pmsg"
 	gen "github.com/whyrusleeping/cbor-gen"
 	"golang.org/x/sync/errgroup"
 )
@@ -22,6 +21,7 @@ func main() {
 			gpbft.TipSet{},
 			gpbft.LegacyECChain{},
 			gpbft.GMessage{},
+			gpbft.PartialGMessage{},
 			gpbft.SupplementalData{},
 			gpbft.Payload{},
 			gpbft.Justification{},
@@ -47,11 +47,6 @@ func main() {
 			chainexchange.Message{},
 		)
 	})
-	eg.Go(func() error {
-		return gen.WriteTupleEncodersToFile("../pmsg/cbor_gen.go", "pmsg",
-			pmsg.PartialGMessage{},
-		)
-	})
 	if err := eg.Wait(); err != nil {
 		fmt.Printf("Failed to complete cborg_gen: %v\n", err)
 		os.Exit(1)

gpbft/api.go

@@ -31,6 +31,16 @@ type ValidatedMessage interface {
 	Message() *GMessage
 }
 
+type PartialMessageValidator interface {
+	PartiallyValidateMessage(ctx context.Context, msg *PartialGMessage) (PartiallyValidatedMessage, error)
+	FullyValidateMessage(ctx context.Context, msg PartiallyValidatedMessage) (ValidatedMessage, error)
+}
+
+type PartiallyValidatedMessage interface {
+	// Returns the partially validated message.
+	PartialMessage() *PartialGMessage
+}
+
 // Receives a Granite protocol message.
 // Calls to methods on this interface are expected to be serialized.
 // The methods are not safe for concurrent use, and may panic if called concurrently.

gpbft/cbor_gen.go

@@ -1,6 +1,10 @@
 package gpbft
 
-import "errors"
+import (
+	"errors"
+	"fmt"
+	"runtime/debug"
+)
 
 var (
 	_ error = (*ValidationError)(nil)
@@ -40,5 +44,21 @@ var (
 // ValidationError signals that an error has occurred while validating a GMessage.
 type ValidationError struct{ message string }
 
+type PanicError struct {
+	Cause      any
+	stackTrace string
+}
+
 func newValidationError(message string) ValidationError { return ValidationError{message: message} }
 func (e ValidationError) Error() string                 { return e.message }
+
+func newPanicError(cause any) *PanicError {
+	return &PanicError{
+		Cause:      cause,
+		stackTrace: string(debug.Stack()),
+	}
+}
+
+func (e *PanicError) Error() string {
+	return fmt.Sprintf("participant panicked: %v\n%v", e.Cause, e.stackTrace)
+}