Redesign asset listing and validation infrastructure

src/main/java/bisq/asset/AbstractAsset.java

@@ -0,0 +1,32 @@
+package bisq.asset;
+
+import static org.apache.commons.lang3.Validate.notBlank;
+import static org.apache.commons.lang3.Validate.notNull;
+
+public abstract class AbstractAsset implements Asset {
+
+    private final String name;
+    private final String tickerSymbol;
+    private final AddressValidator addressValidator;
+
+    public AbstractAsset(String name, String tickerSymbol, AddressValidator addressValidator) {
+        this.name = notBlank(name);
+        this.tickerSymbol = notBlank(tickerSymbol);
+        this.addressValidator = notNull(addressValidator);
+    }
+
+    @Override
+    public final String getName() {
+        return name;
+    }
+
+    @Override
+    public final String getTickerSymbol() {
+        return tickerSymbol;
+    }
+
+    @Override
+    public final AddressValidationResult validateAddress(String address) {
+        return addressValidator.validate(address);
+    }
+}

src/main/java/bisq/asset/AddressValidationResult.java

@@ -0,0 +1,65 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public class AddressValidationResult {
+
+    public static AddressValidationResult VALID = new AddressValidationResult(true);
+
+    private final boolean isValid;
+    private String message;
+    private String i18nKey;
+
+    private AddressValidationResult(boolean isValid) {
+        this.isValid = isValid;
+    }
+
+    private AddressValidationResult(boolean isValid, String message, String i18nKey) {
+        this(isValid);
+        this.message = message;
+        this.i18nKey = i18nKey;
+    }
+
+    public boolean isValid() {
+        return isValid;
+    }
+
+    public String getI18nKey() {
+        return i18nKey;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public static AddressValidationResult validAddress() {
+        return VALID;
+    }
+
+    public static AddressValidationResult invalidStructure() {
+        return new AddressValidationResult(false, "", "validation.altcoin.wrongStructure");
+    }
+
+    public static AddressValidationResult invalidAddress(String cause) {
+        return new AddressValidationResult(false, cause, "validation.altcoin.invalidAddress");
+    }
+
+    public static AddressValidationResult invalidAddress(Throwable cause) {
+        return invalidAddress(cause.getMessage());
+    }
+}

src/main/java/bisq/asset/AddressValidator.java

@@ -0,0 +1,23 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public interface AddressValidator {
+
+    AddressValidationResult validate(String address);
+}

src/main/java/bisq/asset/Asset.java

@@ -0,0 +1,10 @@
+package bisq.asset;
+
+public interface Asset {
+
+    String getName();
+
+    String getTickerSymbol();
+
+    AddressValidationResult validateAddress(String address);
+}

src/main/java/bisq/asset/AssetRegistry.java

@@ -0,0 +1,38 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.ServiceLoader;
+import java.util.stream.Stream;
+
+public class AssetRegistry {
+
+    private static final List<Asset> registeredAssets = new ArrayList<>();
+
+    static {
+        for (Asset asset : ServiceLoader.load(Asset.class)) {
+            registeredAssets.add(asset);
+        }
+    }
+
+    public Stream<Asset> stream() {
+        return registeredAssets.stream();
+    }
+}

src/main/java/bisq/asset/Base58BitcoinAddressValidator.java

@@ -0,0 +1,47 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+import org.bitcoinj.core.Address;
+import org.bitcoinj.core.AddressFormatException;
+import org.bitcoinj.core.NetworkParameters;
+import org.bitcoinj.params.MainNetParams;
+
+public class Base58BitcoinAddressValidator implements AddressValidator {
+
+    private final NetworkParameters networkParameters;
+
+    public Base58BitcoinAddressValidator() {
+        this(MainNetParams.get());
+    }
+
+    public Base58BitcoinAddressValidator(NetworkParameters networkParameters) {
+        this.networkParameters = networkParameters;
+    }
+
+    @Override
+    public AddressValidationResult validate(String address) {
+        try {
+            Address.fromBase58(networkParameters, address);
+        } catch (AddressFormatException ex) {
+            return AddressValidationResult.invalidAddress(ex);
+        }
+
+        return AddressValidationResult.validAddress();
+    }
+}

src/main/java/bisq/asset/Coin.java

@@ -0,0 +1,38 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public abstract class Coin extends AbstractAsset {
+
+    public enum Network { MAINNET, TESTNET, REGTEST }
+
+    private final Network network;
+
+    public Coin(String name, String tickerSymbol, AddressValidator addressValidator) {
+        this(name, tickerSymbol, addressValidator, Network.MAINNET);
+    }
+
+    public Coin(String name, String tickerSymbol, AddressValidator addressValidator, Network network) {
+        super(name, tickerSymbol, addressValidator);
+        this.network = network;
+    }
+
+    public Network getNetwork() {
+        return network;
+    }
+}

src/main/java/bisq/asset/Erc20Token.java

@@ -0,0 +1,25 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public abstract class Erc20Token extends Token {
+
+    public Erc20Token(String name, String tickerSymbol) {
+        super(name, tickerSymbol, new EtherAddressValidator());
+    }
+}

src/main/java/bisq/asset/EtherAddressValidator.java

@@ -0,0 +1,26 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public class EtherAddressValidator extends RegexAddressValidator {
+
+    public EtherAddressValidator() {
+        // https://github.com/ethereum/web3.js/blob/master/lib/utils/utils.js#L403
+        super("^(0x)?[0-9a-fA-F]{40}$");
+    }
+}

src/main/java/bisq/core/payment/validation/params/ICHParams.java → src/main/java/bisq/asset/NetworkParametersAdapter.java

@@ -15,7 +15,7 @@
  * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
  */
 
-package bisq.core.payment.validation.params;
+package bisq.asset;
 
 import org.bitcoinj.core.BitcoinSerializer;
 import org.bitcoinj.core.Block;
@@ -27,26 +27,8 @@
 import org.bitcoinj.store.BlockStoreException;
 import org.bitcoinj.utils.MonetaryFormat;
 
-public class ICHParams extends NetworkParameters {
+public abstract class NetworkParametersAdapter extends NetworkParameters {
 
-    private static ICHParams instance;
-
-    public static synchronized ICHParams get() {
-        if (instance == null) {
-            instance = new ICHParams();
-        }
-        return instance;
-    }
-
-    // We only use the properties needed for address validation
-    public ICHParams() {
-        super();
-        addressHeader = 23;
-        p2shHeader = 13;
-        acceptableAddressCodes = new int[]{addressHeader, p2shHeader};
-    }
-
-    // default dummy implementations, not used...
     @Override
     public String getPaymentProtocolId() {
         return PAYMENT_PROTOCOL_ID_MAINNET;

src/main/java/bisq/asset/RegexAddressValidator.java

@@ -0,0 +1,35 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.asset;
+
+public class RegexAddressValidator implements AddressValidator {
+
+    private final String regex;
+
+    public RegexAddressValidator(String regex) {
+        this.regex = regex;
+    }
+
+    @Override
+    public AddressValidationResult validate(String address) {
+        if (!address.matches(regex))
+            return AddressValidationResult.invalidStructure();
+
+        return AddressValidationResult.validAddress();
+    }
+}