feat:make example using .env

GrapeBaBa · GrapeBaBa · commit 86385a746eaf · 2023-09-01T11:40:08.000+08:00
Signed-off-by: grapebaba &lt;281165273@qq.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -40,4 +40,6 @@ bin/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store
+
+*.env
diff --git a/README.md b/README.md
@@ -11,8 +11,6 @@ Based on [Specs](https://github.com/flashbots/mev-share)
 
 ## Using
 
-Download the latest jar from maven central.
-
 ### Maven
 
 ```xml
diff --git a/build.gradle b/build.gradle
@@ -30,6 +30,7 @@ dependencies {
 	testImplementation platform('org.junit:junit-bom:5.9.1')
 	testImplementation 'org.junit.jupiter:junit-jupiter'
 	testImplementation 'org.apache.logging.log4j:log4j-slf4j2-impl:2.20.0'
+	testImplementation 'io.github.cdimascio:dotenv-java:3.0.0'
 }
 
 sourceSets.test.java {
diff --git a/example/.env.example b/example/.env.example
@@ -0,0 +1,6 @@
+# private key used to sign requests to Flashbots APIs; used for reputation, should not have funds
+AUTH_PRIVATE_KEY=
+# private key used to sign transactions sent to mev-share
+SENDER_PRIVATE_KEY=
+# GOERLI Ethereum RPC endpoint
+PROVIDER_URL=
diff --git a/example/bundle/RpcMevSendBundle.java b/example/bundle/RpcMevSendBundle.java
@@ -2,10 +2,12 @@
 
 import java.io.IOException;
 import java.math.BigInteger;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
+import io.github.cdimascio.dotenv.Dotenv;
 import io.reactivex.disposables.Disposable;
 import net.flashbots.MevShareClient;
 import net.flashbots.models.bundle.BundleItemType;
@@ -33,9 +35,13 @@
 public class RpcMevSendBundle {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException, IOException {
-        Credentials sender = Credentials.create("<hex string of privateKey>");
-        var web3j = Web3j.build(new HttpService("<L1 network url>"));
-        var mevShareClient = new MevShareClient(Network.GOERLI, sender, web3j);
+        Dotenv dotenv = Dotenv.configure()
+                .directory(Paths.get("", "example").toAbsolutePath().toString())
+                .filename(".env")
+                .load();
+        Credentials authSigner = Credentials.create(dotenv.get("AUTH_PRIVATE_KEY"));
+        Web3j web3j = Web3j.build(new HttpService(dotenv.get("PROVIDER_URL")));
+        var mevShareClient = new MevShareClient(Network.GOERLI, authSigner, web3j);
 
         CompletableFuture<MevShareEvent> future = new CompletableFuture<>();
         Disposable eventSource = mevShareClient.subscribe(mevShareEvent -> {
@@ -56,14 +62,14 @@ public static void main(String[] args) throws ExecutionException, InterruptedExc
 
         BundleItemType.HashItem bundleItem = new BundleItemType.HashItem().setHash(mevShareEvent.getHash());
 
-        Credentials signer = Credentials.create("<private key>");
+        Credentials signer = Credentials.create(dotenv.get("SENDER_PRIVATE_KEY"));
         BigInteger nonce = web3j.ethGetTransactionCount(signer.getAddress(), DefaultBlockParameterName.PENDING)
                 .send()
                 .getTransactionCount();
         BigInteger gasPrice = web3j.ethGasPrice().send().getGasPrice();
         BigInteger gasLimit = DefaultGasProvider.GAS_LIMIT;
-        final String to = "<to address>";
-        final String amount = "<ether amount>";
+        final String to = "0x56EdF679B0C80D528E17c5Ffe514dc9a1b254b9c";
+        final String amount = "0.001";
         RawTransaction rawTransaction = RawTransaction.createEtherTransaction(
                 nonce,
                 gasPrice,
diff --git a/example/bundle/RpcMevSimBundle.java b/example/bundle/RpcMevSimBundle.java
@@ -2,9 +2,11 @@
 
 import java.io.IOException;
 import java.math.BigInteger;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 
+import io.github.cdimascio.dotenv.Dotenv;
 import net.flashbots.MevShareClient;
 import net.flashbots.models.bundle.BundleItemType;
 import net.flashbots.models.bundle.BundleParams;
@@ -31,10 +33,13 @@
 public class RpcMevSimBundle {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-
-        Credentials sender = Credentials.create("<hex string of privateKey>");
-        var web3j = Web3j.build(new HttpService("<L1 network url>"));
-        var mevShareClient = new MevShareClient(Network.GOERLI, sender, web3j);
+        Dotenv dotenv = Dotenv.configure()
+                .directory(Paths.get("", "example").toAbsolutePath().toString())
+                .filename(".env")
+                .load();
+        Credentials authSigner = Credentials.create(dotenv.get("AUTH_PRIVATE_KEY"));
+        Web3j web3j = Web3j.build(new HttpService(dotenv.get("PROVIDER_URL")));
+        var mevShareClient = new MevShareClient(Network.GOERLI, authSigner, web3j);
 
         var latestBlock = web3j.ethGetBlockByNumber(DefaultBlockParameterName.LATEST, false)
                 .send()
@@ -48,11 +53,11 @@ public static void main(String[] args) throws IOException, ExecutionException, I
                 .setBlock(latestBlock.getNumber().subtract(BigInteger.ONE))
                 .setMaxBlock(latestBlock.getNumber().add(BigInteger.valueOf(10)));
 
-        Credentials signer = Credentials.create("<private key>");
+        Credentials signer = Credentials.create(dotenv.get("SENDER_PRIVATE_KEY"));
         BigInteger nonce = web3j.ethGetTransactionCount(signer.getAddress(), DefaultBlockParameterName.PENDING)
                 .send()
                 .getTransactionCount();
-        final String to = "<to address>";
+        final String to = "0x56EdF679B0C80D528E17c5Ffe514dc9a1b254b9c";
         RawTransaction rawTransaction = RawTransaction.createEtherTransaction(
                 nonce,
                 web3j.ethGasPrice().send().getGasPrice(),
diff --git a/example/bundle/RpcSendPrivateTx.java b/example/bundle/RpcSendPrivateTx.java
@@ -3,9 +3,11 @@
 import java.io.IOException;
 import java.math.BigInteger;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Paths;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
+import io.github.cdimascio.dotenv.Dotenv;
 import net.flashbots.MevShareClient;
 import net.flashbots.models.bundle.HintPreferences;
 import net.flashbots.models.bundle.PrivateTxOptions;
@@ -29,21 +31,25 @@
 public class RpcSendPrivateTx {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-        Credentials sender = Credentials.create("<hex string of privateKey>");
-        var web3j = Web3j.build(new HttpService("<L1 network url>"));
-        var mevShareClient = new MevShareClient(Network.GOERLI, sender, web3j);
+        Dotenv dotenv = Dotenv.configure()
+                .directory(Paths.get("", "example").toAbsolutePath().toString())
+                .filename(".env")
+                .load();
+        Credentials authSigner = Credentials.create(dotenv.get("AUTH_PRIVATE_KEY"));
+        Web3j web3j = Web3j.build(new HttpService(dotenv.get("PROVIDER_URL")));
+        var mevShareClient = new MevShareClient(Network.GOERLI, authSigner, web3j);
 
         EthBlock.Block latest = web3j.ethGetBlockByNumber(DefaultBlockParameterName.LATEST, false)
                 .send()
                 .getBlock();
 
         BigInteger maxPriorityFeePerGas = BigInteger.valueOf(1_000_000_000L);
 
-        Credentials signer = Credentials.create("<private key>");
+        Credentials signer = Credentials.create(dotenv.get("SENDER_PRIVATE_KEY"));
         BigInteger nonce = web3j.ethGetTransactionCount(signer.getAddress(), DefaultBlockParameterName.PENDING)
                 .send()
                 .getTransactionCount();
-        final String to = "<to address>";
+        final String to = "0x56EdF679B0C80D528E17c5Ffe514dc9a1b254b9c";
 
         RawTransaction rawTransaction = RawTransaction.createTransaction(
                 5L,
diff --git a/example/event/SseHistorical.java b/example/event/SseHistorical.java
@@ -1,15 +1,20 @@
 package event;
 
 import java.math.BigInteger;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
+import io.github.cdimascio.dotenv.Dotenv;
 import net.flashbots.MevShareClient;
 import net.flashbots.models.common.Network;
 import net.flashbots.models.event.EventHistoryEntry;
 import net.flashbots.models.event.EventHistoryInfo;
 import net.flashbots.models.event.EventHistoryParams;
+import org.web3j.crypto.Credentials;
+import org.web3j.protocol.Web3j;
+import org.web3j.protocol.http.HttpService;
 
 /**
  * SSE historical example
@@ -20,7 +25,13 @@
 public class SseHistorical {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException {
-        var mevShareClient = new MevShareClient(Network.GOERLI, null, null);
+        Dotenv dotenv = Dotenv.configure()
+                .directory(Paths.get("", "example").toAbsolutePath().toString())
+                .filename(".env")
+                .load();
+        Credentials authSigner = Credentials.create(dotenv.get("AUTH_PRIVATE_KEY"));
+        Web3j web3j = Web3j.build(new HttpService(dotenv.get("PROVIDER_URL")));
+        var mevShareClient = new MevShareClient(Network.GOERLI, authSigner, web3j);
 
         // get event history info
         CompletableFuture<EventHistoryInfo> historyInfoFuture = mevShareClient.getEventHistoryInfo();
diff --git a/example/event/SseSubscribe.java b/example/event/SseSubscribe.java
@@ -1,11 +1,19 @@
 package event;
 
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.CountDownLatch;
 import java.util.function.Consumer;
 
+import io.github.cdimascio.dotenv.Dotenv;
 import io.reactivex.disposables.Disposable;
 import net.flashbots.MevShareClient;
 import net.flashbots.models.common.Network;
 import net.flashbots.models.event.MevShareEvent;
+import org.web3j.crypto.Credentials;
+import org.web3j.protocol.Web3j;
+import org.web3j.protocol.http.HttpService;
 
 /**
  * SSE subscribe Example
@@ -15,15 +23,30 @@
  */
 public class SseSubscribe {
 
-    public static void main(String[] args) {
-        var mevShareClient = new MevShareClient(Network.GOERLI, null, null);
+    public static void main(String[] args) throws InterruptedException {
+        Dotenv dotenv = Dotenv.configure()
+                .directory(Paths.get("", "example").toAbsolutePath().toString())
+                .filename(".env")
+                .load();
+        Credentials authSigner = Credentials.create(dotenv.get("AUTH_PRIVATE_KEY"));
+        Web3j web3j = Web3j.build(new HttpService(dotenv.get("PROVIDER_URL")));
+
+        var mevShareClient = new MevShareClient(Network.GOERLI, authSigner, web3j);
+
+        CountDownLatch latch = new CountDownLatch(5);
+        List<MevShareEvent> events = new ArrayList<>();
         Consumer<MevShareEvent> eventListener = mevShareEvent -> {
-            // do something and do not block here...
+            events.add(mevShareEvent);
+            latch.countDown();
         };
 
         Disposable disposable = mevShareClient.subscribe(eventListener);
 
+        latch.await();
+
         // remember to release when no longer to subscribe events
         disposable.dispose();
+
+        System.out.println(events);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ dependencies {`
`30`	`30`	`testImplementation platform('org.junit:junit-bom:5.9.1')`
`31`	`31`	`testImplementation 'org.junit.jupiter:junit-jupiter'`
`32`	`32`	`testImplementation 'org.apache.logging.log4j:log4j-slf4j2-impl:2.20.0'`
	`33`	`+ testImplementation 'io.github.cdimascio:dotenv-java:3.0.0'`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`sourceSets.test.java {`