/*
 * Copyright Consensys Software Inc., 2022
 *
 * 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.
 */

package tech.pegasys.teku.statetransition.block;

import com.google.common.annotations.VisibleForTesting;
import java.util.Optional;
import tech.pegasys.teku.infrastructure.async.SafeFuture;
import tech.pegasys.teku.infrastructure.events.ChannelInterface;
import tech.pegasys.teku.spec.datastructures.blocks.SignedBeaconBlock;
import tech.pegasys.teku.spec.datastructures.validator.BroadcastValidationLevel;
import tech.pegasys.teku.spec.logic.common.statetransition.results.BlockImportResult;
import tech.pegasys.teku.statetransition.blobs.BlobSidecarManager.RemoteOrigin;
import tech.pegasys.teku.statetransition.validation.BlockBroadcastValidator.BroadcastValidationResult;

public interface BlockImportChannel extends ChannelInterface {

  SafeFuture<BlockImportAndBroadcastValidationResults> importBlock(
      SignedBeaconBlock block,
      BroadcastValidationLevel broadcastValidationLevel,
      Optional<RemoteOrigin> origin);

  default SafeFuture<BlockImportAndBroadcastValidationResults> importBlock(
      final SignedBeaconBlock block) {
    return importBlock(block, BroadcastValidationLevel.NOT_REQUIRED, Optional.empty());
  }

  default SafeFuture<BlockImportAndBroadcastValidationResults> importBlock(
      final SignedBeaconBlock block, final RemoteOrigin origin) {
    return importBlock(block, BroadcastValidationLevel.NOT_REQUIRED, Optional.of(origin));
  }

  default SafeFuture<BlockImportAndBroadcastValidationResults> importBlock(
      final SignedBeaconBlock block, final BroadcastValidationLevel broadcastValidationLevel) {
    return importBlock(block, broadcastValidationLevel, Optional.of(RemoteOrigin.LOCAL_PROPOSAL));
  }

  record BlockImportAndBroadcastValidationResults(
      SafeFuture<BlockImportResult> blockImportResult,
      SafeFuture<BroadcastValidationResult> broadcastValidationResult) {

    /** only used in tests */
    @VisibleForTesting
    public BlockImportAndBroadcastValidationResults(
        final SafeFuture<BlockImportResult> blockImportResult) {
      this(blockImportResult, SafeFuture.completedFuture(BroadcastValidationResult.SUCCESS));
    }
  }
}
