add back rebuilt flag

Signed-off-by: Chengxuan Xing <[email protected]>

Author: Chengxuan

pkg/ffcapi/api.go

@@ -96,11 +96,18 @@ type API interface {
 }
 
 type ConfirmationUpdateResult struct {
-	// confirmation queue has a list of confirmed blocks for a transaction
-	// the first block is the block that contains the transaction hash
+	// a linked list of accumulated confirmations for a transaction
+	// the list is sorted by block number
+	//    - the first block is the block that contains the transaction hash
+	//    - the last block is the most recent confirmation
+	// this list can be used as input to the future reconcile request to avoid re-fetching the blocks if they are no longer
+	// in the in-memory partial chain
+	// WARNING: mutation to this list is not expected, invalid modifications will cause inefficiencies in the reconciliation process
+	//          `rebuilt` will be true if an invalid confirmation list is detected by the reconciliation process
 	Confirmations           []*MinimalBlockInfo `json:"confirmations,omitempty"`
-	NewFork                 bool                `json:"newFork,omitempty"`       // when true, it means a fork is detected based on the existing confirmations
-	Confirmed               bool                `json:"confirmed,omitempty"`     // when true, it means the confirmation queue is complete and all the blocks are confirmed
+	Rebuilt                 bool                `json:"rebuilt,omitempty"`       // when true, it means the existing confirmations contained invalid blocks, the new confirmations are rebuilt from scratch
+	NewFork                 bool                `json:"newFork,omitempty"`       // when true, it means a new fork was detected based on the existing confirmations, this will always be false if `rebuilt` is true
+	Confirmed               bool                `json:"confirmed,omitempty"`     // when true, it means the confirmation list is complete and the transaction is confirmed
 	TargetConfirmationCount uint64              `json:"targetConfirmationCount"` // the target number of confirmations for this reconcile request
 }
 type MinimalBlockInfo struct { // duplicate of apitypes.Confirmation due to circular dependency