Upgrade to bitcoinj 0.17-alpha1, ConsensusJ 0.7.0-alpha1

doc/omnij-test-design-patterns.adoc

@@ -1,5 +1,4 @@
-OmniJ Test Architecture and Design Patterns
-============================================
+= OmniJ Test Architecture and Design Patterns
 :toc:
 :toc-placement: manual
 :numbered:

gradle.properties

@@ -2,12 +2,12 @@ omnijVersion = 0.7.0-SNAPSHOT
 
 useMavenLocal = false
 
-bitcoinjVersion = 0.16.2
-consensusjVersion = 0.6.5
+bitcoinjVersion = 0.17-alpha1
+consensusjVersion = 0.7.0-alpha1
 slf4jVersion = 2.0.7
 groovyVersion = 4.0.12
 spockVersion = 2.3-groovy-4.0
-junitJupiterVersion = 5.8.1
+junitJupiterVersion = 5.9.2
 
 rpcTestUser=bitcoinrpc
 rpcTestPassword=pass

omnij-cli/src/main/java/foundation/omni/cli/ConsensusCLI.java

@@ -109,7 +109,7 @@ public void run(OmniCoreCLICall call) throws IOException, InterruptedException,
         tool1 = new OmniCoreConsensusTool((OmniClient) call.rpcClient());
         if (line.hasOption("omnicore-url")) {
             uri2 = URI.create(line.getOptionValue("omnicore-url"));
-            tool2 = new OmniCoreConsensusTool(call.getRPCConfig().getNetParams(), uri2);
+            tool2 = new OmniCoreConsensusTool(call.getRPCConfig().network(), uri2);
         } else if (line.hasOption("omniwallet-url")) {
             uri2 = URI.create(line.getOptionValue("omniwallet-url"));
             tool2 = new OmniwalletConsensusTool(uri2);

omnij-cli/src/main/java/foundation/omni/cli/OmniCoreCLICall.java

@@ -1,6 +1,5 @@
 package foundation.omni.cli;
 
-import foundation.omni.netapi.omnicore.RxOmniClient;
 import org.consensusj.bitcoin.jsonrpc.RpcConfig;
 import foundation.omni.rpc.OmniClient;
 import org.consensusj.bitcoin.cli.BitcoinCLITool;
@@ -23,6 +22,6 @@ public OmniCoreCLICall(BitcoinCLITool tool, PrintStream out, PrintStream err, St
 
     @Override
     public OmniClient createClient(SSLSocketFactory sslSocketFactory, RpcConfig config) {
-        return new OmniClient(sslSocketFactory, config.getNetParams(), config.getURI(), config.getUsername(), config.getPassword(), false, false);
+        return new OmniClient(sslSocketFactory, config.network(), config.getURI(), config.getUsername(), config.getPassword(), false, false);
     }
 }

omnij-core/src/main/java/foundation/omni/AddressBalanceEntry.java

@@ -1,6 +1,6 @@
 package foundation.omni;
 
-import org.bitcoinj.core.Address;
+import org.bitcoinj.base.Address;
 
 /**
  *  Balance entry for an Address

omnij-core/src/main/java/foundation/omni/OmniDivisibleValue.java

@@ -1,6 +1,6 @@
 package foundation.omni;
 
-import org.bitcoinj.core.Coin;
+import org.bitcoinj.base.Coin;
 
 import java.math.BigDecimal;
 import java.math.MathContext;

omnij-core/src/main/java/foundation/omni/OmniOutput.java

@@ -1,6 +1,6 @@
 package foundation.omni;
 
-import org.bitcoinj.core.Address;
+import org.bitcoinj.base.Address;
 
 /**
  * A record-like container for an amount and a destination address. Intended for {@code omni_sendmany}.

omnij-core/src/main/java/foundation/omni/OmniValue.java

@@ -1,6 +1,6 @@
 package foundation.omni;
 
-import org.bitcoinj.core.Coin;
+import org.bitcoinj.base.Coin;
 
 import javax.money.NumberValue;
 import java.math.BigDecimal;

omnij-core/src/main/java/foundation/omni/address/OmniBase58LegacyAddressConverter.java

@@ -1,21 +1,21 @@
 package foundation.omni.address;
 
-import org.bitcoinj.core.Address;
-import org.bitcoinj.core.LegacyAddress;
-import org.bitcoinj.params.MainNetParams;
+import foundation.omni.net.OmniNetwork;
+import org.bitcoinj.base.Address;
+import org.bitcoinj.base.BitcoinNetwork;
+import org.bitcoinj.base.LegacyAddress;
 
 /**
  * EXPERIMENTAL 2-way Conversion between MAINNET Omni and BTC Addresses
+ * @deprecated Omni "Safe" addresses will be implemented for Segwit and/or Taproot, not Base58
  */
+@Deprecated
 class OmniBase58LegacyAddressConverter {
-    static final OmniAddressMainNetParams omniParams = OmniAddressMainNetParams.get();
-    static final MainNetParams btcParams = MainNetParams.get();
-
     static Address btcToOmni(Address btcAddress) {
-        return LegacyAddress.fromPubKeyHash(omniParams, btcAddress.getHash());
+        return LegacyAddress.fromPubKeyHash(OmniNetwork.MAINNET, btcAddress.getHash());
     }
 
     static Address omniToBTC(Address omniAddress) {
-        return LegacyAddress.fromPubKeyHash(btcParams, omniAddress.getHash());
+        return LegacyAddress.fromPubKeyHash(BitcoinNetwork.MAINNET, omniAddress.getHash());
     }
 }

omnij-core/src/main/java/foundation/omni/address/OmniSegwitAddressConverter.java

@@ -1,101 +1,64 @@
 package foundation.omni.address;
 
-import org.bitcoinj.core.Bech32;
-import org.bitcoinj.core.NetworkParameters;
-import org.bitcoinj.core.SegwitAddress;
-import org.bitcoinj.params.MainNetParams;
-import org.bitcoinj.params.Networks;
-import org.bitcoinj.params.RegTestParams;
-import org.bitcoinj.params.TestNet3Params;
-
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.Set;
+import foundation.omni.net.OmniNetwork;
+import org.bitcoinj.base.Bech32;
+import org.bitcoinj.base.BitcoinNetwork;
+import org.bitcoinj.base.SegwitAddress;
 
 /**
  * Convert between Bitcoin and Omni Bech32 Segwit addresses
- * Adds Omni networks to bitcoinj's {@link Networks} registry
  * Bitcoin: bc1xxxx
  * Omni: om1xxxx
  */
-class OmniSegwitAddressConverter {
-    /**
-     * Default set of Omni Networks for Omni Address parsing
-     * (We don't include RegTest by default because RegTest and TestNet addresses use the same
-     * prefix in Base58 format)
-     */
-    public static final Set<NetworkParameters> defaultOmniNetworks =
-            unmodifiableSet(OmniAddressMainNetParams.get(), OmniAddressTestNetParams.get());
-
-    static {
-        // TODO: Maybe we don't want to modify bitcoinj's list of networks unless explicitly configured?
-        Networks.register(defaultOmniNetworks);
-    }
+public class OmniSegwitAddressConverter {
 
     public static SegwitAddress btcToOmni(SegwitAddress btcAddress) {
-        NetworkParameters omniParams = btcParamsToOmniParams(btcAddress.getParameters());
+        OmniNetwork omniNet = btcNetworkToOmniNetwork((BitcoinNetwork) btcAddress.network());
         Bech32.Bech32Data btcBech32Data = Bech32.decode(btcAddress.toBech32());
-        String omniAddressString = Bech32.encode(Bech32.Encoding.BECH32, omniParams.getSegwitAddressHrp(), btcBech32Data.data);
-        return SegwitAddress.fromBech32(omniParams, omniAddressString);
+        String omniAddressString = Bech32.encode(Bech32.Encoding.BECH32, omniNet.segwitAddressHrp(), btcBech32Data.data);
+        return (SegwitAddress) OmniNetwork.addressParser.parseAddress(omniAddressString, omniNet);
     }
 
     public static SegwitAddress btcToOmni(String btcAddressString) {
-        SegwitAddress btcAddress = SegwitAddress.fromBech32(null, btcAddressString);
-        return btcToOmni(btcAddress);
-    }
-
-    public static SegwitAddress btcToOmni(NetworkParameters btcParams, String btcAddressString) {
-        SegwitAddress btcAddress = SegwitAddress.fromBech32(btcParams, btcAddressString);
+        SegwitAddress btcAddress = (SegwitAddress) OmniNetwork.addressParser.parseAddressAnyNetwork(btcAddressString);
         return btcToOmni(btcAddress);
     }
 
     public static SegwitAddress omniToBtc(SegwitAddress omniAddress) {
-        NetworkParameters btcParams = omniParamsToBtcParams(omniAddress.getParameters());
+        BitcoinNetwork btcNet = omniNetworkToBtcNetwork((OmniNetwork) omniAddress.network());
         Bech32.Bech32Data btcBech32Data = Bech32.decode(omniAddress.toBech32());
-        String btcAddressString = Bech32.encode(Bech32.Encoding.BECH32, btcParams.getSegwitAddressHrp(), btcBech32Data.data);
-        return SegwitAddress.fromBech32(btcParams, btcAddressString);
+        String btcAddressString = Bech32.encode(Bech32.Encoding.BECH32, btcNet.segwitAddressHrp(), btcBech32Data.data);
+        return (SegwitAddress) OmniNetwork.addressParser.parseAddress(btcAddressString, btcNet);
     }
 
     public static SegwitAddress omniToBtc(String omniAddressString) {
-        SegwitAddress btcAddress = SegwitAddress.fromBech32(null, omniAddressString);
-        return omniToBtc(btcAddress);
+        SegwitAddress omniAddress = (SegwitAddress) OmniNetwork.addressParser.parseAddressAnyNetwork(omniAddressString);
+        return omniToBtc(omniAddress);
     }
 
-    public static SegwitAddress omniToBtc(NetworkParameters btcParams, String btcAddressString) {
-        SegwitAddress btcAddress = SegwitAddress.fromBech32(btcParams, btcAddressString);
-        return omniToBtc(btcAddress);
-    }
-
-    static private NetworkParameters btcParamsToOmniParams(NetworkParameters btcParams) {
-        switch (btcParams.getId()) {
-            case NetworkParameters.ID_MAINNET:
-                return OmniAddressMainNetParams.get();
-            case NetworkParameters.ID_TESTNET:
-                return OmniAddressTestNetParams.get();
-            case NetworkParameters.ID_REGTEST:
-                return OmniAddressRegTestParams.get();
+    static private OmniNetwork btcNetworkToOmniNetwork(BitcoinNetwork network) {
+        switch (network) {
+            case MAINNET:
+                return OmniNetwork.MAINNET;
+            case TESTNET:
+                return OmniNetwork.TESTNET;
+            case REGTEST:
+                return OmniNetwork.REGTEST;
             default:
                 throw new IllegalArgumentException("Unspported network");
         }
     }
 
-    static private NetworkParameters omniParamsToBtcParams(NetworkParameters omniParams) {
-        switch (omniParams.getId()) {
-            case NetworkParameters.ID_MAINNET:
-                return MainNetParams.get();
-            case NetworkParameters.ID_TESTNET:
-                return TestNet3Params.get();
-            case NetworkParameters.ID_REGTEST:
-                return RegTestParams.get();
+    static private BitcoinNetwork omniNetworkToBtcNetwork(OmniNetwork network) {
+        switch (network) {
+            case MAINNET:
+                return BitcoinNetwork.MAINNET;
+            case TESTNET:
+                return BitcoinNetwork.TESTNET;
+            case REGTEST:
+                return BitcoinNetwork.REGTEST;
             default:
                 throw new IllegalArgumentException("Unspported network");
         }
     }
-
-    // Create an unmodifiable set of NetworkParameters from an array/varargs
-    private static Set<NetworkParameters> unmodifiableSet(NetworkParameters... ts) {
-        return Collections.unmodifiableSet(new HashSet<>(Arrays.asList(ts)));
-    }
-
 }

omnij-core/src/main/java/foundation/omni/net/MoneyMan.java

@@ -1,7 +1,7 @@
 package foundation.omni.net;
 
 import foundation.omni.OmniDivisibleValue;
-import org.bitcoinj.core.Coin;
+import org.bitcoinj.base.Coin;
 
 /**
  * Definitions for MoneyMan address functionality on TestNet and RegTest

omnij-core/src/main/java/foundation/omni/net/OmniMainNetParams.java

@@ -1,14 +1,12 @@
 package foundation.omni.net;
 
-import org.bitcoinj.core.AddressFormatException;
-import org.bitcoinj.core.LegacyAddress;
+import org.bitcoinj.base.exceptions.AddressFormatException;
 import org.bitcoinj.params.MainNetParams;
 
 /**
  * Omni Protocol parameters for Bitcoin MainNet
  */
 public class OmniMainNetParams extends OmniNetworkParameters {
-    private static final String ExodusAddress = "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P";
     public static final Integer FIRST_EXODUS_BLOCK = 249498;
     public static final Integer LAST_EXODUS_BLOCK = 255365;
     public static final Integer POST_EXODUS_BLOCK = 255366;
@@ -19,7 +17,7 @@ private OmniMainNetParams() {
         super();
         params = MainNetParams.get();
         try {
-            exodusAddress = LegacyAddress.fromString(params, ExodusAddress);
+            exodusAddress = OmniNetwork.MAINNET.exodusAddress();
         } catch (AddressFormatException e) {
             exodusAddress = null;
         }