Skip to content

Commit 5645ea5

Browse files
Rename ConsensusReq to ConsensusMsg (CON-468) (#4424)
## Summary - Rename the consensus stream payload from `ConsensusReq` to `ConsensusMsg` in the proto and the Go types that follow it. - The oneof field numbers stay 1, 4, 5, 6, and 7, with 2 and 3 reserved, so the bytes on the wire stay the same. ## Test plan - [x] `go test ./autobahn/types/ -count=1 -run TestConv` - [x] Compile `./internal/autobahn/consensus/` and `./internal/p2p/giga/` Made with [Cursor](https://cursor.com) Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 929820f commit 5645ea5

9 files changed

Lines changed: 120 additions & 122 deletions

File tree

‎sei-tendermint/autobahn/types/consensus.go‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,83 +8,83 @@ import (
88
"github.com/sei-protocol/sei-chain/sei-tendermint/internal/protoutils"
99
)
1010

11-
// ConsensusReq is the interface for all consensus messages.
12-
type ConsensusReq interface {
13-
isConsensusReq()
11+
// ConsensusMsg is the interface for all consensus messages.
12+
type ConsensusMsg interface {
13+
isConsensusMsg()
1414
View() View
1515
}
1616

17-
// ConsensusReqPrepareVote is a PrepareVote variant of ConsensusReq.
18-
type ConsensusReqPrepareVote struct{ *Signed[*PrepareVote] }
17+
// ConsensusMsgPrepareVote is a PrepareVote variant of ConsensusMsg.
18+
type ConsensusMsgPrepareVote struct{ *Signed[*PrepareVote] }
1919

20-
// ConsensusReqCommitVote is a CommitVote variant of ConsensusReq.
21-
type ConsensusReqCommitVote struct{ *Signed[*CommitVote] }
20+
// ConsensusMsgCommitVote is a CommitVote variant of ConsensusMsg.
21+
type ConsensusMsgCommitVote struct{ *Signed[*CommitVote] }
2222

23-
// View implements ConsensusReq.
24-
func (m *ConsensusReqPrepareVote) View() View { return m.Msg().Proposal().View() }
23+
// View implements ConsensusMsg.
24+
func (m *ConsensusMsgPrepareVote) View() View { return m.Msg().Proposal().View() }
2525

26-
// View implements ConsensusReq.
27-
func (m *ConsensusReqCommitVote) View() View { return m.Msg().Proposal().View() }
26+
// View implements ConsensusMsg.
27+
func (m *ConsensusMsgCommitVote) View() View { return m.Msg().Proposal().View() }
2828

29-
func (m *FullProposal) isConsensusReq() {}
30-
func (m *ConsensusReqPrepareVote) isConsensusReq() {}
31-
func (m *ConsensusReqCommitVote) isConsensusReq() {}
32-
func (m *FullTimeoutVote) isConsensusReq() {}
33-
func (m *TimeoutQC) isConsensusReq() {}
29+
func (m *FullProposal) isConsensusMsg() {}
30+
func (m *ConsensusMsgPrepareVote) isConsensusMsg() {}
31+
func (m *ConsensusMsgCommitVote) isConsensusMsg() {}
32+
func (m *FullTimeoutVote) isConsensusMsg() {}
33+
func (m *TimeoutQC) isConsensusMsg() {}
3434

35-
// ConsensusReqConv is the protobuf converter for ConsensusReq.
36-
var ConsensusReqConv = protoutils.Conv[ConsensusReq, *pb.ConsensusReq]{
37-
Encode: func(m ConsensusReq) *pb.ConsensusReq {
35+
// ConsensusMsgConv is the protobuf converter for ConsensusMsg.
36+
var ConsensusMsgConv = protoutils.Conv[ConsensusMsg, *pb.ConsensusMsg]{
37+
Encode: func(m ConsensusMsg) *pb.ConsensusMsg {
3838
switch m := m.(type) {
3939
case *FullProposal:
40-
return &pb.ConsensusReq{
41-
T: &pb.ConsensusReq_Proposal{Proposal: FullProposalConv.Encode(m)},
40+
return &pb.ConsensusMsg{
41+
T: &pb.ConsensusMsg_Proposal{Proposal: FullProposalConv.Encode(m)},
4242
}
43-
case *ConsensusReqPrepareVote:
44-
return &pb.ConsensusReq{
45-
T: &pb.ConsensusReq_PrepareVoteV2{PrepareVoteV2: SignedPrepareVoteConv.Encode(m.Signed)},
43+
case *ConsensusMsgPrepareVote:
44+
return &pb.ConsensusMsg{
45+
T: &pb.ConsensusMsg_PrepareVoteV2{PrepareVoteV2: SignedPrepareVoteConv.Encode(m.Signed)},
4646
}
47-
case *ConsensusReqCommitVote:
48-
return &pb.ConsensusReq{
49-
T: &pb.ConsensusReq_CommitVoteV2{CommitVoteV2: SignedCommitVoteConv.Encode(m.Signed)},
47+
case *ConsensusMsgCommitVote:
48+
return &pb.ConsensusMsg{
49+
T: &pb.ConsensusMsg_CommitVoteV2{CommitVoteV2: SignedCommitVoteConv.Encode(m.Signed)},
5050
}
5151
case *FullTimeoutVote:
52-
return &pb.ConsensusReq{
53-
T: &pb.ConsensusReq_TimeoutVote{TimeoutVote: FullTimeoutVoteConv.Encode(m)},
52+
return &pb.ConsensusMsg{
53+
T: &pb.ConsensusMsg_TimeoutVote{TimeoutVote: FullTimeoutVoteConv.Encode(m)},
5454
}
5555
case *TimeoutQC:
56-
return &pb.ConsensusReq{
57-
T: &pb.ConsensusReq_TimeoutQc{TimeoutQc: TimeoutQCConv.Encode(m)},
56+
return &pb.ConsensusMsg{
57+
T: &pb.ConsensusMsg_TimeoutQc{TimeoutQc: TimeoutQCConv.Encode(m)},
5858
}
5959
default:
60-
panic(fmt.Sprintf("Unknown ConsensusReq type: %T", m))
60+
panic(fmt.Sprintf("Unknown ConsensusMsg type: %T", m))
6161
}
6262
},
63-
Decode: func(m *pb.ConsensusReq) (ConsensusReq, error) {
63+
Decode: func(m *pb.ConsensusMsg) (ConsensusMsg, error) {
6464
if m.T == nil {
6565
return nil, errors.New("empty")
6666
}
6767
switch t := m.T.(type) {
68-
case *pb.ConsensusReq_Proposal:
68+
case *pb.ConsensusMsg_Proposal:
6969
return FullProposalConv.DecodeReq(t.Proposal)
70-
case *pb.ConsensusReq_PrepareVoteV2:
70+
case *pb.ConsensusMsg_PrepareVoteV2:
7171
vote, err := SignedPrepareVoteConv.DecodeReq(t.PrepareVoteV2)
7272
if err != nil {
7373
return nil, fmt.Errorf("prepareVote: %w", err)
7474
}
75-
return &ConsensusReqPrepareVote{vote}, nil
76-
case *pb.ConsensusReq_CommitVoteV2:
75+
return &ConsensusMsgPrepareVote{vote}, nil
76+
case *pb.ConsensusMsg_CommitVoteV2:
7777
vote, err := SignedCommitVoteConv.DecodeReq(t.CommitVoteV2)
7878
if err != nil {
7979
return nil, fmt.Errorf("commitVote: %w", err)
8080
}
81-
return &ConsensusReqCommitVote{vote}, nil
82-
case *pb.ConsensusReq_TimeoutVote:
81+
return &ConsensusMsgCommitVote{vote}, nil
82+
case *pb.ConsensusMsg_TimeoutVote:
8383
return FullTimeoutVoteConv.DecodeReq(t.TimeoutVote)
84-
case *pb.ConsensusReq_TimeoutQc:
84+
case *pb.ConsensusMsg_TimeoutQc:
8585
return TimeoutQCConv.DecodeReq(t.TimeoutQc)
8686
default:
87-
return nil, fmt.Errorf("unknown ConsensusReq type: %T", t)
87+
return nil, fmt.Errorf("unknown ConsensusMsg type: %T", t)
8888
}
8989
},
9090
}

‎sei-tendermint/autobahn/types/types_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ func TestConv(t *testing.T) {
5858
AppVoteConv.Test(GenAppVote(rng)),
5959
LaneRangeConv.Test(GenLaneRange(rng)),
6060
ViewConv.Test(GenView(rng)),
61-
ConsensusReqConv.Test(GenFullProposal(rng)),
62-
ConsensusReqConv.Test(&ConsensusReqPrepareVote{GenSigned(rng, GenPrepareVote(rng))}),
63-
ConsensusReqConv.Test(&ConsensusReqCommitVote{GenSigned(rng, GenCommitVote(rng))}),
64-
ConsensusReqConv.Test(GenFullTimeoutVote(rng)),
65-
ConsensusReqConv.Test(GenTimeoutQC(rng)),
61+
ConsensusMsgConv.Test(GenFullProposal(rng)),
62+
ConsensusMsgConv.Test(&ConsensusMsgPrepareVote{GenSigned(rng, GenPrepareVote(rng))}),
63+
ConsensusMsgConv.Test(&ConsensusMsgCommitVote{GenSigned(rng, GenCommitVote(rng))}),
64+
ConsensusMsgConv.Test(GenFullTimeoutVote(rng)),
65+
ConsensusMsgConv.Test(GenTimeoutQC(rng)),
6666
msgTest(rng, GenLaneProposal(rng), LaneProposalConv, SignedLaneProposalConv),
6767
msgTest(rng, GenLaneVote(rng), LaneVoteConv, SignedLaneVoteConv),
6868
msgTest(rng, GenProposal(rng), ProposalConv, SignedProposalConv),

‎sei-tendermint/internal/autobahn/autobahn.proto‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,7 @@ message SignedAppProposal {
303303
Signature sig = 2;
304304
}
305305

306-
// TODO(gprusak): rename to ConsensusMsg
307-
message ConsensusReq {
306+
message ConsensusMsg {
308307
reserved "prepare_vote", "commit_vote";
309308
reserved 2, 3;
310309
option (wireguard.sized) = true;

‎sei-tendermint/internal/autobahn/consensus/state.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ type State struct {
5656

5757
myView utils.AtomicSend[types.ViewSpec]
5858
myProposal utils.AtomicSend[utils.Option[*types.FullProposal]]
59-
myPrepareVote utils.AtomicSend[utils.Option[*types.ConsensusReqPrepareVote]]
60-
myCommitVote utils.AtomicSend[utils.Option[*types.ConsensusReqCommitVote]]
59+
myPrepareVote utils.AtomicSend[utils.Option[*types.ConsensusMsgPrepareVote]]
60+
myCommitVote utils.AtomicSend[utils.Option[*types.ConsensusMsgCommitVote]]
6161
myTimeoutVote utils.AtomicSend[utils.Option[*types.FullTimeoutVote]]
6262
myTimeoutQC utils.AtomicSend[utils.Option[*types.TimeoutQC]]
6363
}
@@ -66,10 +66,10 @@ type State struct {
6666
func (s *State) SubscribeProposal() utils.AtomicRecv[utils.Option[*types.FullProposal]] {
6767
return s.myProposal.Subscribe()
6868
}
69-
func (s *State) SubscribePrepareVote() utils.AtomicRecv[utils.Option[*types.ConsensusReqPrepareVote]] {
69+
func (s *State) SubscribePrepareVote() utils.AtomicRecv[utils.Option[*types.ConsensusMsgPrepareVote]] {
7070
return s.myPrepareVote.Subscribe()
7171
}
72-
func (s *State) SubscribeCommitVote() utils.AtomicRecv[utils.Option[*types.ConsensusReqCommitVote]] {
72+
func (s *State) SubscribeCommitVote() utils.AtomicRecv[utils.Option[*types.ConsensusMsgCommitVote]] {
7373
return s.myCommitVote.Subscribe()
7474
}
7575
func (s *State) SubscribeTimeoutVote() utils.AtomicRecv[utils.Option[*types.FullTimeoutVote]] {
@@ -130,8 +130,8 @@ func newState(
130130

131131
myView: utils.NewAtomicSend(types.ViewSpec{ConsensusSpec: initialInner.spec, TimeoutQC: initialInner.TimeoutQC}),
132132
myProposal: utils.NewAtomicSend(utils.None[*types.FullProposal]()),
133-
myPrepareVote: utils.NewAtomicSend(utils.None[*types.ConsensusReqPrepareVote]()),
134-
myCommitVote: utils.NewAtomicSend(utils.None[*types.ConsensusReqCommitVote]()),
133+
myPrepareVote: utils.NewAtomicSend(utils.None[*types.ConsensusMsgPrepareVote]()),
134+
myCommitVote: utils.NewAtomicSend(utils.None[*types.ConsensusMsgCommitVote]()),
135135
myTimeoutVote: utils.NewAtomicSend(utils.None[*types.FullTimeoutVote]()),
136136
myTimeoutQC: utils.NewAtomicSend(utils.None[*types.TimeoutQC]()),
137137
}
@@ -266,7 +266,7 @@ func (s *State) runPropose(ctx context.Context) error {
266266
})
267267
}
268268

269-
func updateOutput[T types.ConsensusReq](w *utils.AtomicSend[utils.Option[T]], v T) {
269+
func updateOutput[T types.ConsensusMsg](w *utils.AtomicSend[utils.Option[T]], v T) {
270270
old := w.Load()
271271
if !v.View().Less(types.NextViewOpt(old)) {
272272
w.Store(utils.Some(v))
@@ -293,10 +293,10 @@ func (s *State) runOutputs(ctx context.Context) error {
293293
}
294294
}
295295
if v, ok := i.PrepareVote.Get(); ok {
296-
updateOutput(&s.myPrepareVote, &types.ConsensusReqPrepareVote{Signed: v})
296+
updateOutput(&s.myPrepareVote, &types.ConsensusMsgPrepareVote{Signed: v})
297297
}
298298
if v, ok := i.CommitVote.Get(); ok {
299-
updateOutput(&s.myCommitVote, &types.ConsensusReqCommitVote{Signed: v})
299+
updateOutput(&s.myCommitVote, &types.ConsensusMsgCommitVote{Signed: v})
300300
}
301301
if v, ok := i.TimeoutVote.Get(); ok {
302302
updateOutput(&s.myTimeoutVote, v)

‎sei-tendermint/internal/autobahn/consensus/testonly.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func RunTestNetwork(ctx context.Context, states []*State) error {
4040
})
4141
}
4242
s.Spawn(func() error {
43-
return from.SubscribePrepareVote().Iter(ctx, func(_ context.Context, msg utils.Option[*types.ConsensusReqPrepareVote]) error {
43+
return from.SubscribePrepareVote().Iter(ctx, func(_ context.Context, msg utils.Option[*types.ConsensusMsgPrepareVote]) error {
4444
if vote, ok := msg.Get(); ok {
4545
for _, to := range states {
4646
if err := to.PushPrepareVote(vote.Signed); err != nil {
@@ -52,7 +52,7 @@ func RunTestNetwork(ctx context.Context, states []*State) error {
5252
})
5353
})
5454
s.Spawn(func() error {
55-
return from.SubscribeCommitVote().Iter(ctx, func(_ context.Context, msg utils.Option[*types.ConsensusReqCommitVote]) error {
55+
return from.SubscribeCommitVote().Iter(ctx, func(_ context.Context, msg utils.Option[*types.ConsensusMsgCommitVote]) error {
5656
vote, ok := msg.Get()
5757
if !ok {
5858
return nil

0 commit comments

Comments
 (0)