[Consensus] Refactor for guarantee signer indices (4/4)

cmd/bootstrap/cmd/seal.go

@@ -7,7 +7,7 @@ import (
 	"github.com/onflow/flow-go/model/dkg"
 	"github.com/onflow/flow-go/model/flow"
 	"github.com/onflow/flow-go/model/flow/order"
-	"github.com/onflow/flow-go/module/packer"
+	"github.com/onflow/flow-go/module/signature"
 )
 
 func constructRootResultAndSeal(
@@ -47,7 +47,7 @@ func constructRootResultAndSeal(
 	qcsWithSignerIDs := make([]*flow.QuorumCertificateWithSignerIDs, 0, len(clusterQCs))
 	for i, clusterQC := range clusterQCs {
 		members := assignments[i]
-		signerIDs, err := packer.DecodeSignerIdentifiersFromIndices(members, clusterQC.SignerIndices)
+		signerIDs, err := signature.DecodeSignerIndicesToIdentifiers(members, clusterQC.SignerIndices)
 		if err != nil {
 			log.Fatal().Err(err).Msgf("could not decode signer IDs from clusterQC at index %v", i)
 		}

consensus/follower_test.go

@@ -5,6 +5,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/onflow/flow-go/module/signature"
+
 	"github.com/rs/zerolog"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
@@ -16,7 +18,6 @@ import (
 	"github.com/onflow/flow-go/consensus/hotstuff/model"
 	"github.com/onflow/flow-go/model/flow"
 	mockmodule "github.com/onflow/flow-go/module/mock"
-	"github.com/onflow/flow-go/module/packer"
 	mockstorage "github.com/onflow/flow-go/storage/mock"
 	"github.com/onflow/flow-go/utils/unittest"
 )
@@ -107,7 +108,7 @@ func (s *HotStuffFollowerSuite) SetupTest() {
 		View:      52078,
 	}
 
-	signerIndices, err := packer.EncodeSignerIdentifiersToIndices(identities.NodeIDs(), identities.NodeIDs()[:3])
+	signerIndices, err := signature.EncodeSignersToIndices(identities.NodeIDs(), identities.NodeIDs()[:3])
 	require.NoError(s.T(), err)
 	s.rootQC = &flow.QuorumCertificate{
 		View:          s.rootHeader.View,
@@ -339,7 +340,7 @@ func (mc *MockConsensus) extendBlock(blockView uint64, parent *flow.Header) *flo
 	nextBlock := unittest.BlockHeaderWithParentFixture(parent)
 	nextBlock.View = blockView
 	nextBlock.ProposerID = mc.identities[int(blockView)%len(mc.identities)].NodeID
-	signerIndices, _ := packer.EncodeSignerIdentifiersToIndices(mc.identities.NodeIDs(), mc.identities.NodeIDs())
+	signerIndices, _ := signature.EncodeSignersToIndices(mc.identities.NodeIDs(), mc.identities.NodeIDs())
 	nextBlock.ParentVoterIndices = signerIndices
 	return &nextBlock
 }

consensus/hotstuff/integration/instance_test.go

@@ -23,15 +23,13 @@ import (
 	"github.com/onflow/flow-go/consensus/hotstuff/notifications"
 	"github.com/onflow/flow-go/consensus/hotstuff/pacemaker"
 	"github.com/onflow/flow-go/consensus/hotstuff/pacemaker/timeout"
-	hsig "github.com/onflow/flow-go/consensus/hotstuff/signature"
 	"github.com/onflow/flow-go/consensus/hotstuff/validator"
 	"github.com/onflow/flow-go/consensus/hotstuff/voteaggregator"
 	"github.com/onflow/flow-go/consensus/hotstuff/votecollector"
 	"github.com/onflow/flow-go/consensus/hotstuff/voter"
 	"github.com/onflow/flow-go/model/flow"
 	"github.com/onflow/flow-go/module/irrecoverable"
 	module "github.com/onflow/flow-go/module/mock"
-	"github.com/onflow/flow-go/module/packer"
 	msig "github.com/onflow/flow-go/module/signature"
 	"github.com/onflow/flow-go/utils/unittest"
 )
@@ -209,7 +207,7 @@ func NewInstance(t require.TestingT, options ...Option) *Instance {
 				View:     block.View,
 				BlockID:  block.BlockID,
 				SignerID: in.localID,
-				SigData:  unittest.RandomBytes(hsig.SigLen * 2), // double sig, one staking, one beacon
+				SigData:  unittest.RandomBytes(msig.SigLen * 2), // double sig, one staking, one beacon
 			}
 			return vote
 		},
@@ -222,7 +220,7 @@ func NewInstance(t require.TestingT, options ...Option) *Instance {
 				voterIDs = append(voterIDs, vote.SignerID)
 			}
 
-			signerIndices, err := packer.EncodeSignerIdentifiersToIndices(in.participants.NodeIDs(), voterIDs)
+			signerIndices, err := msig.EncodeSignersToIndices(in.participants.NodeIDs(), voterIDs)
 			require.NoError(t, err, "could not encode signer indices")
 
 			qc := &flow.QuorumCertificate{
@@ -349,7 +347,7 @@ func NewInstance(t require.TestingT, options ...Option) *Instance {
 	rbRector := helper.MakeRandomBeaconReconstructor(msig.RandomBeaconThreshold(int(in.participants.Count())))
 	rbRector.On("Verify", mock.Anything, mock.Anything).Return(nil).Maybe()
 
-	indices, err := packer.EncodeSignerIdentifiersToIndices(in.participants.NodeIDs(), []flow.Identifier(in.participants.NodeIDs()))
+	indices, err := msig.EncodeSignersToIndices(in.participants.NodeIDs(), []flow.Identifier(in.participants.NodeIDs()))
 	require.NoError(t, err)
 
 	packer := &mocks.Packer{}

consensus/hotstuff/model/errors.go

@@ -9,7 +9,6 @@ import (
 
 var (
 	ErrUnverifiableBlock = errors.New("block proposal can't be verified, because its view is above the finalized view, but its QC is below the finalized view")
-	ErrInvalidFormat     = errors.New("invalid signature format")
 	ErrInvalidSignature  = errors.New("invalid signature")
 )
 
@@ -26,6 +25,28 @@ func IsNoVoteError(err error) bool {
 	return errors.As(err, &e)
 }
 
+// InvalidFormatError indicates that some data has an incompatible format.
+type InvalidFormatError struct {
+	err error
+}
+
+func NewInvalidFormatError(err error) error {
+	return InvalidFormatError{err}
+}
+
+func NewInvalidFormatErrorf(msg string, args ...interface{}) error {
+	return InvalidFormatError{fmt.Errorf(msg, args...)}
+}
+
+func (e InvalidFormatError) Error() string { return e.err.Error() }
+func (e InvalidFormatError) Unwrap() error { return e.err }
+
+// IsInvalidFormatError returns whether err is a InvalidFormatError
+func IsInvalidFormatError(err error) bool {
+	var e InvalidFormatError
+	return errors.As(err, &e)
+}
+
 // ConfigurationError indicates that a constructor or component was initialized with
 // invalid or inconsistent parameters.
 type ConfigurationError struct {

consensus/hotstuff/packer/packer.go → consensus/hotstuff/model/signature_data.go

@@ -1,10 +1,8 @@
-package packer
+package model
 
 import (
 	"bytes"
-	"fmt"
 
-	"github.com/onflow/flow-go/consensus/hotstuff/model"
 	"github.com/onflow/flow-go/crypto"
 	"github.com/onflow/flow-go/model/encoding/rlp"
 )
@@ -49,7 +47,7 @@ func UnpackRandomBeaconSig(sigData []byte) (crypto.Signature, error) {
 	packer := SigDataPacker{}
 	sig, err := packer.Decode(sigData)
 	if err != nil {
-		return nil, fmt.Errorf("could not decode sig data %s: %w", err, model.ErrInvalidFormat)
+		return nil, NewInvalidFormatErrorf("could not decode sig data: %w", err)
 	}
 	return sig.ReconstructedRandomBeaconSig, nil
 }

consensus/hotstuff/signature.go

@@ -53,24 +53,6 @@ type RandomBeaconReconstructor interface {
 	Reconstruct() (crypto.Signature, error)
 }
 
-// SigType is the aggregable signature type.
-type SigType uint8
-
-// SigType specifies the role of the signature in the protocol.
-// Both types are aggregatable cryptographic signatures.
-//  * SigTypeRandomBeacon type is for random beacon signatures.
-//  * SigTypeStaking is for Hotstuff signatures.
-const (
-	SigTypeStaking SigType = iota
-	SigTypeRandomBeacon
-)
-
-// Valid returns true if the signature is either SigTypeStaking or SigTypeRandomBeacon
-// else return false
-func (t SigType) Valid() bool {
-	return t == SigTypeStaking || t == SigTypeRandomBeacon
-}
-
 // WeightedSignatureAggregator aggregates signatures of the same signature scheme and the
 // same message from different signers. The public keys and message are agreed upon upfront.
 // It is also recommended to only aggregate signatures generated with keys representing
@@ -131,5 +113,5 @@ type Packer interface {
 	// It returns:
 	//  - (sigData, nil) if successfully unpacked the signature data
 	//  - (nil, model.ErrInvalidFormat) if failed to unpack the signature data
-	Unpack(signerIDs []flow.Identifier, sigData []byte) (*BlockSignatureData, error)
+	Unpack(signerIdentities flow.IdentityList, sigData []byte) (*BlockSignatureData, error)
 }