/*
 * 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.ethereum.worldstate;

import org.hyperledger.besu.plugin.services.storage.DataStorageFormat;

import org.immutables.value.Value;

@Value.Immutable
@Value.Enclosing
public interface DataStorageConfiguration {

  long DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD = 512;
  boolean DEFAULT_RECEIPT_COMPACTION_ENABLED = false;

  DataStorageConfiguration DEFAULT_CONFIG =
      ImmutableDataStorageConfiguration.builder()
          .dataStorageFormat(DataStorageFormat.BONSAI)
          .bonsaiMaxLayersToLoad(DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD)
          .unstable(Unstable.DEFAULT)
          .build();

  DataStorageConfiguration DEFAULT_BONSAI_CONFIG =
      ImmutableDataStorageConfiguration.builder()
          .dataStorageFormat(DataStorageFormat.BONSAI)
          .bonsaiMaxLayersToLoad(DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD)
          .build();

  DataStorageConfiguration DEFAULT_FOREST_CONFIG =
      ImmutableDataStorageConfiguration.builder()
          .dataStorageFormat(DataStorageFormat.FOREST)
          .bonsaiMaxLayersToLoad(DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD)
          .unstable(Unstable.DEFAULT)
          .build();

  DataStorageFormat getDataStorageFormat();

  Long getBonsaiMaxLayersToLoad();

  @Value.Default
  default boolean getReceiptCompactionEnabled() {
    return DEFAULT_RECEIPT_COMPACTION_ENABLED;
  }

  @Value.Default
  default Unstable getUnstable() {
    return Unstable.DEFAULT;
  }

  @Value.Immutable
  interface Unstable {

    boolean DEFAULT_BONSAI_LIMIT_TRIE_LOGS_ENABLED = false;
    long MINIMUM_BONSAI_TRIE_LOG_RETENTION_LIMIT = DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD;
    int DEFAULT_BONSAI_TRIE_LOG_PRUNING_WINDOW_SIZE = 30_000;
    boolean DEFAULT_BONSAI_CODE_USING_CODE_HASH_ENABLED = false;

    DataStorageConfiguration.Unstable DEFAULT =
        ImmutableDataStorageConfiguration.Unstable.builder().build();

    @Value.Default
    default boolean getBonsaiLimitTrieLogsEnabled() {
      return DEFAULT_BONSAI_LIMIT_TRIE_LOGS_ENABLED;
    }

    @Value.Default
    default int getBonsaiTrieLogPruningWindowSize() {
      return DEFAULT_BONSAI_TRIE_LOG_PRUNING_WINDOW_SIZE;
    }

    @Value.Default
    default boolean getBonsaiCodeStoredByCodeHashEnabled() {
      return DEFAULT_BONSAI_CODE_USING_CODE_HASH_ENABLED;
    }
  }
}
