-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: batch processing non-finalised blocks #57
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
package service | ||
|
||
import ( | ||
"encoding/hex" | ||
"encoding/json" | ||
"errors" | ||
"fmt" | ||
|
@@ -194,52 +193,51 @@ func (fp *FinalityProviderInstance) IsRunning() bool { | |
func (fp *FinalityProviderInstance) finalitySigSubmissionLoop() { | ||
defer fp.wg.Done() | ||
|
||
var targetHeight uint64 | ||
for { | ||
select { | ||
case b := <-fp.poller.GetBlockInfoChan(): | ||
fp.logger.Debug( | ||
"the finality-provider received a new block, start processing", | ||
zap.String("pk", fp.GetBtcPkHex()), | ||
zap.Uint64("height", b.Height), | ||
zap.String("block_hash", hex.EncodeToString(b.Hash)), | ||
) | ||
|
||
// check whether the block has been processed before | ||
if fp.hasProcessed(b.Height) { | ||
continue | ||
} | ||
// check whether the finality provider has voting power | ||
hasVp, err := fp.hasVotingPower(b.Height) | ||
if err != nil { | ||
fp.reportCriticalErr(err) | ||
continue | ||
} | ||
if !hasVp { | ||
// the finality provider does not have voting power | ||
// and it will never will at this block | ||
fp.MustSetLastProcessedHeight(b.Height) | ||
fp.metrics.IncrementFpTotalBlocksWithoutVotingPower(fp.GetBtcPkHex()) | ||
continue | ||
} | ||
// check whether the randomness has been committed | ||
// the retry will end if max retry times is reached | ||
// or the target block is finalized | ||
isFinalized, err := fp.retryCheckRandomnessUntilBlockFinalized(b) | ||
shouldProcess, err := fp.shouldProcessBlock(b) | ||
if err != nil { | ||
if !errors.Is(err, ErrFinalityProviderShutDown) { | ||
fp.reportCriticalErr(err) | ||
} | ||
break | ||
continue | ||
} | ||
// the block is finalized, no need to submit finality signature | ||
if isFinalized { | ||
fp.MustSetLastProcessedHeight(b.Height) | ||
if !shouldProcess { | ||
continue | ||
} | ||
|
||
// use the copy of the block to avoid the impact to other receivers | ||
nextBlock := *b | ||
res, err := fp.retrySubmitFinalitySignatureUntilBlockFinalized(&nextBlock) | ||
// Fetch all available blocks | ||
// Note: not all the blocks in the range will have votes cast | ||
// due to lack of voting power or public randomness, so we may | ||
// have gaps during processing | ||
pollerBlocks := []*types.BlockInfo{b} | ||
fetchMoreBlocks := true | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we probably don't need this flag. We can use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, it is removed. |
||
for fetchMoreBlocks { | ||
select { | ||
case b := <-fp.poller.GetBlockInfoChan(): | ||
shouldProcess, err := fp.shouldProcessBlock(b) | ||
if err != nil { | ||
if !errors.Is(err, ErrFinalityProviderShutDown) { | ||
fp.reportCriticalErr(err) | ||
} | ||
fetchMoreBlocks = false | ||
break | ||
} | ||
if shouldProcess { | ||
pollerBlocks = append(pollerBlocks, b) | ||
} | ||
default: | ||
fetchMoreBlocks = false | ||
} | ||
} | ||
targetHeight = pollerBlocks[len(pollerBlocks)-1].Height | ||
fp.logger.Debug("the finality-provider received new block(s), start processing", | ||
zap.String("pk", fp.GetBtcPkHex()), | ||
zap.Uint64("start_height", pollerBlocks[0].Height), | ||
zap.Uint64("end_height", targetHeight), | ||
) | ||
res, err := fp.retrySubmitFinalitySignatureUntilBlocksFinalized(pollerBlocks) | ||
if err != nil { | ||
fp.metrics.IncrementFpTotalFailedVotes(fp.GetBtcPkHex()) | ||
if !errors.Is(err, ErrFinalityProviderShutDown) { | ||
|
@@ -254,13 +252,13 @@ func (fp *FinalityProviderInstance) finalitySigSubmissionLoop() { | |
continue | ||
} | ||
fp.logger.Info( | ||
"successfully submitted a finality signature to the consumer chain", | ||
"successfully submitted the finality signature to the consumer chain", | ||
zap.String("consumer_id", string(fp.GetChainID())), | ||
zap.String("pk", fp.GetBtcPkHex()), | ||
zap.Uint64("height", b.Height), | ||
zap.Uint64("start_height", pollerBlocks[0].Height), | ||
zap.Uint64("end_height", targetHeight), | ||
zap.String("tx_hash", res.TxHash), | ||
) | ||
|
||
case targetBlock := <-fp.laggingTargetChan: | ||
res, err := fp.tryFastSync(targetBlock) | ||
fp.isLagging.Store(false) | ||
|
@@ -312,6 +310,38 @@ func (fp *FinalityProviderInstance) finalitySigSubmissionLoop() { | |
} | ||
} | ||
|
||
func (fp *FinalityProviderInstance) shouldProcessBlock(b *types.BlockInfo) (bool, error) { | ||
// check whether the block has been processed before | ||
if fp.hasProcessed(b.Height) { | ||
return false, nil | ||
} | ||
// check whether the finality provider has voting power | ||
hasVp, err := fp.hasVotingPower(b.Height) | ||
if err != nil { | ||
return false, err | ||
} | ||
if !hasVp { | ||
// the finality provider does not have voting power | ||
// and it will never will at this block | ||
fp.MustSetLastProcessedHeight(b.Height) | ||
fp.metrics.IncrementFpTotalBlocksWithoutVotingPower(fp.GetBtcPkHex()) | ||
return false, nil | ||
} | ||
// check whether the randomness has been committed | ||
// the retry will end if max retry times is reached | ||
// or the target block is finalized | ||
isFinalized, err := fp.retryCheckRandomnessUntilBlockFinalized(b) | ||
if err != nil { | ||
return false, err | ||
} | ||
// the block is finalized, no need to submit finality signature | ||
if isFinalized { | ||
fp.MustSetLastProcessedHeight(b.Height) | ||
return false, nil | ||
} | ||
return true, nil | ||
} | ||
|
||
func (fp *FinalityProviderInstance) randomnessCommitmentLoop(startHeight uint64) { | ||
defer fp.wg.Done() | ||
|
||
|
@@ -601,23 +631,29 @@ func (fp *FinalityProviderInstance) retryCheckRandomnessUntilBlockFinalized(targ | |
} | ||
} | ||
|
||
// retrySubmitFinalitySignatureUntilBlockFinalized periodically tries to submit finality signature until success or the block is finalized | ||
// retrySubmitFinalitySignatureUntilBlocksFinalized periodically tries to submit finality signature until success or the block is finalized | ||
// error will be returned if maximum retries have been reached or the query to the consumer chain fails | ||
func (fp *FinalityProviderInstance) retrySubmitFinalitySignatureUntilBlockFinalized(targetBlock *types.BlockInfo) (*types.TxResponse, error) { | ||
func (fp *FinalityProviderInstance) retrySubmitFinalitySignatureUntilBlocksFinalized(targetBlocks []*types.BlockInfo) (*types.TxResponse, error) { | ||
var failedCycles uint32 | ||
|
||
targetHeight := targetBlocks[len(targetBlocks)-1].Height | ||
// we break the for loop if the block is finalized or the signature is successfully submitted | ||
// error will be returned if maximum retries have been reached or the query to the consumer chain fails | ||
for { | ||
// error will be returned if max retries have been reached | ||
res, err := fp.SubmitFinalitySignature(targetBlock) | ||
var res *types.TxResponse | ||
var err error | ||
if len(targetBlocks) == 1 { | ||
res, err = fp.SubmitFinalitySignature(targetBlocks[0]) | ||
} else { | ||
res, err = fp.SubmitBatchFinalitySignatures(targetBlocks) | ||
} | ||
if err != nil { | ||
|
||
fp.logger.Debug( | ||
"failed to submit finality signature to the consumer chain", | ||
zap.String("pk", fp.GetBtcPkHex()), | ||
zap.Uint32("current_failures", failedCycles), | ||
zap.Uint64("target_block_height", targetBlock.Height), | ||
zap.Uint64("target_start_height", targetBlocks[0].Height), | ||
zap.Uint64("target_end_height", targetHeight), | ||
zap.Error(err), | ||
) | ||
|
||
|
@@ -640,15 +676,15 @@ func (fp *FinalityProviderInstance) retrySubmitFinalitySignatureUntilBlockFinali | |
select { | ||
case <-time.After(fp.cfg.SubmissionRetryInterval): | ||
// periodically query the index block to be later checked whether it is Finalized | ||
finalized, err := fp.consumerCon.QueryIsBlockFinalized(targetBlock.Height) | ||
finalized, err := fp.consumerCon.QueryIsBlockFinalized(targetHeight) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to query block finalization at height %v: %w", targetBlock.Height, err) | ||
return nil, fmt.Errorf("failed to query block finalization at height %v: %w", targetHeight, err) | ||
} | ||
if finalized { | ||
fp.logger.Debug( | ||
"the block is already finalized, skip submission", | ||
zap.String("pk", fp.GetBtcPkHex()), | ||
zap.Uint64("target_height", targetBlock.Height), | ||
zap.Uint64("target_height", targetHeight), | ||
) | ||
// TODO: returning nil here is to safely break the loop | ||
// the error still exists | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can put it in the default case where we have
getAllBlocksFromChan()
to drain the channel and then try to process each block and do batch sendThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean to put the
var targetHeight uint64
in thedefault
case of the inner loop?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant the entire block fetching logic can be put in the
default
case so that we can have a method to fetch them all other thanfetch one, and the rest
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Updated.