diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..16ed03c --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,36 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow +# execution time. For more information see: +# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle + +name: CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Set up Java + uses: actions/setup-java@v4 + with: + java-version: '21' + distribution: 'temurin' + + # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies. + # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md + - name: Setup Gradle + uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2 + + - name: Build + run: ./gradlew clean build diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 0000000..78b4f8c --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,24 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +# This workflow scans pull requests for dependency changes, and will raise an error if any vulnerabilities or +# invalid licenses are being introduced. +# See https://github.com/actions/dependency-review-action + +name: dependency-review + +on: + pull_request: + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Dependency Review' + uses: actions/dependency-review-action@0c155c5e8556a497adf53f2c18edabf945ed8e70 #4.3.2 + with: + retry-on-snapshot-warnings: true + retry-on-snapshot-warnings-timeout: 600 \ No newline at end of file diff --git a/.github/workflows/download-dependency-graph.yml b/.github/workflows/download-dependency-graph.yml new file mode 100644 index 0000000..d45b060 --- /dev/null +++ b/.github/workflows/download-dependency-graph.yml @@ -0,0 +1,24 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +# This workflow downloads the saved dependency graph and submits it to GitHub, enabling Dependabot Alerts for all +# project dependencies. See upload-dependency-graph.yml which will run before this workflow. +name: download-submit-dependency-graph + +on: + workflow_run: + workflows: ['upload-dependency-graph'] + types: [completed] + +permissions: + contents: write + +jobs: + submit-dependency-graph: + runs-on: ubuntu-latest + steps: + # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies. + - name: Download and submit dependency graph + uses: gradle/actions/dependency-submission@d211a39090cba0cdce485f2a0b1f28f39ccda0c9 # v3.3.2 + with: + dependency-graph: download-and-submit # Download saved dependency-graph and submit \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..3238648 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,55 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +# This workflow will perform release of this project when a tag is pushed. + +name: release + +on: + push: + tags: [ "v*" ] + +jobs: + release: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - run: git fetch --tags --force origin #workaround https://github.com/actions/checkout/issues/882 + - name: Set up Java + uses: actions/setup-java@v4 + with: + java-version: '21' + distribution: 'temurin' + + # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies. + # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md + - name: Setup Gradle + uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2 + + - name: Clean + run: ./gradlew clean printVersion + + - name: Assemble + run: ./gradlew assemble + + - name: Release + run: ./gradlew jreleaserFullRelease + env: + JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + JRELEASER_GITHUB_USERNAME: ${{ github.actor }} + JRELEASER_GITHUB_EMAIL: ${{ github.actor }}@users.noreply.github.com + + # Persist jreleaser logs + - name: JReleaser logs + if: always() + uses: actions/upload-artifact@v4 + with: + name: jreleaser-release + path: | + build/jreleaser/trace.log + build/jreleaser/output.properties \ No newline at end of file diff --git a/.github/workflows/upload-dependency-graph.yml b/.github/workflows/upload-dependency-graph.yml new file mode 100644 index 0000000..e1428e8 --- /dev/null +++ b/.github/workflows/upload-dependency-graph.yml @@ -0,0 +1,27 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +name: upload-dependency-graph + +on: + pull_request: + +# 'write' permission is not available on pull-request events. +# See download-dependency-graph.yml which will run after this workflow. +permissions: + contents: read + +jobs: + dependency-submission: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 21 + # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies. + - name: Generate and save dependency graph + uses: gradle/actions/dependency-submission@d211a39090cba0cdce485f2a0b1f28f39ccda0c9 # v3.3.2 + with: + dependency-graph: generate-and-upload \ No newline at end of file diff --git a/.github/workflows/wrapper-validation.yml b/.github/workflows/wrapper-validation.yml new file mode 100644 index 0000000..bad4771 --- /dev/null +++ b/.github/workflows/wrapper-validation.yml @@ -0,0 +1,16 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +name: "Validate Gradle Wrapper" + +on: [push, pull_request] + +jobs: + validation: + name: "Validation" + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - uses: actions/checkout@v4 + - uses: gradle/actions/wrapper-validation@d211a39090cba0cdce485f2a0b1f28f39ccda0c9 \ No newline at end of file diff --git a/.gitignore b/.gitignore index a5b1113..597428f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + .gradle **/build/ !src/**/build/ @@ -19,3 +22,9 @@ gradle-app.setting .project # JDT-specific (Eclipse Java Development Tools) .classpath + +# IntelliJ IDEA +.idea/ + +# Mac +.DS_Store diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..70a86d8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contribution guidelines + +Thank you for considering contributing to Consensys finalization-updater-besu-plugin. + +If your contribution is not straightforward, please first discuss the change you +wish to make by creating a new issue before making the change. + +## Reporting issues + +Before reporting an issue on the +[issue tracker](https://github.com/Consensys/finalization-updater-besu-plugin/issues), +please check that it has not already been reported by searching for some related +keywords. + +## Pull requests + +Try to do one pull request per change. + +### Commit Messages + +When creating pull request or squash commit message, please follow +[conventional commits specifications](https://www.conventionalcommits.org/en/v1.0.0/). + + +## Developing + +### Set up + +This is a standard gradle based Java project. You can import the project in your favorite IDE. + +```shell +git clone https://github.com/Consensys/finalization-updater-besu-plugin.git +cd finalization-updater-besu-plugin +./gradlew clean build +``` + +--- +`SPDX-License-Identifier: Apache-2.0` + + diff --git a/README.md b/README.md index f1c7181..d769c4c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ -# finalization_updater_besu_plugin -A Linea-Besu plugin that update finalized block +# Finalization Updater Besu Plugin + +A [Besu plugin][1] that provides an RPC method to record and update the finalized block that can be utilized by L2. + +![GitHub Actions Workflow Status](https://github.com/Consensys/finalization-updater-besu-plugin/actions/workflows/ci.yml/badge.svg?branch=main) + +## Build Instructions +You can either use pre-built jar from Assets section in [releases][2] or build it yourself. + +> [!NOTE] +> This project requires Java 21 or later. If it is not available, the gradle build will attempt to download one and use it. + +- Checkout the project: +```shell +git clone https://github.com/Consensys/finalization-updater-besu-plugin.git +``` + +- Check [Besu releases][3] for latest stable version and update it in [`gradle/libs.versions.toml`](gradle/libs.versions.toml). For example: + +```toml +[versions] +besu = "24.6.0" +``` + +- Build the plugin: + +```shell +./gradlew clean build +``` + +The plugin jar will be available at `build/libs/finalization-updater-besu-plugin-.jar`. + +## Usage + +Drop the `finalization-updater-besu-plugin-.jar` in the `/plugins` folder under Besu installation. This plugin +will expose following RPC methods: +```shell +linea_updateFinalizedBlockV1(finalizedBlockNumber: Long): Boolean +``` + +## License +`SPDX-License-Identifier: Apache-2.0` +- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE) or ) + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as +defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions. + +See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. + +[1]: +[2]: +[3]: \ No newline at end of file diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..d327013 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,11 @@ +# Project release process + +This project can be released by creating and pushing an annotated tag to the repository. +The tag should be named `vX.Y.Z` where `X.Y.Z` is the version number of the release. + +```shell +git tag -a v1.0.0 -m "Release v1.0.0" +git push origin v1.0.0 +``` +--- +`SPDX-License-Identifier: Apache-2.0` \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..3c3d8a5 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,129 @@ +// Copyright 2024, Consensys Software Inc. +// SPDX-License-Identifier: Apache-2.0 +import org.jreleaser.model.Active +import org.jreleaser.model.Distribution +import org.jreleaser.model.UpdateSection + +plugins { + `java-library` + alias(libs.plugins.spotless) + alias(libs.plugins.jgitver) + alias(libs.plugins.jreleaser) + alias(libs.plugins.gradle.errorprone.plugin) +} + +project.group = "net.consensys.linea.besu.plugin" + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() + + // For Besu plugin dependencies + maven { + url = uri("https://hyperledger.jfrog.io/artifactory/besu-maven/") + content { includeGroupByRegex("org\\.hyperledger\\.besu($|\\..*)") } + } +} + +dependencies { + // This project jar is not supposed to be used as compilation dependency. + // `api` is used here to distinguish between dependencies which should be used IF it is to be used + // as a dependency during compiling some other library that depends on this project. + api(libs.besu.plugin.api) + + // https://github.com/google/auto/tree/main/service + annotationProcessor(libs.google.auto.service) + implementation(libs.google.auto.service.annotations) + implementation(libs.slf4j.api) + implementation(libs.picocli) + + // testing dependencies + testImplementation(libs.assertj.core) + testImplementation(libs.junit.jupiter) + testRuntimeOnly("org.junit.platform:junit-platform-launcher") + testRuntimeOnly(libs.slf4j.simple) + + // errorprone dependencies + errorprone(libs.google.error.prone) +} + +// Apply a specific Java toolchain to ease working on different environments. +java { toolchain { languageVersion = JavaLanguageVersion.of(21) } } + +tasks.named("test") { + // Use JUnit Platform for unit tests. + useJUnitPlatform() +} + +spotless { + java { + importOrder() + removeUnusedImports() + googleJavaFormat() + licenseHeaderFile(layout.projectDirectory.file("gradle/spotless/java.license.template")) + } + + kotlinGradle { ktfmt() } +} + +// auto-generate project version (semver) based on tags +jgitver { nonQualifierBranches = "main" } + +tasks.register("printVersion") { + group = "Help" + description = "Prints the project version" + doLast { println("Version: ${project.version}") } +} + +tasks.jar { + manifest { + attributes( + mapOf("Implementation-Title" to project.name, "Implementation-Version" to project.version)) + } +} + +jreleaser { + project { + description.set("Finalization Updater Besu Plugin") + authors.set(listOf("Consensys Protocols Team")) + license.set("Apache-2.0") + inceptionYear.set("2024") + copyright.set("2024, Consensys Software Inc.") + links { + homepage.set("https://github.com/Consensys/finalization-updater-besu-plugin") + documentation.set("https://github.com/Consensys/finalization-updater-besu-plugin") + } + } + dependsOnAssemble.set(true) + gitRootSearch.set(true) + distributions { + create("finalization-updater-besu-plugin") { + distributionType.set(Distribution.DistributionType.SINGLE_JAR) + artifact { + path.set(layout.buildDirectory.file("libs/{{distributionName}}-{{projectVersion}}.jar")) + } + } + } + + release { + github { + repoOwner = "consensys" + // append artifacts to an existing release with matching tag + update { + enabled = true + sections.set(listOf(UpdateSection.ASSETS, UpdateSection.TITLE, UpdateSection.BODY)) + } + // We need to create tag manually because our project version is calculated based on tags. + skipTag = true + changelog { + formatted.set(Active.ALWAYS) + preset.set("conventional-commits") + contributors { + enabled.set(true) + format.set( + "- {{contributorName}}{{#contributorUsernameAsLink}} ({{.}}){{/contributorUsernameAsLink}}") + } + } + } + } +} diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..da14e78 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,34 @@ +# Copyright 2024, Consensys Software Inc. +# SPDX-License-Identifier: Apache-2.0 + +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +assertj = "3.26.3" +besu = "24.6.0" +google-auto-service = "1.1.1" +google-error-prone = "2.29.2" +gradle-errorprone-plugin = "4.0.1" +jgitver = "0.10.0-rc03" +jreleaser = "1.13.1" +junit-jupiter = "5.10.2" +picocli = "4.7.5" # same version as in Besu +slf4j = "2.0.13" +spotless = "6.25.0" + +[libraries] +assertj-core = { module = "org.assertj:assertj-core", version.ref = "assertj" } +besu-plugin-api = {module = "org.hyperledger.besu:plugin-api", version.ref = "besu"} +google-auto-service = { module = "com.google.auto.service:auto-service", version.ref = "google-auto-service" } +google-auto-service-annotations = { module = "com.google.auto.service:auto-service-annotations", version.ref = "google-auto-service" } +google-error-prone = { module = "com.google.errorprone:error_prone_core", version.ref = "google-error-prone" } +junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" } +picocli = {module = "info.picocli:picocli", version.ref = "picocli"} +slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" } +slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j" } + +[plugins] +jgitver = { id = "fr.brouillard.oss.gradle.jgitver", version.ref = "jgitver" } +jreleaser = { id = "org.jreleaser", version.ref = "jreleaser"} +spotless = { id = "com.diffplug.spotless", version.ref = "spotless" } +gradle-errorprone-plugin = { id = "net.ltgt.errorprone", version.ref = "gradle-errorprone-plugin" } \ No newline at end of file diff --git a/gradle/spotless/java.license.template b/gradle/spotless/java.license.template new file mode 100644 index 0000000..2d0beb1 --- /dev/null +++ b/gradle/spotless/java.license.template @@ -0,0 +1,2 @@ +// Copyright $YEAR, Consensys Software Inc. +// SPDX-License-Identifier: Apache-2.0 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e644113 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..09523c0 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..b740cf1 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..7101f8e --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..e0391b3 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,8 @@ +// Copyright 2024, Consensys Software Inc. +// SPDX-License-Identifier: Apache-2.0 +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} + +rootProject.name = "finalization-updater-besu-plugin" diff --git a/src/main/java/net/consensys/linea/FinalizationUpdaterPlugin.java b/src/main/java/net/consensys/linea/FinalizationUpdaterPlugin.java new file mode 100644 index 0000000..a1087db --- /dev/null +++ b/src/main/java/net/consensys/linea/FinalizationUpdaterPlugin.java @@ -0,0 +1,33 @@ +// Copyright 2024, Consensys Software Inc. +// SPDX-License-Identifier: Apache-2.0 +package net.consensys.linea; + +import com.google.auto.service.AutoService; +import org.hyperledger.besu.plugin.BesuContext; +import org.hyperledger.besu.plugin.BesuPlugin; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A Besu plugin that provides an RPC method to record and update the finalized block that can be + * utilized by L2. + */ +@AutoService(BesuPlugin.class) +public class FinalizationUpdaterPlugin implements BesuPlugin { + private static final Logger LOG = LoggerFactory.getLogger(FinalizationUpdaterPlugin.class); + + @Override + public void register(final BesuContext besuContext) { + LOG.trace("Registering plugin ..."); + } + + @Override + public void start() { + LOG.trace("Starting plugin ..."); + } + + @Override + public void stop() { + LOG.trace("Stopping plugin ..."); + } +} diff --git a/src/test/java/net/consensys/linea/FinalizationUpdaterPluginTest.java b/src/test/java/net/consensys/linea/FinalizationUpdaterPluginTest.java new file mode 100644 index 0000000..988161c --- /dev/null +++ b/src/test/java/net/consensys/linea/FinalizationUpdaterPluginTest.java @@ -0,0 +1,15 @@ +// Copyright 2024, Consensys Software Inc. +// SPDX-License-Identifier: Apache-2.0 +package net.consensys.linea; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.Test; + +public class FinalizationUpdaterPluginTest { + @Test + void getVersionIsValid() { + FinalizationUpdaterPlugin plugin = new FinalizationUpdaterPlugin(); + assertThat(plugin.getVersion()).startsWith("FinalizationUpdaterPlugin"); + } +}