Publish localnode to the mavencentral

.github/workflows/tests.yml

@@ -16,10 +16,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache Gradle dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.gradle/caches
           key: gradle-deps-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
@@ -38,5 +38,7 @@ jobs:
           ./gradlew clean build --no-daemon
 
       - name: Run Tests
+        env:
+          TEST_CONCURRENCY: 4
         run: |
-          ./gradlew test --no-daemon                    
+          ./gradlew test --no-daemon --info                    

.gitignore

@@ -29,3 +29,5 @@ hs_err_pid*
 *.ipr
 *.iws
 /out/
+
+/local.properties

README.md

@@ -1,14 +1,15 @@
-# 🍴 PokeFork: Seamless integration of Hardhat and Foundry Anvil with your Java/Kotlin app
+# 🍴 LocalNode: get Hardhat and Foundry Anvil integrated in your Java/Kotlin app
 
-![build status](https://github.com/ruXlab/pokefork/actions/workflows/tests.yml/badge.svg)
+[![build status](https://github.com/ruXlab/localnode/actions/workflows/tests.yml/badge.svg)](https://github.com/ruXlab/localnode/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Maven Central](https://img.shields.io/maven-central/v/vc.rux.pokefork/ktx-module.svg)](https://search.maven.org/artifact/vc.rux.localnode/localnode)
 
 
+LocalNode allows to run a local development or forked node of the Ethereum-like network
+using **Hardhat or Foundry Anvil** and interact with it from your Java/Kotlin/Scala code. 
+Thanks to docker there won't be a port conflict and you can run multiple nodes at the same time. 
 
-PokeFork is an open-source library project designed to empower
-developers working with Ethereum Virtual Machine (EVM) based networks.
-It allows to run a local development or forked node of the Ethereum-like network 
-using **Hardhat or Foundry Anvil** and interact with it from your Java/Kotlin/Scala code.
+Developer gets full control over the management of the local node via the extended (see the table below) web3j interface.
 
 ## Motivation
 
@@ -72,15 +73,14 @@ Seriously, Java devs deserve it.
 
 ## Getting Started
 
-Clone and build the PokeFork project:
+Add dependency to your project:
 
-```bash
-git clone 
-cd pokefork
-./gradlew test build
+```kotlin
+implementation("vc.rux.localnodee:web3j:0.1.0")
+implementation("org.web3j:core:4.10.3")
 ```
 
-TBD
+And off you go! Check [examples](examples) folder to get idea how to use this library.
 
 ## Contributing
 
@@ -98,10 +98,6 @@ EVM network interactions.
 Seriously, it's clear that number of bad actors in blockchain
 space is crazy. Trust no one.
 
-## Punning Around
-
-We couldn't resist the opportunity for some wordplay with "PokeFork."
-Just like a fork in the road, we're here to help you choose the
-path that leads to success in EVM network development.
+------------------------
 
 Happy forking!

build.gradle.kts

@@ -1,7 +1,7 @@
 plugins {
-    kotlin("jvm") version "1.9.0" apply false
-    application
+    kotlin("jvm") version "1.9.20" apply false
+    id("publication")
 }
 
-group = "vc.rux.pokefork"
+group = "vc.rux.localnode"
 version = "0.0-SNAPSHOT"

examples/README.md

@@ -0,0 +1,5 @@
+Examples for the pokefork
+===========================
+
+
+You'll find here some examples of how to use the pokefork. They're self-contained, therefore they can be run directly from the IDE.

examples/build.gradle.kts

@@ -0,0 +1,26 @@
+plugins {
+    kotlin("jvm")
+}
+
+group = "vc.rux.localnode.examples"
+version = "0.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+//    maven(url = "https://s01.oss.sonatype.org/content/repositories/releases/") // optional for releases
+//    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") // optional for snapshots
+//    maven(url = "https://s01.oss.sonatype.org/content/groups/staging/") // optional for staging
+}
+
+dependencies {
+    implementation("vc.rux.localnode:localnode:0.1.0")
+    implementation("org.web3j:core:4.10.3")
+}
+
+
+kotlin {
+
+}
+
+
+

examples/src/main/kotlin/QueryBalanceApp.kt

@@ -0,0 +1,30 @@
+import misc.addresses
+import misc.archiveNodeUrl
+import org.web3j.protocol.core.DefaultBlockParameter
+import org.web3j.utils.Convert.Unit
+import org.web3j.utils.Convert.fromWei
+import vc.rux.localnode.anvil.AnvilNode
+import vc.rux.localnode.anvil.AnvilNodeConfig
+import vc.rux.localnode.web3j.LocalWeb3jNode
+
+object QueryBalanceApp {
+    @JvmStatic
+    fun main(vararg args: String) {
+        // Start the forked local node
+        val pokefork = AnvilNode.start(AnvilNodeConfig.fork(archiveNodeUrl, chainId = 1))
+        val web3j = LocalWeb3jNode.from(pokefork)
+
+        println("Checking the amount of ETH locked in Arbitrum Native bridge (portal) at ${addresses.arbitrumEthBridge}")
+        println()
+        println("block number\t | balance")
+        // Check the balances
+        for (block in 15500000..18600000 step 300000) {
+            val balance = web3j.ethGetBalance(
+                addresses.arbitrumEthBridge, DefaultBlockParameter.valueOf(block.toBigInteger())
+            ).send().balance
+
+            println("$block \t\t | ${fromWei(balance.toString(), Unit.ETHER)} ETH")
+        }
+    }
+
+}

examples/src/main/kotlin/misc/constants.kt

@@ -0,0 +1,10 @@
+package misc
+
+val archiveNodeUrl by lazy {
+    System.getenv("ARCHIVE_NODE_URL_ETHEREUM") ?: "https://rpc.ankr.com/eth"
+}
+
+object addresses {
+    const val optimismPortal = "0xbEb5Fc579115071764c7423A4f12eDde41f106Ed"
+    const val arbitrumEthBridge = "0x8315177ab297ba92a06054ce80a67ed4dbd7ed3a"
+}

gradle.properties

@@ -1 +1,10 @@
 kotlin.code.style=official
+
+
+artifactName=localnode
+artifactDesc=Run local node or fork Ethereum-like blockchains from your Kotlin/Java app using Hardhat or Foundry Anvil
+artifactUrl=https://github.com/ruXlab/localnode
+artifactScm=git@github.com:ruXlab/localnode.git
+artifactLicenseName=MIT License
+artifactLicenseUrl=http://www.opensource.org/licenses/mit-license.php
+artifactPublishVersion=0.1.0

localnode/README.md

@@ -0,0 +1,6 @@
+LocalNode library module
+=========
+
+This is a library module, please refer to the 
+[parent README](../README.md) to learn more about 
+the project and how to use it.

core/build.gradle.kts → localnode/build.gradle.kts

@@ -2,9 +2,12 @@ import org.gradle.api.tasks.testing.logging.TestLogEvent
 
 plugins {
     kotlin("jvm")
+    id("publication")
+    `maven-publish`
+    signing
 }
 
-group = "vc.rux.pokefork.core"
+group = "vc.rux.localnode"
 version = "0.0-SNAPSHOT"
 
 repositories {
@@ -15,13 +18,21 @@ dependencies {
     implementation(libs.dockerjava)
     implementation(libs.bundles.logging)
 
+    implementation(libs.web3j)
+
     testImplementation(kotlin("test"))
     testImplementation(platform(testlibs.junit.bom))
     testImplementation(testlibs.junit.api)
     testImplementation(testlibs.junit.params)
     testRuntimeOnly(testlibs.junit.engine)
     testImplementation(testlibs.assertk)
+    testImplementation(libs.web3j.contracts)
+}
 
+
+java {
+    withJavadocJar()
+    withSourcesJar()
 }
 
 
@@ -32,4 +43,7 @@ tasks.test {
             TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED
         )
     }
+    System.getenv("TEST_CONCURRENCY")?.toIntOrNull()?.let {
+        maxParallelForks = it
+    }
 }

core/src/main/kotlin/vc/rux/pokefork/IForkNode.kt → localnode/src/main/kotlin/vc/rux/localnode/IForkNode.kt

@@ -1,6 +1,4 @@
-package vc.rux.pokefork
-
-import vc.rux.pokefork.ILocalNode
+package vc.rux.localnode
 
 interface IForkNode : ILocalNode {
     fun forkBlock(blockNumber: Long) 

core/src/main/kotlin/vc/rux/pokefork/ILocalNode.kt → localnode/src/main/kotlin/vc/rux/localnode/ILocalNode.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork
+package vc.rux.localnode
 
 import java.math.BigInteger
 

core/src/main/kotlin/vc/rux/pokefork/NodeMode.kt → localnode/src/main/kotlin/vc/rux/localnode/NodeMode.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork
+package vc.rux.localnode
 
 /**
  * NodeMode is a sealed interface with two implementations:

core/src/main/kotlin/vc/rux/pokefork/anvil/AnvilNode.kt → localnode/src/main/kotlin/vc/rux/localnode/anvil/AnvilNode.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork.anvil
+package vc.rux.localnode.anvil
 
 import com.github.dockerjava.api.DockerClient
 import com.github.dockerjava.api.command.CreateContainerResponse
@@ -7,12 +7,12 @@ import com.github.dockerjava.api.model.ExposedPort
 import com.github.dockerjava.api.model.HostConfig
 import com.github.dockerjava.api.model.PullResponseItem
 import org.slf4j.LoggerFactory
-import vc.rux.pokefork.NodeMode
-import vc.rux.pokefork.common.idPrefix
-import vc.rux.pokefork.common.waitForRpcToBoot
-import vc.rux.pokefork.defaultDockerClient
-import vc.rux.pokefork.hardhat.HardhatNode
-import vc.rux.pokefork.hardhat.IEthereumLikeNode
+import vc.rux.localnode.NodeMode
+import vc.rux.localnode.common.idPrefix
+import vc.rux.localnode.common.waitForRpcToBoot
+import vc.rux.localnode.defaultDockerClient
+import vc.rux.localnode.hardhat.HardhatNode
+import vc.rux.localnode.hardhat.IEthereumLikeNode
 import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.Duration.Companion.seconds
 

core/src/main/kotlin/vc/rux/pokefork/anvil/AnvilNodeConfig.kt → localnode/src/main/kotlin/vc/rux/localnode/anvil/AnvilNodeConfig.kt

@@ -1,11 +1,11 @@
-package vc.rux.pokefork.anvil
+package vc.rux.localnode.anvil
 
-import vc.rux.pokefork.NodeMode
+import vc.rux.localnode.NodeMode
 
 data class AnvilNodeConfig(
     val nodeMode: NodeMode,
     val blockNumber: Long? = null,
-    val imageName: String = "pokefork",
+    val imageName: String = "localnode",
     val imageTag: String? = null,
     val foundryImage: String = "ghcr.io/foundry-rs/foundry:latest"
 ) {

core/src/main/kotlin/vc/rux/pokefork/anvil/internal/AnvilDockerfile.kt → localnode/src/main/kotlin/vc/rux/localnode/anvil/internal/AnvilDockerfile.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork.anvil.internal
+package vc.rux.localnode.anvil.internal
 
 internal data class AnvilDockerfile(
     val commandLineParams: List<String>,

core/src/main/kotlin/vc/rux/pokefork/common/common-node-utils.kt → localnode/src/main/kotlin/vc/rux/localnode/common/common-node-utils.kt

@@ -1,6 +1,6 @@
-package vc.rux.pokefork.common
+package vc.rux.localnode.common
 
-import vc.rux.pokefork.NodeMode
+import vc.rux.localnode.NodeMode
 
 internal val NodeMode.idPrefix
     get() = when (this) {

core/src/main/kotlin/vc/rux/pokefork/common/node-startup-awaiter.kt → localnode/src/main/kotlin/vc/rux/localnode/common/node-startup-awaiter.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork.common
+package vc.rux.localnode.common
 
 import org.slf4j.LoggerFactory
 import java.net.HttpURLConnection

core/src/main/kotlin/vc/rux/pokefork/defaults.kt → localnode/src/main/kotlin/vc/rux/localnode/defaults.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork
+package vc.rux.localnode
 
 import com.github.dockerjava.core.DockerClientBuilder
 

core/src/main/kotlin/vc/rux/pokefork/errors/PokeForkError.kt → localnode/src/main/kotlin/vc/rux/localnode/errors/PokeForkError.kt

@@ -1,6 +1,4 @@
-package vc.rux.pokefork.errors
-
-import javax.ws.rs.core.Response
+package vc.rux.localnode.errors
 
 open class PokeForkError : RuntimeException {
     constructor(message: String) : super(message)

core/src/main/kotlin/vc/rux/pokefork/hardhat/HardHatNodeConfig.kt → localnode/src/main/kotlin/vc/rux/localnode/hardhat/HardHatNodeConfig.kt

@@ -1,11 +1,11 @@
-package vc.rux.pokefork.hardhat
+package vc.rux.localnode.hardhat
 
-import vc.rux.pokefork.NodeMode
+import vc.rux.localnode.NodeMode
 
 data class HardHatNodeConfig(
     val nodeMode: NodeMode,
     val blockNumber: Long? = null,
-    val imageName: String = "pokefork",
+    val imageName: String = "localnode",
     val imageTag: String? = null,
     val hardhatVersion: String = "2.17.3"
 ) {

core/src/main/kotlin/vc/rux/pokefork/hardhat/HardhatNode.kt → localnode/src/main/kotlin/vc/rux/localnode/hardhat/HardhatNode.kt

@@ -1,4 +1,4 @@
-package vc.rux.pokefork.hardhat
+package vc.rux.localnode.hardhat
 
 import com.github.dockerjava.api.DockerClient
 import com.github.dockerjava.api.async.ResultCallback
@@ -7,12 +7,12 @@ import com.github.dockerjava.api.command.CreateContainerResponse
 import com.github.dockerjava.api.model.BuildResponseItem
 import com.github.dockerjava.api.model.HostConfig
 import org.slf4j.LoggerFactory
-import vc.rux.pokefork.NodeMode
-import vc.rux.pokefork.common.idPrefix
-import vc.rux.pokefork.common.waitForRpcToBoot
-import vc.rux.pokefork.defaultDockerClient
-import vc.rux.pokefork.hardhat.internal.HardHatConfigJs
-import vc.rux.pokefork.hardhat.internal.HardHatDockerfile
+import vc.rux.localnode.NodeMode
+import vc.rux.localnode.common.idPrefix
+import vc.rux.localnode.common.waitForRpcToBoot
+import vc.rux.localnode.defaultDockerClient
+import vc.rux.localnode.hardhat.internal.HardHatConfigJs
+import vc.rux.localnode.hardhat.internal.HardHatDockerfile
 import java.nio.file.Files
 import kotlin.time.Duration.Companion.seconds