Distribute raw tx (LFDT-web3j#1229)

* PrivateTransactionManager

Fixed order of parameters to polling receipt transaction processor when passing custom values to the constructor.

BesuPrivateTransactionManager

Removed unnecessary passing of default polling attempts and frequency in the constructor. Sleep Duration was a magic number and not the symbolic constant used elsewhere.

* Add support for priv_distributeRawTransaction API method (https://besu.hyperledger.org/en/stable/Reference/API-Methods/#priv_distributerawtransaction)

PrivacyEnclaveKey.java -> new response class for enclave key

* Add support for priv_distributeRawTransaction API method (https://besu.hyperledger.org/en/stable/Reference/API-Methods/#priv_distributerawtransaction)

PrivacyTransactionManager.java

Added new method signAndDistribute which takes a raw private transaction signs it and the distibutes to private transaction rceipis using the BEsu API method privDistributeRawTransaction

Added new method sign to support signing but not distributing a raw provate transaction.

Refactored the existing sendTransaction methods to reuse the sign method via signAndSend, changes are transparent to existing users.

The sign method resolves a bug where if a chainId of ChainIDLong.NONE is used the eeaSendRawTransaction fails with a confusing error.

* SpotlessApply

* Fix imports

* spotlessApply

Author: magooster

besu/src/main/java/org/web3j/protocol/besu/Besu.java

@@ -28,6 +28,7 @@
 import org.web3j.protocol.besu.response.privacy.PrivGetPrivacyPrecompileAddress;
 import org.web3j.protocol.besu.response.privacy.PrivGetPrivateTransaction;
 import org.web3j.protocol.besu.response.privacy.PrivGetTransactionReceipt;
+import org.web3j.protocol.besu.response.privacy.PrivateEnclaveKey;
 import org.web3j.protocol.core.DefaultBlockParameter;
 import org.web3j.protocol.core.Request;
 import org.web3j.protocol.core.methods.response.EthAccounts;
@@ -105,6 +106,8 @@ Request<?, EthGetTransactionCount> privGetTransactionCount(
 
     Request<?, PrivGetPrivateTransaction> privGetPrivateTransaction(final String transactionHash);
 
+    Request<?, PrivateEnclaveKey> privDistributeRawTransaction(final String signedTransactionData);
+
     Request<?, PrivGetPrivacyPrecompileAddress> privGetPrivacyPrecompileAddress();
 
     Request<?, PrivCreatePrivacyGroup> privCreatePrivacyGroup(

besu/src/main/java/org/web3j/protocol/besu/JsonRpc2_0Besu.java

@@ -37,6 +37,7 @@
 import org.web3j.protocol.besu.response.privacy.PrivGetPrivacyPrecompileAddress;
 import org.web3j.protocol.besu.response.privacy.PrivGetPrivateTransaction;
 import org.web3j.protocol.besu.response.privacy.PrivGetTransactionReceipt;
+import org.web3j.protocol.besu.response.privacy.PrivateEnclaveKey;
 import org.web3j.protocol.besu.response.privacy.PrivateTransactionReceipt;
 import org.web3j.protocol.core.DefaultBlockParameter;
 import org.web3j.protocol.core.Request;
@@ -214,6 +215,16 @@ public Request<?, PrivGetPrivateTransaction> privGetPrivateTransaction(
                 PrivGetPrivateTransaction.class);
     }
 
+    @Override
+    public Request<?, PrivateEnclaveKey> privDistributeRawTransaction(
+            final String signedTransactionData) {
+        return new Request<>(
+                "priv_distributeRawTransaction",
+                Collections.singletonList(signedTransactionData),
+                web3jService,
+                PrivateEnclaveKey.class);
+    }
+
     @Override
     public Request<?, PrivGetPrivacyPrecompileAddress> privGetPrivacyPrecompileAddress() {
         return new Request<>(

besu/src/main/java/org/web3j/protocol/besu/response/privacy/PrivateEnclaveKey.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2020 Web3 Labs Ltd.
+ *
+ * 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.
+ */
+package org.web3j.protocol.besu.response.privacy;
+
+import org.web3j.protocol.core.Response;
+
+public class PrivateEnclaveKey extends Response<String> {
+    public String getKey() {
+        return getResult();
+    }
+}

besu/src/main/java/org/web3j/tx/BesuPrivateTransactionManager.java

@@ -42,15 +42,8 @@ public BesuPrivateTransactionManager(
             final long chainId,
             final Base64String privateFrom,
             final Base64String privacyGroupId) {
-        this(
-                besu,
-                gasProvider,
-                credentials,
-                chainId,
-                privateFrom,
-                privacyGroupId,
-                DEFAULT_POLLING_ATTEMPTS_PER_TX_HASH,
-                15 * 1000);
+        super(besu, gasProvider, credentials, chainId, privateFrom);
+        this.privacyGroupId = privacyGroupId;
     }
 
     @Override

besu/src/main/java/org/web3j/tx/PrivateTransactionManager.java

@@ -21,6 +21,7 @@
 
 import org.web3j.crypto.Credentials;
 import org.web3j.protocol.besu.Besu;
+import org.web3j.protocol.besu.response.privacy.PrivateEnclaveKey;
 import org.web3j.protocol.besu.response.privacy.PrivateTransactionReceipt;
 import org.web3j.protocol.core.DefaultBlockParameter;
 import org.web3j.protocol.core.methods.response.EthGetCode;
@@ -80,7 +81,7 @@ protected PrivateTransactionManager(
                 credentials,
                 chainId,
                 privateFrom,
-                new PollingPrivateTransactionReceiptProcessor(besu, attempts, sleepDuration));
+                new PollingPrivateTransactionReceiptProcessor(besu, sleepDuration, attempts));
     }
 
     protected PrivateTransactionManager(
@@ -160,11 +161,7 @@ public EthSendTransaction sendTransaction(
                             RESTRICTED);
         }
 
-        final String rawSignedTransaction =
-                Numeric.toHexString(
-                        PrivateTransactionEncoder.signMessage(transaction, chainId, credentials));
-
-        return besu.eeaSendRawTransaction(rawSignedTransaction).send();
+        return signAndSend(transaction);
     }
 
     public EthSendTransaction sendTransactionEIP1559(
@@ -210,11 +207,7 @@ public EthSendTransaction sendTransactionEIP1559(
                             RESTRICTED);
         }
 
-        final String rawSignedTransaction =
-                Numeric.toHexString(
-                        PrivateTransactionEncoder.signMessage(transaction, chainId, credentials));
-
-        return besu.eeaSendRawTransaction(rawSignedTransaction).send();
+        return signAndSend(transaction);
     }
 
     @Override
@@ -264,4 +257,29 @@ public EthGetCode getCode(
                         this.getPrivacyGroupId().toString(), contractAddress, defaultBlockParameter)
                 .send();
     }
+
+    public String sign(RawPrivateTransaction rawTransaction) {
+
+        byte[] signedMessage;
+
+        if (chainId > ChainIdLong.NONE) {
+            signedMessage =
+                    PrivateTransactionEncoder.signMessage(rawTransaction, chainId, credentials);
+        } else {
+            signedMessage = PrivateTransactionEncoder.signMessage(rawTransaction, credentials);
+        }
+
+        return Numeric.toHexString(signedMessage);
+    }
+
+    public EthSendTransaction signAndSend(RawPrivateTransaction rawTransaction) throws IOException {
+        String hexValue = sign(rawTransaction);
+        return this.besu.eeaSendRawTransaction(hexValue).send();
+    }
+
+    public PrivateEnclaveKey signAndDistribute(RawPrivateTransaction rawTransaction)
+            throws IOException {
+        String hexValue = sign(rawTransaction);
+        return this.besu.privDistributeRawTransaction(hexValue).send();
+    }
 }

