Add documentation

bisq-network · Mar 9, 2020 · 537f3d4 · 537f3d4
1 parent 0b31d13
commit 537f3d4
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/pricenode/src/main/java/bisq/price/spot/providers/CoinMarketCap.java b/pricenode/src/main/java/bisq/price/spot/providers/CoinMarketCap.java
@@ -28,6 +28,9 @@
 import java.util.Collections;
 import java.util.Set;
 
+/**
+ * Stub implementation of CoinMarketCap price provider to prevent NullPointerExceptions within legacy clients
+ */
 @Component
 @Order(3)
 class CoinMarketCap extends ExchangeRateProvider {
@@ -36,6 +39,12 @@ public CoinMarketCap() {
         super("CMC", "coinmarketcap", Duration.ofMinutes(5)); // large data structure, so don't request it too often
     }
 
+    /**
+     * Returns an empty Set for the CoinMarketCap price provider.
+     * Price data of CMC provider is not used in the client anymore, except for the last update timestamp.
+     *
+     * @return Empty Set
+     */
     @Override
     public Set<ExchangeRate> doGet() {