Browse Source
2871 remove proposalHeartbeat infrastructure (#2874)
* 2871 remove proposalHeartbeat infrastructure * 2871 add preliminary changelog entrypull/2935/head
srmo
6 years ago
committed by
Ethan Buchman
Ethan Buchman
20 changed files with 15 additions and 521 deletions
Unified View
Diff Options
-
+1 -0CHANGELOG_PENDING.md
-
+0 -14consensus/common_test.go
-
+3 -35consensus/reactor.go
-
+2 -13consensus/reactor_test.go
-
+1 -41consensus/state.go
-
+0 -29consensus/state_test.go
-
+2 -3docs/spec/reactors/consensus/consensus-reactor.md
-
+0 -27docs/spec/reactors/consensus/consensus.md
-
+0 -13privval/priv_validator.go
-
+0 -48privval/remote_signer.go
-
+2 -54privval/tcp_test.go
-
+0 -22types/canonical.go
-
+0 -4types/event_bus.go
-
+1 -3types/event_bus_test.go
-
+0 -7types/events.go
-
+0 -83types/heartbeat.go
-
+0 -104types/heartbeat_test.go
-
+1 -17types/priv_validator.go
-
+2 -2types/signable.go
-
+0 -2types/signed_msg_type.go
+ 1
- 0
CHANGELOG_PENDING.md
View File
+ 0
- 14
consensus/common_test.go
View File
+ 3
- 35
consensus/reactor.go
View File
+ 2
- 13
consensus/reactor_test.go
View File
+ 1
- 41
consensus/state.go
View File
+ 0
- 29
consensus/state_test.go
View File
+ 2
- 3
docs/spec/reactors/consensus/consensus-reactor.md
View File
+ 0
- 27
docs/spec/reactors/consensus/consensus.md
View File
+ 0
- 13
privval/priv_validator.go
View File
+ 0
- 48
privval/remote_signer.go
View File
+ 2
- 54
privval/tcp_test.go
View File
+ 0
- 22
types/canonical.go
View File
+ 0
- 4
types/event_bus.go
View File
+ 1
- 3
types/event_bus_test.go
View File
+ 0
- 7
types/events.go
View File
+ 0
- 83
types/heartbeat.go
View File
| @ -1,83 +0,0 @@ | |||||
| package types | |||||
| import ( | |||||
| "fmt" | |||||
| "github.com/pkg/errors" | |||||
| "github.com/tendermint/tendermint/crypto" | |||||
| cmn "github.com/tendermint/tendermint/libs/common" | |||||
| ) | |||||
| // Heartbeat is a simple vote-like structure so validators can | |||||
| // alert others that they are alive and waiting for transactions. | |||||
| // Note: We aren't adding ",omitempty" to Heartbeat's | |||||
| // json field tags because we always want the JSON | |||||
| // representation to be in its canonical form. | |||||
| type Heartbeat struct { | |||||
| ValidatorAddress Address `json:"validator_address"` | |||||
| ValidatorIndex int `json:"validator_index"` | |||||
| Height int64 `json:"height"` | |||||
| Round int `json:"round"` | |||||
| Sequence int `json:"sequence"` | |||||
| Signature []byte `json:"signature"` | |||||
| } | |||||
| // SignBytes returns the Heartbeat bytes for signing. | |||||
| // It panics if the Heartbeat is nil. | |||||
| func (heartbeat *Heartbeat) SignBytes(chainID string) []byte { | |||||
| bz, err := cdc.MarshalBinaryLengthPrefixed(CanonicalizeHeartbeat(chainID, heartbeat)) | |||||
| if err != nil { | |||||
| panic(err) | |||||
| } | |||||
| return bz | |||||
| } | |||||
| // Copy makes a copy of the Heartbeat. | |||||
| func (heartbeat *Heartbeat) Copy() *Heartbeat { | |||||
| if heartbeat == nil { | |||||
| return nil | |||||
| } | |||||
| heartbeatCopy := *heartbeat | |||||
| return &heartbeatCopy | |||||
| } | |||||
| // String returns a string representation of the Heartbeat. | |||||
| func (heartbeat *Heartbeat) String() string { | |||||
| if heartbeat == nil { | |||||
| return "nil-heartbeat" | |||||
| } | |||||
| return fmt.Sprintf("Heartbeat{%v:%X %v/%02d (%v) %v}", | |||||
| heartbeat.ValidatorIndex, cmn.Fingerprint(heartbeat.ValidatorAddress), | |||||
| heartbeat.Height, heartbeat.Round, heartbeat.Sequence, | |||||
| fmt.Sprintf("/%X.../", cmn.Fingerprint(heartbeat.Signature[:]))) | |||||
| } | |||||
| // ValidateBasic performs basic validation. | |||||
| func (heartbeat *Heartbeat) ValidateBasic() error { | |||||
| if len(heartbeat.ValidatorAddress) != crypto.AddressSize { | |||||
| return fmt.Errorf("Expected ValidatorAddress size to be %d bytes, got %d bytes", | |||||
| crypto.AddressSize, | |||||
| len(heartbeat.ValidatorAddress), | |||||
| ) | |||||
| } | |||||
| if heartbeat.ValidatorIndex < 0 { | |||||
| return errors.New("Negative ValidatorIndex") | |||||
| } | |||||
| if heartbeat.Height < 0 { | |||||
| return errors.New("Negative Height") | |||||
| } | |||||
| if heartbeat.Round < 0 { | |||||
| return errors.New("Negative Round") | |||||
| } | |||||
| if heartbeat.Sequence < 0 { | |||||
| return errors.New("Negative Sequence") | |||||
| } | |||||
| if len(heartbeat.Signature) == 0 { | |||||
| return errors.New("Signature is missing") | |||||
| } | |||||
| if len(heartbeat.Signature) > MaxSignatureSize { | |||||
| return fmt.Errorf("Signature is too big (max: %d)", MaxSignatureSize) | |||||
| } | |||||
| return nil | |||||
| } | |||||
+ 0
- 104
types/heartbeat_test.go
View File
| @ -1,104 +0,0 @@ | |||||
| package types | |||||
| import ( | |||||
| "testing" | |||||
| "github.com/stretchr/testify/assert" | |||||
| "github.com/stretchr/testify/require" | |||||
| "github.com/tendermint/tendermint/crypto/ed25519" | |||||
| "github.com/tendermint/tendermint/crypto/secp256k1" | |||||
| ) | |||||
| func TestHeartbeatCopy(t *testing.T) { | |||||
| hb := &Heartbeat{ValidatorIndex: 1, Height: 10, Round: 1} | |||||
| hbCopy := hb.Copy() | |||||
| require.Equal(t, hbCopy, hb, "heartbeat copy should be the same") | |||||
| hbCopy.Round = hb.Round + 10 | |||||
| require.NotEqual(t, hbCopy, hb, "heartbeat copy mutation should not change original") | |||||
| var nilHb *Heartbeat | |||||
| nilHbCopy := nilHb.Copy() | |||||
| require.Nil(t, nilHbCopy, "copy of nil should also return nil") | |||||
| } | |||||
| func TestHeartbeatString(t *testing.T) { | |||||
| var nilHb *Heartbeat | |||||
| require.Contains(t, nilHb.String(), "nil", "expecting a string and no panic") | |||||
| hb := &Heartbeat{ValidatorIndex: 1, Height: 11, Round: 2} | |||||
| require.Equal(t, "Heartbeat{1:000000000000 11/02 (0) /000000000000.../}", hb.String()) | |||||
| var key ed25519.PrivKeyEd25519 | |||||
| sig, err := key.Sign([]byte("Tendermint")) | |||||
| require.NoError(t, err) | |||||
| hb.Signature = sig | |||||
| require.Equal(t, "Heartbeat{1:000000000000 11/02 (0) /FF41E371B9BF.../}", hb.String()) | |||||
| } | |||||
| func TestHeartbeatWriteSignBytes(t *testing.T) { | |||||
| chainID := "test_chain_id" | |||||
| { | |||||
| testHeartbeat := &Heartbeat{ValidatorIndex: 1, Height: 10, Round: 1} | |||||
| signBytes := testHeartbeat.SignBytes(chainID) | |||||
| expected, err := cdc.MarshalBinaryLengthPrefixed(CanonicalizeHeartbeat(chainID, testHeartbeat)) | |||||
| require.NoError(t, err) | |||||
| require.Equal(t, expected, signBytes, "Got unexpected sign bytes for Heartbeat") | |||||
| } | |||||
| { | |||||
| testHeartbeat := &Heartbeat{} | |||||
| signBytes := testHeartbeat.SignBytes(chainID) | |||||
| expected, err := cdc.MarshalBinaryLengthPrefixed(CanonicalizeHeartbeat(chainID, testHeartbeat)) | |||||
| require.NoError(t, err) | |||||
| require.Equal(t, expected, signBytes, "Got unexpected sign bytes for Heartbeat") | |||||
| } | |||||
| require.Panics(t, func() { | |||||
| var nilHb *Heartbeat | |||||
| signBytes := nilHb.SignBytes(chainID) | |||||
| require.Equal(t, string(signBytes), "null") | |||||
| }) | |||||
| } | |||||
| func TestHeartbeatValidateBasic(t *testing.T) { | |||||
| testCases := []struct { | |||||
| testName string | |||||
| malleateHeartBeat func(*Heartbeat) | |||||
| expectErr bool | |||||
| }{ | |||||
| {"Good HeartBeat", func(hb *Heartbeat) {}, false}, | |||||
| {"Invalid address size", func(hb *Heartbeat) { | |||||
| hb.ValidatorAddress = nil | |||||
| }, true}, | |||||
| {"Negative validator index", func(hb *Heartbeat) { | |||||
| hb.ValidatorIndex = -1 | |||||
| }, true}, | |||||
| {"Negative height", func(hb *Heartbeat) { | |||||
| hb.Height = -1 | |||||
| }, true}, | |||||
| {"Negative round", func(hb *Heartbeat) { | |||||
| hb.Round = -1 | |||||
| }, true}, | |||||
| {"Negative sequence", func(hb *Heartbeat) { | |||||
| hb.Sequence = -1 | |||||
| }, true}, | |||||
| {"Missing signature", func(hb *Heartbeat) { | |||||
| hb.Signature = nil | |||||
| }, true}, | |||||
| {"Signature too big", func(hb *Heartbeat) { | |||||
| hb.Signature = make([]byte, MaxSignatureSize+1) | |||||
| }, true}, | |||||
| } | |||||
| for _, tc := range testCases { | |||||
| t.Run(tc.testName, func(t *testing.T) { | |||||
| hb := &Heartbeat{ | |||||
| ValidatorAddress: secp256k1.GenPrivKey().PubKey().Address(), | |||||
| Signature: make([]byte, 4), | |||||
| ValidatorIndex: 1, Height: 10, Round: 1} | |||||
| tc.malleateHeartBeat(hb) | |||||
| assert.Equal(t, tc.expectErr, hb.ValidateBasic() != nil, "Validate Basic had an unexpected result") | |||||
| }) | |||||
| } | |||||
| } | |||||