KZG point eval precompile

CHANGELOG.md

@@ -38,6 +38,10 @@ https://hyperledger.jfrog.io/hyperledger/besu-binaries/besu/23.1.0-RC1/besu-23.1
 
 ## 23.1.0-beta
 
+### Additions and Improvements
+- Add access list to Transaction Call Object [#4802](https://github.com/hyperledger/besu/issues/4801)
+- Add new KZG precompile and option to override the trusted setup being used.
+
 ### Breaking Changes
 - GoQuorum-compatible privacy is deprecated and will be removed in 23.4
 - IBFT 1.0 is deprecated and will be removed in 23.4

besu/src/main/java/org/hyperledger/besu/cli/options/unstable/EvmOptions.java

@@ -20,12 +20,14 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 
 import picocli.CommandLine;
 
 public class EvmOptions implements CLIOptions<EvmConfiguration> {
 
   public static final String JUMPDEST_CACHE_WEIGHT = "--Xevm-jumpdest-cache-weight-kb";
+  public static final String KZG_TRUSTED_SETUP_FILE_PATH = "--evm-kzg-trusted-setup-path";
 
   public static EvmOptions create() {
     return new EvmOptions();
@@ -44,9 +46,18 @@ public static EvmOptions create() {
   private Long jumpDestCacheWeightKilobytes =
       32_000L; // 10k contracts, (25k max contract size / 8 bit) + 32byte hash
 
+  @SuppressWarnings({"FieldCanBeFinal", "FieldMayBeFinal"})
+  @CommandLine.Option(
+      names = {KZG_TRUSTED_SETUP_FILE_PATH},
+      description =
+          "absolute file path on the host system which points to the trusted KZG setup file to use",
+      arity = "1")
+  private String kzgTrustedSetupFilePath = null;
+
   @Override
   public EvmConfiguration toDomainObject() {
-    return new EvmConfiguration(jumpDestCacheWeightKilobytes);
+    return new EvmConfiguration(
+        jumpDestCacheWeightKilobytes, Optional.ofNullable(kzgTrustedSetupFilePath));
   }
 
   @Override

besu/src/test/resources/everything_config.toml

@@ -214,3 +214,4 @@ Xp2p-tls-crl-file="none.file"
 
 #contracts
 Xevm-jumpdest-cache-weight-kb=32000
+evm-kzg-trusted-setup-path="/tmp/trusted_setup.txt"

build.gradle

@@ -109,7 +109,7 @@ allprojects {
     }
     maven {
       url 'https://artifacts.consensys.net/public/maven/maven/'
-      content { includeGroupByRegex('tech\\.pegasys\\..*') }
+      content { includeGroupByRegex('tech\\.pegasys.*') }
     }
     maven {
       url 'https://dl.cloudsmith.io/public/consensys/quorum-mainnet-launcher/maven/'

datatypes/src/main/java/org/hyperledger/besu/datatypes/Address.java

@@ -53,6 +53,8 @@ public class Address extends DelegatingBytes implements org.hyperledger.besu.plu
   public static final Address BLS12_MAP_FP_TO_G1 = Address.precompiled(0x11);
   public static final Address BLS12_MAP_FP2_TO_G2 = Address.precompiled(0x12);
 
+  public static final Address KZG_POINT_EVAL = Address.precompiled(0x14);
+
   public static final Address ZERO = Address.fromHexString("0x0");
 
   protected Address(final Bytes bytes) {

ethereum/core/build.gradle

@@ -15,6 +15,10 @@
 
 apply plugin: 'java-library'
 
+repositories {
+  maven { url "https://artifacts.consensys.net/public/maven/maven/" }
+}
+
 jar {
   archiveBaseName = 'besu-core'
   manifest {
@@ -54,6 +58,7 @@ dependencies {
   implementation 'org.apache.tuweni:tuweni-concurrent'
   implementation 'org.apache.tuweni:tuweni-units'
   implementation 'org.apache.tuweni:tuweni-rlp'
+  implementation 'tech.pegasys:jc-kzg-4844:0.1.0'
   implementation 'org.hyperledger.besu:bls12-381'
   implementation 'org.immutables:value-annotations'
 

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetPrecompiledContractRegistries.java

@@ -19,6 +19,7 @@
 import static org.hyperledger.besu.ethereum.core.PrivacyParameters.PLUGIN_PRIVACY;
 import static org.hyperledger.besu.evm.precompile.MainnetPrecompiledContracts.populateForBLS12;
 import static org.hyperledger.besu.evm.precompile.MainnetPrecompiledContracts.populateForByzantium;
+import static org.hyperledger.besu.evm.precompile.MainnetPrecompiledContracts.populateForCancun;
 import static org.hyperledger.besu.evm.precompile.MainnetPrecompiledContracts.populateForFrontier;
 import static org.hyperledger.besu.evm.precompile.MainnetPrecompiledContracts.populateForIstanbul;
 
@@ -60,6 +61,13 @@ public static PrecompileContractRegistry bls12(
     return registry;
   }
 
+  public static PrecompileContractRegistry cancun(
+      final PrecompiledContractConfiguration precompiledContractConfiguration) {
+    final PrecompileContractRegistry registry = new PrecompileContractRegistry();
+    populateForCancun(registry, precompiledContractConfiguration.getGasCalculator());
+    return registry;
+  }
+
   static void appendPrivacy(
       final PrecompileContractRegistry registry,
       final PrecompiledContractConfiguration precompiledContractConfiguration) {

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetProtocolSpecs.java

@@ -724,6 +724,7 @@ static ProtocolSpecBuilder cancunDefinition(
             (gasCalculator, jdCacheConfig) ->
                 MainnetEVMs.cancun(
                     gasCalculator, chainId.orElse(BigInteger.ZERO), evmConfiguration))
+        .precompileContractRegistryBuilder(MainnetPrecompiledContractRegistries::cancun)
         .name("Cancun");
   }
 

ethereum/permissioning/src/test/java/org/hyperledger/besu/ethereum/permissioning/node/provider/SyncStatusNodePermissioningProviderTest.java

@@ -269,7 +269,7 @@ public void syncStatusPermissioningCheckShouldAllowDNS() throws UnknownHostExcep
             .listeningPort(9999)
             .disableDiscovery()
             .ipAddress(
-                InetAddress.getLocalHost().getHostName(),
+                InetAddress.getLocalHost().getCanonicalHostName(),
                 ImmutableEnodeDnsConfiguration.builder()
                     .dnsEnabled(true)
                     .updateEnabled(true)
@@ -283,7 +283,7 @@ public void syncStatusPermissioningCheckShouldAllowDNS() throws UnknownHostExcep
             .listeningPort(9999)
             .disableDiscovery()
             .ipAddress(
-                "127.0.0.1",
+                InetAddress.getLocalHost().getHostAddress(),
                 ImmutableEnodeDnsConfiguration.builder()
                     .dnsEnabled(true)
                     .updateEnabled(true)

evm/build.gradle

@@ -30,6 +30,9 @@ jar {
   }
 }
 
+repositories {
+  maven { url "https://artifacts.consensys.net/public/maven/maven/" }
+}
 dependencies {
   api 'org.slf4j:slf4j-api'
 
@@ -43,9 +46,11 @@ dependencies {
   implementation 'org.apache.tuweni:tuweni-bytes'
   implementation 'org.hyperledger.besu:arithmetic'
   implementation 'org.hyperledger.besu:bls12-381'
+  implementation 'tech.pegasys:jc-kzg-4844:0.1.0'
   implementation 'net.java.dev.jna:jna'
   implementation 'com.github.ben-manes.caffeine:caffeine'
 
+  testImplementation 'com.fasterxml.jackson.core:jackson-databind'
   testImplementation 'info.picocli:picocli'
   testImplementation 'junit:junit'
   testImplementation 'org.assertj:assertj-core'

evm/src/main/java/org/hyperledger/besu/evm/internal/EvmConfiguration.java

@@ -15,19 +15,25 @@
 
 package org.hyperledger.besu.evm.internal;
 
+import java.util.Optional;
+
 public class EvmConfiguration {
-  public static final EvmConfiguration DEFAULT = new EvmConfiguration(32_000L);
+  public static final EvmConfiguration DEFAULT = new EvmConfiguration(32_000L, Optional.empty());
   private final long jumpDestCacheWeightKB;
 
-  public EvmConfiguration(final long jumpDestCacheWeightKB) {
+  private final Optional<String> kzgTrustedSetupPath;
+
+  public EvmConfiguration(
+      final long jumpDestCacheWeightKB, final Optional<String> pathToKZGTrustedSetup) {
     this.jumpDestCacheWeightKB = jumpDestCacheWeightKB;
+    this.kzgTrustedSetupPath = pathToKZGTrustedSetup;
   }
 
   public long getJumpDestCacheWeightBytes() {
     return jumpDestCacheWeightKB * 1024L;
   }
 
-  public long getJumpDestCacheWeightKB() {
-    return jumpDestCacheWeightKB;
+  public Optional<String> getKzgTrustedSetupPath() {
+    return this.kzgTrustedSetupPath;
   }
 }

evm/src/main/java/org/hyperledger/besu/evm/precompile/KZGPointEvalPrecompiledContract.java

@@ -0,0 +1,154 @@
+/*
+ * Copyright Hyperledger Besu Contributors.
+ *
+ * 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.evm.precompile;
+
+import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
+
+import org.hyperledger.besu.evm.frame.ExceptionalHaltReason;
+import org.hyperledger.besu.evm.frame.MessageFrame;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Optional;
+
+import com.google.common.annotations.VisibleForTesting;
+import ethereum.ckzg4844.CKZG4844JNI;
+import org.apache.tuweni.bytes.Bytes;
+import org.jetbrains.annotations.NotNull;
+
+public class KZGPointEvalPrecompiledContract implements PrecompiledContract {
+
+  public KZGPointEvalPrecompiledContract(final Optional<String> pathToTrustedSetup) {
+
+    String pathToSetup;
+    CKZG4844JNI.Preset bitLength;
+    if (pathToTrustedSetup.isPresent()) {
+      pathToSetup = pathToTrustedSetup.get();
+    } else {
+      InputStream is =
+          KZGPointEvalPrecompiledContract.class.getResourceAsStream(
+              "mainnet_kzg_trusted_setup_4096.txt");
+      try {
+        File jniWillLoadFrom = File.createTempFile("kzgTrustedSetup", "txt");
+        Files.copy(is, jniWillLoadFrom.toPath(), REPLACE_EXISTING);
+        is.close();
+        pathToSetup = jniWillLoadFrom.getAbsolutePath();
+      } catch (IOException e) {
+        throw new RuntimeException(e);
+      }
+    }
+    try {
+      BufferedReader setupFile =
+          Files.newBufferedReader(Paths.get(pathToSetup), Charset.defaultCharset());
+      String firstLine = setupFile.readLine();
+      if ("4".equals(firstLine)) {
+        bitLength = CKZG4844JNI.Preset.MINIMAL;
+      } else if ("4096".equals(firstLine)) {
+        bitLength = CKZG4844JNI.Preset.MAINNET;
+      } else {
+        throw new IllegalArgumentException("provided file not a setup for either 4 or 4096 bits");
+      }
+      CKZG4844JNI.loadNativeLibrary(bitLength);
+      try {
+        CKZG4844JNI.loadTrustedSetup(pathToSetup);
+      } catch (RuntimeException alreadyLoaded) {
+        if (alreadyLoaded.getMessage().contains("Trusted Setup is already loaded")) {
+        } else {
+          throw alreadyLoaded;
+        }
+      }
+    } catch (FileNotFoundException e) {
+      throw new RuntimeException(e);
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  @VisibleForTesting
+  public void tearDown() {
+    CKZG4844JNI.freeTrustedSetup();
+  }
+
+  @Override
+  public String getName() {
+    return "KZGPointEval";
+  }
+
+  @Override
+  public long gasRequirement(final Bytes input) {
+    // As defined in EIP-4844
+    return 50000;
+  }
+
+  @NotNull
+  @Override
+  public PrecompileContractResult computePrecompile(
+      final Bytes input, @NotNull final MessageFrame messageFrame) {
+
+    if (input.size() != 192) {
+      return new PrecompileContractResult(
+          Bytes.EMPTY,
+          false,
+          MessageFrame.State.COMPLETED_FAILED,
+          Optional.of(ExceptionalHaltReason.PRECOMPILE_ERROR));
+    }
+    // Bytes versionedHash = input.slice(0, 32);
+    Bytes z = input.slice(32, 32);
+    Bytes y = input.slice(64, 32);
+    Bytes commitment = input.slice(96, 48);
+    Bytes proof = input.slice(144, 48);
+
+    Bytes output = Bytes.EMPTY;
+    PrecompileContractResult result;
+    try {
+      boolean proved =
+          CKZG4844JNI.verifyKzgProof(
+              commitment.toArray(), z.toArray(), y.toArray(), proof.toArray());
+
+      // # Return FIELD_ELEMENTS_PER_BLOB and BLS_MODULUS as padded 32 byte big endian values
+      //    return Bytes(U256(FIELD_ELEMENTS_PER_BLOB).to_be_bytes32() +
+      // U256(BLS_MODULUS).to_be_bytes32())
+
+      if (proved) {
+        result =
+            new PrecompileContractResult(
+                output, false, MessageFrame.State.COMPLETED_SUCCESS, Optional.empty());
+      } else {
+        result =
+            new PrecompileContractResult(
+                output,
+                false,
+                MessageFrame.State.COMPLETED_FAILED,
+                Optional.of(ExceptionalHaltReason.PRECOMPILE_ERROR));
+      }
+      return result;
+    } catch (RuntimeException kzgFailed) {
+      System.out.println(kzgFailed.getMessage());
+      result =
+          new PrecompileContractResult(
+              output,
+              false,
+              MessageFrame.State.COMPLETED_FAILED,
+              Optional.of(ExceptionalHaltReason.PRECOMPILE_ERROR));
+    }
+    return result;
+  }
+}

evm/src/main/java/org/hyperledger/besu/evm/precompile/MainnetPrecompiledContracts.java

@@ -1,5 +1,5 @@
 /*
- * Copyright ConsenSys AG.
+ * Copyright Hyperledger Besu Contributors.
  *
  * 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
@@ -17,6 +17,8 @@
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.evm.gascalculator.GasCalculator;
 
+import java.util.Optional;
+
 /** Provides the various precompiled contracts used on mainnet hard forks. */
 public abstract class MainnetPrecompiledContracts {
 
@@ -86,4 +88,11 @@ public static void populateForBLS12(
     registry.put(Address.BLS12_MAP_FP_TO_G1, new BLS12MapFpToG1PrecompiledContract());
     registry.put(Address.BLS12_MAP_FP2_TO_G2, new BLS12MapFp2ToG2PrecompiledContract());
   }
+
+  public static void populateForCancun(
+      final PrecompileContractRegistry registry, final GasCalculator gasCalculator) {
+    populateForIstanbul(registry, gasCalculator);
+    // TODO: allow override to be configured?
+    registry.put(Address.KZG_POINT_EVAL, new KZGPointEvalPrecompiledContract(Optional.empty()));
+  }
 }