eth/catalyst: add an unit test for updating payload with inclusion list

Author: jihoonsong

eth/catalyst/api_test.go

@@ -1853,24 +1853,39 @@ func TestInclusionList(t *testing.T) {
 	ethservice.TxPool().Add([]*types.Transaction{validTx1}, true)
 
 	for i, tt := range []*struct {
-		name           string
-		inclusionList  engine.InclusionList
-		expectedStatus string
+		name                 string
+		inclusionList        engine.InclusionList
+		updateInclusionList  bool
+		expectedTransactions int
+		expectedStatus       string
 	}{
 		{
-			name:           "Block contains all transactions in the inclusion list",
-			inclusionList:  engine.TransactionsToInclusionList([]*types.Transaction{validTx1}),
-			expectedStatus: engine.VALID,
+			name:                 "Payload misses one transaction in the inclusion list, which could have been included",
+			inclusionList:        engine.TransactionsToInclusionList([]*types.Transaction{validTx1, validTx2}),
+			updateInclusionList:  false,
+			expectedTransactions: 1,
+			expectedStatus:       engine.INVALID_INCLUSION_LIST,
 		},
 		{
-			name:           "Block misses one transaction in the inclusion list, which could have been included",
-			inclusionList:  engine.TransactionsToInclusionList([]*types.Transaction{validTx1, validTx2}),
-			expectedStatus: engine.INVALID_INCLUSION_LIST,
+			name:                 "All transactions in the inclusion list are already included in the payload before update",
+			inclusionList:        engine.TransactionsToInclusionList([]*types.Transaction{validTx1}),
+			updateInclusionList:  true,
+			expectedTransactions: 1,
+			expectedStatus:       engine.VALID,
 		},
 		{
-			name:           "Block misses only invalid transactions in the inclusion list",
-			inclusionList:  engine.TransactionsToInclusionList([]*types.Transaction{validTx1, invalidTx}),
-			expectedStatus: engine.VALID,
+			name:                 "All transactions in the inclusion list that are not included in the payload before update",
+			inclusionList:        engine.TransactionsToInclusionList([]*types.Transaction{validTx2}),
+			updateInclusionList:  true,
+			expectedTransactions: 2, // `validTx1` from the pool and `validTx2` from the inclusion list
+			expectedStatus:       engine.VALID,
+		},
+		{
+			name:                 "Payload includes all valid transactions in the inclusion list",
+			inclusionList:        engine.TransactionsToInclusionList([]*types.Transaction{validTx1, validTx2, invalidTx}),
+			updateInclusionList:  true,
+			expectedTransactions: 2,
+			expectedStatus:       engine.VALID,
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
@@ -1901,14 +1916,22 @@ func TestInclusionList(t *testing.T) {
 			if resp.PayloadStatus.Status != engine.VALID {
 				t.Fatalf("error preparing payload, invalid status=%v", resp.PayloadStatus.Status)
 			}
+			time.Sleep(250 * time.Millisecond)
+
+			if tt.updateInclusionList {
+				// Update the payload with the inclusion list.
+				api.UpdatePayloadWithInclusionListV1(*resp.PayloadID, tt.inclusionList)
+				time.Sleep(250 * time.Millisecond)
+			}
 
 			// Get the payload.
 			if payload, err = api.getPayload(*resp.PayloadID, true); err != nil {
 				t.Fatalf("error getting payload, err=%v", err)
 			}
-			// The payload is expected to have 1 transaction, which is `validTx1`.
-			if len(payload.ExecutionPayload.Transactions) != 1 {
-				t.Fatalf("expected 1 transaction but got %d", len(payload.ExecutionPayload.Transactions))
+
+			// Verify if the block contains all valid transactions in the inclusion list.
+			if len(payload.ExecutionPayload.Transactions) != tt.expectedTransactions {
+				t.Fatalf("expected %d transactions but got %d", tt.expectedTransactions, len(payload.ExecutionPayload.Transactions))
 			}
 
 			// Verify if the block satisfies the inclusion list constraints.