CliqueMiningCoordinator.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.consensus.clique.blockcreation;

import org.hyperledger.besu.consensus.clique.CliqueMiningTracker;
import org.hyperledger.besu.ethereum.blockcreation.AbstractMiningCoordinator;
import org.hyperledger.besu.ethereum.chain.Blockchain;
import org.hyperledger.besu.ethereum.core.BlockHeader;
import org.hyperledger.besu.ethereum.eth.sync.state.SyncState;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** The type Clique mining coordinator. */
public class CliqueMiningCoordinator extends AbstractMiningCoordinator<CliqueBlockMiner> {

  private static final Logger LOG = LoggerFactory.getLogger(CliqueMiningCoordinator.class);

  private final CliqueMiningTracker miningTracker;

  /**
   * Instantiates a new Clique mining coordinator.
   *
   * @param blockchain the blockchain
   * @param executor the executor
   * @param syncState the sync state
   * @param miningTracker the mining tracker
   */
  public CliqueMiningCoordinator(
      final Blockchain blockchain,
      final CliqueMinerExecutor executor,
      final SyncState syncState,
      final CliqueMiningTracker miningTracker) {
    super(blockchain, executor, syncState);
    this.miningTracker = miningTracker;
  }

  @Override
  public void onResumeMining() {
    if (isSigner()) {
      LOG.info("Resuming block production operations");
    }
  }

  @Override
  public void onPauseMining() {
    if (isSigner()) {
      LOG.info("Pausing block production while behind chain head");
    }
  }

  /**
   * Is signer.
   *
   * @return the boolean
   */
  public boolean isSigner() {
    return miningTracker.isSigner(blockchain.getChainHeadHeader());
  }

  @Override
  protected boolean newChainHeadInvalidatesMiningOperation(final BlockHeader newChainHeadHeader) {
    if (currentRunningMiner.isEmpty()) {
      return true;
    }

    if (miningTracker.blockCreatedLocally(newChainHeadHeader)) {
      return true;
    }

    return networkBlockBetterThanCurrentMiner(newChainHeadHeader);
  }

  private boolean networkBlockBetterThanCurrentMiner(final BlockHeader newChainHeadHeader) {
    final BlockHeader parentHeader = currentRunningMiner.get().getParentHeader();
    final long currentMinerTargetHeight = parentHeader.getNumber() + 1;
    if (currentMinerTargetHeight < newChainHeadHeader.getNumber()) {
      return true;
    }

    final boolean nodeIsMining = miningTracker.canMakeBlockNextRound(parentHeader);
    final boolean nodeIsInTurn = miningTracker.isProposerAfter(parentHeader);

    return !nodeIsMining || !nodeIsInTurn;
  }
}