Redesign asset listing and validation infrastructure

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

@@ -0,0 +1,62 @@
+/*
+ * 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 static org.apache.commons.lang3.Validate.notBlank;
+import static org.apache.commons.lang3.Validate.notNull;
+
+/**
+ * Abstract base class for {@link Asset} implementations. Most implementations should not
+ * extend this class directly, but should rather extend {@link Coin}, {@link Token} or one
+ * of their subtypes.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ */
+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);
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getName();
+    }
+}

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

@@ -0,0 +1,73 @@
+/*
+ * 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;
+
+/**
+ * Value object representing the result of validating an {@link Asset} address. Various
+ * factory methods are provided for typical use cases.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ * @see Asset#validateAddress(String)
+ */
+public class AddressValidationResult {
+
+    private static AddressValidationResult VALID_ADDRESS = new AddressValidationResult(true, "", "");
+
+    private final boolean isValid;
+    private final String message;
+    private final String i18nKey;
+
+    private AddressValidationResult(boolean isValid, String message, String i18nKey) {
+        this.isValid = 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_ADDRESS;
+    }
+
+    public static AddressValidationResult invalidAddress(Throwable cause) {
+        return invalidAddress(cause.getMessage());
+    }
+
+    public static AddressValidationResult invalidAddress(String cause) {
+        return invalidAddress(cause, "validation.altcoin.invalidAddress");
+    }
+
+    public static AddressValidationResult invalidAddress(String cause, String i18nKey) {
+        return new AddressValidationResult(false, cause, i18nKey);
+    }
+
+    public static AddressValidationResult invalidStructure() {
+        return invalidAddress("", "validation.altcoin.wrongStructure");
+    }
+}

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

@@ -0,0 +1,29 @@
+/*
+ * 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;
+
+/**
+ * An {@link Asset} address validation function.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ */
+public interface AddressValidator {
+
+    AddressValidationResult validate(String address);
+}

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

@@ -0,0 +1,46 @@
+/*
+ * 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;
+
+/**
+ * Interface representing a given ("crypto") asset in its most abstract form, having a
+ * {@link #getName() name}, e.g. "Bitcoin", a {@link #getTickerSymbol() ticker symbol},
+ * e.g. "BTC", and an address validation function. Together, these properties represent
+ * the minimum information and functionality required to register and trade an asset on
+ * the Bisq network.
+ * <p>
+ * Implementations typically extend either the {@link Coin} or {@link Token} base
+ * classes, and must be registered in the {@code META-INF/services/bisq.asset.Asset} file
+ * in order to be available in the {@link AssetRegistry} at runtime.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ * @see AbstractAsset
+ * @see Coin
+ * @see Token
+ * @see Erc20Token
+ * @see AssetRegistry
+ */
+public interface Asset {
+
+    String getName();
+
+    String getTickerSymbol();
+
+    AddressValidationResult validateAddress(String address);
+}

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

@@ -0,0 +1,46 @@
+/*
+ * 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;
+
+/**
+ * Provides {@link Stream}-based access to {@link Asset} implementations registered in
+ * the {@code META-INF/services/bisq.asset.Asset} provider-configuration file.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ * @see ServiceLoader
+ */
+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,54 @@
+/*
+ * 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;
+
+/**
+ * {@link AddressValidator} for Base58-encoded Bitcoin addresses.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ * @see org.bitcoinj.core.Address#fromBase58(NetworkParameters, String)
+ */
+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,55 @@
+/*
+ * 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;
+
+/**
+ * Abstract base class for {@link Asset}s with their own dedicated blockchain, such as
+ * {@link bisq.asset.coins.Bitcoin} itself or one of its many derivatives, competitors and
+ * alternatives, often called "altcoins", such as {@link bisq.asset.coins.Litecoin},
+ * {@link bisq.asset.coins.Ether}, {@link bisq.asset.coins.Monero} and
+ * {@link bisq.asset.coins.Zcash}.
+ * <p>
+ * In addition to the usual {@code Asset} properties, a {@code Coin} maintains information
+ * about which {@link Network} it may be used on. By default, coins are constructed with
+ * the assumption they are for use on that coin's "main network", or "main blockchain",
+ * i.e. that they are "real" coins for use in a production environment. In testing
+ * scenarios, however, a coin may be constructed for use only on "testnet" or "regtest"
+ * networks.
+ *
+ * @author Chris Beams
+ * @since 0.7.0
+ */
+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;
+    }
+}