besu/src/test/java/org/web3j/protocol/besu/RequestTest.java

@@ -194,6 +194,18 @@ public void testPrivGetTransactionCount() throws Exception {
                         + "\"id\":1}");
     }
 
+    @Test
+    public void testPrivDistributeRawTransaction() throws Exception {
+        final String rawTx =
+                "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f"
+                        + "072445675058bb8eb970870f072445675";
+        web3j.privDistributeRawTransaction(rawTx).send();
+
+        verifyResult(
+                "{\"jsonrpc\":\"2.0\",\"method\":\"priv_distributeRawTransaction\","
+                        + "\"params\":[\"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675\"],\"id\":1}");
+    }
+
     @Test
     public void testPrivGetPrivateTransaction() throws Exception {
         web3j.privGetPrivateTransaction("EnclaveKey").send();

besu/src/test/java/org/web3j/protocol/besu/ResponseTest.java

@@ -29,6 +29,7 @@
 import org.web3j.protocol.besu.response.privacy.PrivGetPrivateTransaction;
 import org.web3j.protocol.besu.response.privacy.PrivGetTransactionReceipt;
 import org.web3j.protocol.besu.response.privacy.PrivacyGroup;
+import org.web3j.protocol.besu.response.privacy.PrivateEnclaveKey;
 import org.web3j.protocol.besu.response.privacy.PrivateTransactionLegacy;
 import org.web3j.protocol.besu.response.privacy.PrivateTransactionReceipt;
 import org.web3j.protocol.besu.response.privacy.PrivateTransactionWithPrivacyGroup;
@@ -204,6 +205,22 @@ public void testPrivGetPrivateTransactionNull() {
         assertEquals(privPrivateTransaction.getPrivateTransaction(), (Optional.empty()));
     }
 
+    @Test
+    public void testPrivDistributeRawTransaction() {
+
+        buildResponse(
+                "{\n"
+                        + "    \"jsonrpc\": \"2.0\",\n"
+                        + "    \"id\": 1,\n"
+                        + "    \"result\": \"0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331\"\n"
+                        + "}");
+
+        PrivateEnclaveKey enclaveKey = deserialiseResponse(PrivateEnclaveKey.class);
+        assertEquals(
+                enclaveKey.getKey(),
+                ("0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"));
+    }
+
     @Test
     public void testPrivGetPrivacyPrecompileAddress() {