add useful comments

btcclient/client_block_subscriber.go

@@ -92,7 +92,7 @@ func (c *Client) mustSubscribeBlocksByWebSocket() {
 		panic(err)
 	}
 
-	err = types.Retry(initialInterval, maxInterval, func() error { // TODO: make retry parameters universal and accessible here
+	err = types.Retry(initialInterval, maxInterval, func() error {
 		return c.subscribeBlocksByWebSocket()
 	})
 

reporter/btc_handlers.go

@@ -75,8 +75,8 @@ func (r *Reporter) submitHeader(signer sdk.AccAddress, header *wire.BlockHeader)
 		return err
 	}
 
+	//TODO implement retry mechanism in mustSubmitHeader and keep submitHeader as it is
 	err = types.Retry(initialInterval, maxInterval, func() error {
-		//TODO implement retry mechanism in mustSubmitHeader and keep submitHeader as it is
 		msgInsertHeader := types.NewMsgInsertHeader(r.babylonClient.Cfg.AccountPrefix, signer, header)
 		res, err = r.babylonClient.InsertHeader(msgInsertHeader)
 		if err != nil {
@@ -222,8 +222,8 @@ func (r *Reporter) matchAndSubmitCkpts(signer sdk.AccAddress) error {
 			continue
 		}
 
+		//TODO implement retry mechanism in mustInsertBTCSpvProof and keep InsertBTCSpvProof as it is
 		err = types.Retry(initialInterval, maxInterval, func() error {
-			//TODO implement retry mechanism in mustInsertBTCSpvProof and keep InsertBTCSpvProof as it is
 			res, err = r.babylonClient.InsertBTCSpvProof(msgInsertBTCSpvProof)
 			return err
 		})

types/utils.go

@@ -62,10 +62,9 @@ func GetWrappedTxs(msg *wire.MsgBlock) []*btcutil.Tx {
 }
 
 // Retry retries the retryableFunc. In each iteration it will exponentially increase the sleep
-// time and will stop retrying once maxSleepTime is reached. isUnrecoverableErr identifies
-// if an error is unsafe. It will stop retry execution and return error to caller.
-// isExpectedErr is used to identify if an error can be safely ignored, retry will
-// stop execution but will return nil to caller.
+// time and will stop retrying once maxSleepTime is reached.
+// - isUnrecoverableErr identifies if an error is unsafe. It will stop retry execution and return error to caller.
+// - isExpectedErr is used to identify if an error can be safely ignored, retry will stop execution but will return nil to caller.
 func Retry(sleep time.Duration, maxSleepTime time.Duration, retryableFunc func() error) error {
 	if err := retryableFunc(); err != nil {
 		if isUnrecoverableErr(err) {