-
Notifications
You must be signed in to change notification settings - Fork 2
/
greenfield_vote_processor.go
375 lines (335 loc) · 11.9 KB
/
greenfield_vote_processor.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
package vote
import (
"bytes"
"context"
"encoding/hex"
"errors"
"fmt"
"math/big"
"sync"
"time"
"github.com/avast/retry-go/v4"
"github.com/cometbft/cometbft/votepool"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/crypto"
"gorm.io/gorm"
rcommon "github.com/bnb-chain/greenfield-relayer/common"
"github.com/bnb-chain/greenfield-relayer/config"
"github.com/bnb-chain/greenfield-relayer/db"
"github.com/bnb-chain/greenfield-relayer/db/dao"
"github.com/bnb-chain/greenfield-relayer/db/model"
"github.com/bnb-chain/greenfield-relayer/executor"
"github.com/bnb-chain/greenfield-relayer/logging"
"github.com/bnb-chain/greenfield-relayer/types"
"github.com/bnb-chain/greenfield-relayer/util"
)
type GreenfieldVoteProcessor struct {
daoManager *dao.DaoManager
config *config.Config
signer *VoteSigner
greenfieldExecutor *executor.GreenfieldExecutor
blsPublicKey []byte
eventType votepool.EventType
}
func NewGreenfieldVoteProcessor(cfg *config.Config, dao *dao.DaoManager, signer *VoteSigner,
greenfieldExecutor *executor.GreenfieldExecutor) *GreenfieldVoteProcessor {
var eventType votepool.EventType
if cfg.BSCConfig.IsOpCrossChain() {
eventType = votepool.ToOpCrossChainEvent
} else {
eventType = votepool.ToBscCrossChainEvent
}
return &GreenfieldVoteProcessor{
config: cfg,
daoManager: dao,
signer: signer,
greenfieldExecutor: greenfieldExecutor,
blsPublicKey: greenfieldExecutor.BlsPubKey,
eventType: eventType,
}
}
// SignAndBroadcastLoop signs tx using the relayer's bls private key, then broadcasts the vote to Greenfield votepool
func (p *GreenfieldVoteProcessor) SignAndBroadcastLoop() {
ticker := time.NewTicker(time.Duration(p.config.VotePoolConfig.BroadcastIntervalInMillisecond) * time.Millisecond)
for range ticker.C {
if err := p.signAndBroadcast(); err != nil {
logging.Logger.Errorf("encounter error, err: %s", err.Error())
}
}
}
func (p *GreenfieldVoteProcessor) signAndBroadcast() error {
txs, err := p.daoManager.GreenfieldDao.GetTransactionsByStatusWithLimit(db.Saved, p.config.VotePoolConfig.VotesBatchMaxSizePerInterval)
if err != nil {
return fmt.Errorf("failed to get transactions from db, error: %s", err.Error())
}
if len(txs) == 0 {
return nil
}
// for every tx, we are going to sign it and broadcast vote of it.
for _, tx := range txs {
//in case there is chance that reprocessing same transactions(caused by DB data loss) or processing outdated
//transactions from block( when relayer need to catch up others), this ensures relayer will skip to next transaction directly
isFilled, err := p.isTxSequenceFilled(tx)
if err != nil {
return err
}
if isFilled {
if err = p.daoManager.GreenfieldDao.UpdateTransactionStatus(tx.Id, db.Delivered); err != nil {
return err
}
logging.Logger.Infof("sequence %d for channel %d has already been filled ", tx.Sequence, tx.ChannelId)
continue
}
aggregatedPayload, err := p.aggregatePayloadForTx(tx)
if err != nil {
return err
}
v := p.constructVoteAndSign(aggregatedPayload)
// broadcast v
if err = retry.Do(func() error {
logging.Logger.Debugf("broadcasting vote with c %d and seq %d", tx.ChannelId, tx.Sequence)
err = p.greenfieldExecutor.BroadcastVote(v)
if err != nil {
return fmt.Errorf("failed to submit vote for event with channel id %d and sequence %d, err=%s", tx.ChannelId, tx.Sequence, err.Error())
}
return nil
}, retry.Context(context.Background()), rcommon.RtyAttem, rcommon.RtyDelay, rcommon.RtyErr); err != nil {
return err
}
// After vote submitted to vote pool, persist vote Data and update the status of tx to 'SELF_VOTED'.
err = p.daoManager.GreenfieldDao.DB.Transaction(func(dbTx *gorm.DB) error {
if e := dao.UpdateTransactionStatus(dbTx, tx.Id, db.SelfVoted); e != nil {
return e
}
exist, e := dao.IsVoteExist(dbTx, tx.ChannelId, tx.Sequence, hex.EncodeToString(v.PubKey[:]))
if e != nil {
return e
}
if !exist {
if e = dao.SaveVote(dbTx, EntityToDto(v, tx.ChannelId, tx.Sequence, aggregatedPayload, int64(tx.Height))); e != nil {
return e
}
}
return nil
})
if err != nil {
return err
}
}
return nil
}
func (p *GreenfieldVoteProcessor) CollectVotesLoop() {
ticker := time.NewTicker(time.Duration(p.config.VotePoolConfig.QueryIntervalInMillisecond) * time.Millisecond)
for range ticker.C {
if err := p.collectVotes(); err != nil {
logging.Logger.Errorf("encounter error, err: %s", err.Error())
}
}
}
func (p *GreenfieldVoteProcessor) collectVotes() error {
txs, err := p.daoManager.GreenfieldDao.GetTransactionsByStatusWithLimit(db.SelfVoted, p.config.VotePoolConfig.VotesBatchMaxSizePerInterval)
if err != nil {
logging.Logger.Errorf("failed to get voted transactions from db, error: %s", err.Error())
return err
}
wg := new(sync.WaitGroup)
errCh := make(chan error)
waitCh := make(chan struct{})
go func() {
for _, tx := range txs {
wg.Add(1)
go p.collectVoteForTx(tx, errCh, wg)
}
wg.Wait()
close(waitCh)
}()
for {
select {
case err = <-errCh:
return err
case <-waitCh:
return nil
}
}
}
func (p *GreenfieldVoteProcessor) collectVoteForTx(tx *model.GreenfieldRelayTransaction, errChan chan error, wg *sync.WaitGroup) {
defer wg.Done()
isFilled, err := p.isTxSequenceFilled(tx)
if err != nil {
errChan <- err
return
}
if isFilled {
if err = p.daoManager.GreenfieldDao.UpdateTransactionStatus(tx.Id, db.Delivered); err != nil {
errChan <- err
return
}
logging.Logger.Infof("sequence %d for channel %d has already been filled ", tx.Sequence, tx.ChannelId)
return
}
if err = p.prepareEnoughValidVotesForTx(tx); err != nil {
errChan <- err
return
}
if err = p.daoManager.GreenfieldDao.UpdateTransactionStatus(tx.Id, db.AllVoted); err != nil {
errChan <- err
return
}
}
// prepareEnoughValidVotesForTx fetches and validate votes result, store in vote table
func (p *GreenfieldVoteProcessor) prepareEnoughValidVotesForTx(tx *model.GreenfieldRelayTransaction) error {
localVote, err := p.daoManager.VoteDao.GetVoteByChannelIdAndSequenceAndPubKey(tx.ChannelId, tx.Sequence, hex.EncodeToString(p.blsPublicKey))
if err != nil {
return err
}
validators, err := p.greenfieldExecutor.BscExecutor.QueryCachedLatestValidators()
if err != nil {
return err
}
count, err := p.daoManager.VoteDao.GetVotesCountByChannelIdAndSequence(tx.ChannelId, tx.Sequence)
if err != nil {
return err
}
if count > int64(len(validators))*2/3 {
return nil
}
if err = p.queryMoreThanTwoThirdVotesForTx(localVote, validators); err != nil {
return err
}
return nil
}
// queryMoreThanTwoThirdVotesForTx queries votes from votePool
func (p *GreenfieldVoteProcessor) queryMoreThanTwoThirdVotesForTx(localVote *model.Vote, validators []types.Validator) error {
triedTimes := 0
validVotesTotalCount := 1 // assume local vote is valid
channelId := localVote.ChannelId
seq := localVote.Sequence
ticker := time.NewTicker(VotePoolQueryRetryInterval)
for range ticker.C {
triedTimes++
if triedTimes > QueryVotepoolMaxRetryTimes {
return fmt.Errorf("exceed max retry=%d", QueryVotepoolMaxRetryTimes)
}
queriedVotes, err := p.greenfieldExecutor.QueryVotesByEventHashAndType(localVote.EventHash, p.eventType)
if err != nil {
return fmt.Errorf("failed to query votes. eventHash=%s", hex.EncodeToString(localVote.EventHash))
}
validVotesCountPerReq := len(queriedVotes)
if validVotesCountPerReq == 0 {
if err := p.reBroadcastVote(localVote); err != nil {
return fmt.Errorf("failed to broadcast vote, err=%s", err.Error())
}
continue
}
isLocalVoteIncluded := false
for _, v := range queriedVotes {
if !p.isVotePubKeyValid(v, validators) {
validVotesCountPerReq--
continue
}
if err = VerifySignature(v, localVote.EventHash); err != nil {
validVotesCountPerReq--
continue
}
// check if it is local vote
if bytes.Equal(v.PubKey[:], p.blsPublicKey) {
isLocalVoteIncluded = true
validVotesCountPerReq--
continue
}
// check duplicate, the vote might have been saved in previous request.
exist, err := p.daoManager.VoteDao.IsVoteExist(channelId, seq, hex.EncodeToString(v.PubKey[:]))
if err != nil {
return err
}
if exist {
validVotesCountPerReq--
continue
}
// a vote result persisted into DB should be valid, unique.
if err = p.daoManager.VoteDao.SaveVote(EntityToDto(v, channelId, seq, localVote.ClaimPayload, localVote.Height)); err != nil {
return err
}
}
validVotesTotalCount += validVotesCountPerReq
if validVotesTotalCount > len(validators)*2/3 {
return nil
}
if !isLocalVoteIncluded {
if err = p.reBroadcastVote(localVote); err != nil {
return fmt.Errorf("failed to broadcast vote, err=%s", err.Error())
}
}
continue
}
return nil
}
func (p *GreenfieldVoteProcessor) constructVoteAndSign(aggregatedPayload []byte) *votepool.Vote {
var v votepool.Vote
v.EventType = p.eventType
v.EventHash = p.getEventHash(aggregatedPayload)
p.signer.SignVote(&v)
return &v
}
func (p *GreenfieldVoteProcessor) getEventHash(aggregatedPayload []byte) []byte {
return crypto.Keccak256Hash(aggregatedPayload).Bytes()
}
func (p *GreenfieldVoteProcessor) isVotePubKeyValid(v *votepool.Vote, validators []types.Validator) bool {
for _, validator := range validators {
if bytes.Equal(v.PubKey[:], validator.BlsPublicKey[:]) {
return true
}
}
return false
}
// aggregatePayloadForTx aggregate required fields by concatenating their bytes, this will be used as payload when
// calling BSC smart contract, and also used to generate eventHash for broadcasting vote
func (p *GreenfieldVoteProcessor) aggregatePayloadForTx(tx *model.GreenfieldRelayTransaction) ([]byte, error) {
var aggregatedPayload []byte
aggregatedPayload = append(aggregatedPayload, util.Uint16ToBytes(uint16(tx.SrcChainId))...)
aggregatedPayload = append(aggregatedPayload, util.Uint16ToBytes(uint16(tx.DestChainId))...)
aggregatedPayload = append(aggregatedPayload, tx.ChannelId)
aggregatedPayload = append(aggregatedPayload, util.Uint64ToBytes(tx.Sequence)...)
aggregatedPayload = append(aggregatedPayload, uint8(tx.PackageType))
aggregatedPayload = append(aggregatedPayload, util.Uint64ToBytes(uint64(tx.TxTime))...)
// relayerfee big.Int
relayerFeeBts, err := p.txFeeToBytes(tx.RelayerFee)
if err != nil {
return nil, fmt.Errorf("failed to convert tx relayerFee %s from string to big.Int", tx.RelayerFee)
}
aggregatedPayload = append(aggregatedPayload, relayerFeeBts...)
if tx.PackageType == uint32(sdk.SynCrossChainPackageType) {
ackRelayerFeeBts, err := p.txFeeToBytes(tx.AckRelayerFee)
if err != nil {
return nil, fmt.Errorf("failed to convert tx ackRelayerFee %s from string to big.Int", tx.AckRelayerFee)
}
aggregatedPayload = append(aggregatedPayload, ackRelayerFeeBts...)
}
aggregatedPayload = append(aggregatedPayload, common.Hex2Bytes(tx.PayLoad)...)
return aggregatedPayload, nil
}
func (p *GreenfieldVoteProcessor) txFeeToBytes(txFee string) ([]byte, error) {
fee, ok := new(big.Int).SetString(txFee, 10)
if !ok {
return nil, errors.New("failed to convert tx fee")
}
feeBytes := make([]byte, 32)
fee.FillBytes(feeBytes)
return feeBytes, nil
}
func (p *GreenfieldVoteProcessor) isTxSequenceFilled(tx *model.GreenfieldRelayTransaction) (bool, error) {
nextDeliverySequence, err := p.greenfieldExecutor.GetNextDeliverySequenceForChannelWithRetry(types.ChannelId(tx.ChannelId))
if err != nil {
return false, fmt.Errorf("failed to get next delivery sequence, err=%s", err.Error())
}
return tx.Sequence < nextDeliverySequence, nil
}
func (p *GreenfieldVoteProcessor) reBroadcastVote(localVote *model.Vote) error {
logging.Logger.Debugf("broadcasting vote with c %d and seq %d", localVote.ChannelId, localVote.Sequence)
v, err := DtoToEntity(localVote)
if err != nil {
return err
}
return p.greenfieldExecutor.BroadcastVote(v)
}