/*
 * Copyright Hyperledger Besu Contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package org.hyperledger.besu.plugin.services.txselection;

import org.hyperledger.besu.plugin.Unstable;
import org.hyperledger.besu.plugin.data.Log;
import org.hyperledger.besu.plugin.data.Transaction;
import org.hyperledger.besu.plugin.data.TransactionSelectionResult;

import java.util.List;

/** Interface for the transaction selector */
@Unstable
public interface TransactionSelector {

  /**
   * Method called to decide whether a transaction is added to a block. The method can also indicate
   * that no further transactions can be added to the block.
   *
   * @param transaction candidate transaction
   * @param success true, if the transaction executed successfully
   * @param logs the logs created by this transaction
   * @param cumulativeGasUsed gas used by this and all previous transaction in the block
   * @return TransactionSelectionResult that indicates whether to include the transaction
   */
  TransactionSelectionResult selectTransaction(
      final Transaction transaction,
      final boolean success,
      final List<Log> logs,
      final long cumulativeGasUsed);
}
