7935: Add E2StoreReader

util/src/main/java/org/hyperledger/besu/util/e2/E2BeaconState.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/**
+ * Represents a beacon state in an E2 file
+ *
+ * @param beaconState The beacon state
+ * @param slot The slot number
+ */
+public record E2BeaconState(byte[] beaconState, int slot) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2BlockIndex.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+import java.util.List;
+
+/**
+ * Represents a block index in an E2 file
+ *
+ * @param startingSlot The first slot number indexed by this block index
+ * @param indexes The indexes of the blocks indexed by this block index
+ */
+public record E2BlockIndex(long startingSlot, List<Long> indexes) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2ExecutionBlockBody.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/**
+ * Represents an execution block body in an E2 file
+ *
+ * @param block The execution block
+ * @param slot The slot number
+ */
+public record E2ExecutionBlockBody(byte[] block, int slot) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2ExecutionBlockHeader.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/**
+ * Represents an execution block header in an E2 file
+ *
+ * @param header The execution block header
+ * @param slot The slot number
+ */
+public record E2ExecutionBlockHeader(byte[] header, int slot) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2ExecutionBlockReceipts.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/**
+ * Represents an execution block's transaction receipts in an E2 file
+ *
+ * @param receipts The execution block's transaction receipts
+ * @param slot The slot number
+ */
+public record E2ExecutionBlockReceipts(byte[] receipts, int slot) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2SignedBeaconBlock.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/**
+ * Represents a signed beacon block in an E2 file
+ *
+ * @param signedBeaconBlock The signed beacon block
+ * @param slot The slot number
+ */
+public record E2SignedBeaconBlock(byte[] signedBeaconBlock, int slot) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2SlotIndex.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+import java.util.List;
+
+/**
+ * Represents a slot index in an E2 file
+ *
+ * @param startingSlot The first slot number indexed by this slot index
+ * @param indexes The indexes of the slots indexed by this slot index
+ */
+public record E2SlotIndex(long startingSlot, List<Long> indexes) {}

util/src/main/java/org/hyperledger/besu/util/e2/E2StoreReaderListener.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+/** A Listener interface for listening to an E2StoreReader */
+public interface E2StoreReaderListener {
+  /**
+   * Handles the supplied E2BeaconState
+   *
+   * @param beaconState the E2BeaconState
+   */
+  void handleBeaconState(E2BeaconState beaconState);
+
+  /**
+   * Handles the supplied E2SlotIndex
+   *
+   * @param slotIndex the E2SlotIndex
+   */
+  void handleSlotIndex(E2SlotIndex slotIndex);
+
+  /**
+   * Handles the supplied E2SignedBeaconBlock
+   *
+   * @param signedBeaconBlock the E2SignedBeaconBlock
+   */
+  void handleSignedBeaconBlock(E2SignedBeaconBlock signedBeaconBlock);
+
+  /**
+   * Handles the supplied E2ExecutionBlockHeader
+   *
+   * @param executionBlockHeader the E2ExecutionBlockHeader
+   */
+  void handleExecutionBlockHeader(E2ExecutionBlockHeader executionBlockHeader);
+
+  /**
+   * Handles the supplied E2ExecutionBlockBody
+   *
+   * @param executionBlockBody the E2ExecutionBlockBody
+   */
+  void handleExecutionBlockBody(E2ExecutionBlockBody executionBlockBody);
+
+  /**
+   * Handles the supplied E2ExecutionBlockReceipts
+   *
+   * @param executionBlockReceipts the E2ExecutionBlockReceipts
+   */
+  void handleExecutionBlockReceipts(E2ExecutionBlockReceipts executionBlockReceipts);
+
+  /**
+   * Handles the supplied E2BlockIndex
+   *
+   * @param blockIndex the E2BlockIndex
+   */
+  void handleBlockIndex(E2BlockIndex blockIndex);
+}

util/src/main/java/org/hyperledger/besu/util/e2/E2Type.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * 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.util.e2;
+
+import java.util.HexFormat;
+
+/** An enumeration of known sections of e2 store files */
+public enum E2Type {
+  /** An empty section */
+  EMPTY(new byte[] {0x00, 0x00}),
+  /** A snappy compressed, SSZ encoded, signed beacon block */
+  COMPRESSED_SIGNED_BEACON_BLOCK(new byte[] {0x01, 0x00}),
+  /** A snappy compressed, SSZ encoded, beacon state */
+  COMPRESSED_BEACON_STATE(new byte[] {0x02, 0x00}),
+  /** A snappy compressed execution block header */
+  COMPRESSED_EXECUTION_BLOCK_HEADER(new byte[] {0x03, 0x00}),
+  /** A snappy compressed execution block body */
+  COMPRESSED_EXECUTION_BLOCK_BODY(new byte[] {0x04, 0x00}),
+  /** A snappy compressed list of execution block transaction receipts */
+  COMPRESSED_EXECUTION_BLOCK_RECEIPTS(new byte[] {0x05, 0x00}),
+  /** The total difficulty */
+  TOTAL_DIFFICULTY(new byte[] {0x06, 0x00}),
+  /** The accumulator */
+  ACCUMULATOR(new byte[] {0x07, 0x00}),
+  /** A version section */
+  VERSION(new byte[] {0x65, 0x32}),
+  /** An execution block index */
+  BLOCK_INDEX(new byte[] {0x66, 0x32}),
+  /** A slot index */
+  SLOT_INDEX(new byte[] {0x69, 0x32}),
+  ;
+  private final byte[] typeCode;
+
+  E2Type(final byte[] typeCode) {
+    this.typeCode = typeCode;
+  }
+
+  /**
+   * Gets the type code
+   *
+   * @return the type code
+   */
+  public byte[] getTypeCode() {
+    return typeCode;
+  }
+
+  /**
+   * Gets the E2Type corresponding to the supplied typeCode
+   *
+   * @param typeCode the typeCode to find the corresponding E2Type for
+   * @return the E2Type corresponding to the supplied typeCode
+   * @throws IllegalArgumentException if there is no E2Type corresponding to the supplied typeCode
+   */
+  public static E2Type getForTypeCode(final byte[] typeCode) {
+    if (typeCode == null || typeCode.length != 2) {
+      throw new IllegalArgumentException("typeCode must be 2 bytes");
+    }
+
+    E2Type result = null;
+    for (E2Type e2Type : values()) {
+      if (e2Type.typeCode[0] == typeCode[0] && e2Type.typeCode[1] == typeCode[1]) {
+        result = e2Type;
+      }
+    }
+    if (result == null) {
+      throw new IllegalArgumentException(
+          "typeCode " + HexFormat.of().formatHex(typeCode) + " is not recognised");
+    }
+    return result;
+  }
+}