/*
 * 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.plugin.data;

import org.hyperledger.besu.datatypes.Address;
import org.hyperledger.besu.datatypes.Hash;

import java.util.List;

import org.apache.tuweni.bytes.Bytes;
import org.apache.tuweni.bytes.Bytes32;

/** A Log entry from a transaction execution. */
public interface LogWithMetadata {

  /**
   * The address of the contract writing this log message.
   *
   * @return The loggers address.
   */
  Address getLogger();

  /**
   * The list of 32 byte log topics, possibly empty.
   *
   * @return The list, possibly zero length, of log topics.
   */
  List<? extends Bytes32> getTopics();

  /**
   * The data, of possibly unlimited length, for this log entry.
   *
   * @return The log data.
   */
  Bytes getData();

  /**
   * Gets log index.
   *
   * @return the log index
   */
  int getLogIndex();

  /**
   * Gets block number.
   *
   * @return the block number
   */
  long getBlockNumber();

  /**
   * Gets block hash.
   *
   * @return the block hash
   */
  Hash getBlockHash();

  /**
   * Gets transaction hash.
   *
   * @return the transaction hash
   */
  Hash getTransactionHash();

  /**
   * Gets transaction index.
   *
   * @return the transaction index
   */
  int getTransactionIndex();

  /**
   * Is removed.
   *
   * @return the boolean
   */
  boolean isRemoved();
}
