QbftFork.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.config;

import java.util.Arrays;
import java.util.Optional;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.databind.node.ObjectNode;

/** The Qbft fork. */
public class QbftFork extends BftFork {

  /** The enum Validator selection mode. */
  public enum VALIDATOR_SELECTION_MODE {
    /** Blockheader validator selection mode. */
    BLOCKHEADER,
    /** Contract validator selection mode. */
    CONTRACT
  }

  /** The constant VALIDATOR_SELECTION_MODE_KEY. */
  public static final String VALIDATOR_SELECTION_MODE_KEY = "validatorselectionmode";

  /** The constant VALIDATOR_CONTRACT_ADDRESS_KEY. */
  public static final String VALIDATOR_CONTRACT_ADDRESS_KEY = "validatorcontractaddress";

  /**
   * Instantiates a new Qbft fork.
   *
   * @param forkConfigRoot the fork config root
   */
  @JsonCreator
  public QbftFork(final ObjectNode forkConfigRoot) {
    super(forkConfigRoot);
  }

  /**
   * Gets validator selection mode.
   *
   * @return the validator selection mode
   */
  public Optional<VALIDATOR_SELECTION_MODE> getValidatorSelectionMode() {
    final Optional<String> mode = JsonUtil.getString(forkConfigRoot, VALIDATOR_SELECTION_MODE_KEY);
    return mode.flatMap(
        m ->
            Arrays.stream(VALIDATOR_SELECTION_MODE.values())
                .filter(v -> v.name().equalsIgnoreCase(m))
                .findFirst());
  }

  /**
   * Gets validator contract address.
   *
   * @return the validator contract address
   */
  public Optional<String> getValidatorContractAddress() {
    return JsonUtil.getString(forkConfigRoot, VALIDATOR_CONTRACT_ADDRESS_KEY);
  }
}