rpc/jsonrpc: fixed duplicate and incorrect state-sync transaction receipts post Madhugiri (#97)

* rpc/jsonrpc: fixed duplicate and incorrect state-sync transaction receipts post Madhugiri

* rpc/jsonrpc: removed commented code

* rpc/jsonrpc: moved the check only when we have >0 events

Author: pratikspatil024

rpc/jsonrpc/erigon_receipts.go

@@ -410,7 +410,15 @@ func (api *ErigonImpl) GetBlockReceiptsByBlockHash(ctx context.Context, cannonic
 				return nil, err
 			}
 
-			result = append(result, ethutils.MarshalReceipt(borReceipt, bortypes.NewBorTransaction(), chainConfig, block.HeaderNoCopy(), borReceipt.TxHash, false, false))
+			var borTx types.Transaction = bortypes.NewBorTransaction()
+			if chainConfig.Bor.IsMadhugiri(blockNum) {
+				borTx = block.Transactions()[len(block.Transactions())-1]
+				if borTx.Type() != types.StateSyncTxType {
+					return nil, fmt.Errorf("the last transaction is not a state-sync transaction %x", block.Hash())
+				}
+			}
+
+			result = append(result, ethutils.MarshalReceipt(borReceipt, borTx, chainConfig, block.HeaderNoCopy(), borReceipt.TxHash, false, false))
 		}
 	}
 

rpc/jsonrpc/eth_receipts.go

@@ -576,34 +576,30 @@ func (api *APIImpl) GetBlockReceipts(ctx context.Context, numberOrHash rpc.Block
 	if err != nil {
 		return nil, err
 	}
+
+	// Get normal transaction receipts.
+	// This DOES NOT generate state-sync transaction receipt for bor.
 	receipts, err := api.getReceipts(ctx, tx, block)
 	if err != nil {
 		return nil, fmt.Errorf("getReceipts error: %w", err)
 	}
 
 	numReceipts := len(receipts)
-	numTxs := len(block.Transactions())
 	result := make([]map[string]interface{}, 0, numReceipts)
 
-	// track if we already have a state-sync receipt coming from the generator
-	hasBorStateSyncReceipt := false
-
+	// Marshal normal transaction receipts and append to result
 	for _, receipt := range receipts {
-		// State-sync receipts' TransactionIndex is equal to numTxs.
-		if int(receipt.TransactionIndex) == numTxs {
-			// This is a state-sync transaction receipt.
-			hasBorStateSyncReceipt = true
-			result = append(result, ethutils.MarshalReceipt(receipt, bortypes.NewBorTransaction(), chainConfig, block.HeaderNoCopy(), receipt.TxHash, false, true))
-		} else {
-			// This is a normal transaction receipt.
-			txn := block.Transactions()[receipt.TransactionIndex]
-			result = append(result, ethutils.MarshalReceipt(receipt, txn, chainConfig, block.HeaderNoCopy(), txn.Hash(), true, true))
-		}
+		txn := block.Transactions()[receipt.TransactionIndex]
+		result = append(result, ethutils.MarshalReceipt(receipt, txn, chainConfig, block.HeaderNoCopy(), txn.Hash(), true, true))
+	}
+
+	// check for state sync event logs and generate state-sync transaction receipt for bor.
+	events, err := api.bridgeReader.Events(ctx, block.Hash(), blockNum)
+	if err != nil {
+		return nil, err
 	}
 
-	// if we've already included the state-sync
-	// receipt from the receipts generator, don't generate and append another one.
-	if chainConfig.Bor != nil && hasBorStateSyncReceipt {
+	if len(events) == 0 {
 		return result, nil
 	}
 
@@ -615,19 +611,12 @@ func (api *APIImpl) GetBlockReceipts(ctx context.Context, numberOrHash rpc.Block
 		}
 	}
 
-	events, err := api.bridgeReader.Events(ctx, block.Hash(), blockNum)
+	borReceipt, err := api.borReceiptGenerator.GenerateBorReceipt(ctx, tx, block, events, chainConfig)
 	if err != nil {
 		return nil, err
 	}
 
-	if len(events) != 0 {
-		borReceipt, err := api.borReceiptGenerator.GenerateBorReceipt(ctx, tx, block, events, chainConfig)
-		if err != nil {
-			return nil, err
-		}
-
-		result = append(result, ethutils.MarshalReceipt(borReceipt, borTx, chainConfig, block.HeaderNoCopy(), borReceipt.TxHash, false, true))
-	}
+	result = append(result, ethutils.MarshalReceipt(borReceipt, borTx, chainConfig, block.HeaderNoCopy(), borReceipt.TxHash, false, true))
 
 	return result, nil
 }

rpc/jsonrpc/receipts/receipts_generator.go

@@ -286,7 +286,8 @@ func (g *Generator) GetReceipt(ctx context.Context, cfg *chain.Config, tx kv.Tem
 	return receipt, nil
 }
 
-// GetReceipts regenerates or loads receipts for a given block (including state-sync synthetic receipt if needed).
+// GetReceipts regenerates or loads receipts for a given block
+// This DOES NOT generate state-sync transaction receipt for bor.
 func (g *Generator) GetReceipts(ctx context.Context, cfg *chain.Config, tx kv.TemporalTx, block *types.Block) (types.Receipts, error) {
 	blockHash := block.Hash()
 
@@ -383,22 +384,6 @@ func (g *Generator) GetReceipts(ctx context.Context, cfg *chain.Config, tx kv.Te
 		}
 	}
 
-	// PIP-74: state-sync receipt handling.
-	if g.borGenerator != nil && cfg.Bor != nil {
-		// Extract state-sync events from block.
-		events, err := g.extractBorEvents(ctx, block)
-		if err != nil {
-			return nil, fmt.Errorf("ReceiptGen.GetReceipts: failed to extract bor events for block %d: %w", block.NumberU64(), err)
-		}
-		if len(events) > 0 {
-			borReceipt, err := g.borGenerator.GenerateBorReceipt(ctx, tx, block, events, cfg)
-			if err != nil {
-				return nil, fmt.Errorf("ReceiptGen.GetReceipts: failed to generate bor receipt for block %d: %w", block.NumberU64(), err)
-			}
-			receipts = append(receipts, borReceipt)
-		}
-	}
-
 	g.addToCacheReceipts(block.HeaderNoCopy(), receipts)
 	return receipts, nil
 }