Version 1.12.0.0

Author: MrNaif2018

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     hooks:
       - id: yesqa
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/isort
@@ -48,6 +48,6 @@ repos:
         args: ["--remove"]
       - id: detect-private-key
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.4
+    rev: v3.0.0-alpha.6
     hooks:
       - id: prettier

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## Latest changes
 
+## 1.12.0.0
+
+Breaking: removed `rate` and `list_fiat` commands.
+
+This is because the current exchange rates model:
+
+1. Didn't provide enough customization (tied to coingecko and it's currencies only)
+2. Often unreliable because sometimes depends on implementation in e.g. electrum
+3. Getting rate limited when many daemons are launched
+
+To overcome the problem, we've moved the exchange rates functionality one layer up (like it should have always been), to the Merchants API
+
+This means if you use rate command in your script, you should either use Merchants API directly (maybe your usage of SDK is not required at all), or fetch
+exchange rates from your favourite exchange rates provider (more customization)
+
 ## 1.11.1.0
 
 Add new `xpub_name` attribute in coin objects, used to display what "xpub" actually means in context of current coin (i.e. it may be xpub, or it may actually be an address)

bitcart/coins/btc.py

@@ -1,5 +1,4 @@
 import inspect
-from decimal import Decimal
 from functools import wraps
 from typing import TYPE_CHECKING, Any, Callable, Dict, Iterable, List, Optional, Union
 
@@ -391,46 +390,6 @@ async def pay_to_many(
         else:
             return tx_data  # type: ignore
 
-    async def rate(self, currency: str = "USD") -> Decimal:
-        """Get bitcoin price in selected fiat currency
-
-        It uses the same method as electrum wallet gets exchange rate-via different payment providers
-
-        Examples:
-
-        >>> c.rate()
-        9878.527
-
-        >>> c.rate("RUB")
-        757108.226
-
-        Args:
-            self (BTC): self
-            currency (str, optional): Currency to get rate into. Defaults to "USD".
-
-        Returns:
-            Decimal: price of 1 bitcoin in selected fiat currency
-        """
-        return convert_amount_type(await self.server.exchange_rate(currency))
-
-    async def list_fiat(self) -> Iterable[str]:
-        """List of all available fiat currencies to get price for
-
-        This list is list of only valid currencies that could be passed to rate() function
-
-        Example:
-
-        >>> c.list_fiat()
-        ['AED', 'ARS', 'AUD', 'BCH', 'BDT', 'BHD', 'BMD', 'BNB', 'BRL', 'BTC', ...]
-
-        Args:
-            self (BTC): self
-
-        Returns:
-            Iterable[str]: list of available fiat currencies
-        """
-        return await self.server.list_currencies()  # type: ignore
-
     async def set_config(self, key: str, value: Any) -> bool:
         """Set config key to specified value
 

examples/atomic_tipbot/README.md

@@ -1,5 +1,7 @@
 # Full example of using BitcartCC: Telegram Atomic Tip Bot
 
+**_Note: this example doesn't work because of `rate()` command being removed. Fetch exchange rates yourself or use Merchants API for this_**
+
 The bot is available in telegram at @bitcart_atomic_tipbot
 
 Used tools:
@@ -149,7 +151,6 @@ To see a list of all RPC methods, call
 RPC methods accessible via btc.server can't have intellisence in your IDE because they are completely dynamic(via `__getattr__`).
 
 Now, about using BitcartCC in this bot's code.
-To get price of 1 bitcoin in USD, simply call `btc.rate()`
 Use `btc.add_request(amount, description="", expire=15)` to create BTC invoice
 Amount is amount in BTC, description is optional and is description of invoice, expire is the time invoice will expire in,
 default 15 minutes, but if you pass None, invoice will never expire.

examples/full.py

@@ -14,9 +14,6 @@
 print(btc.RPC_PASS)  # default rpc password
 
 # Methods used without wallet #
-print(btc.rate())  # BTC rate in USD
-print(btc.rate("RUB"))  # BTC rate in rubles, or any other currency
-print(btc.list_fiat())  # List of all fiat currencies to get bitcoin rate in
 print(btc.help())  # List of low level electrum methods
 print(btc.server.validateaddress("x"))  # Example of calling lowlevel electrum method
 print(btc.get_tx("d0e9433f41e17ef74547aa5e1873cd3ad12f1402b488eb93e1c8e3dda971ef53"))  # Get transaction info

setup.py

@@ -3,7 +3,7 @@
 setup(
     name="bitcart",
     packages=find_packages(),
-    version="1.11.1.0",
+    version="1.12.0.0",
     license="MIT",
     description="BitcartCC coins support library",
     long_description=open("README.md").read(),

tests/coins/btc/test_without_wallet.py

@@ -2,7 +2,6 @@
 
 If this succeeds, most likely other coins will succeed too
 """
-import decimal
 import os
 
 import pytest
@@ -28,21 +27,6 @@ async def test_help(btc):
     assert "help" in data
 
 
-@pytest.mark.parametrize("currency", ["USD", "RUB", "JPY", "nonexisting"])
-async def test_rate(btc, currency):
-    price = await btc.rate(currency)
-    if currency == "nonexisting":
-        assert price.is_nan()
-    else:
-        assert price > 0
-    assert isinstance(price, decimal.Decimal)
-
-
-async def test_fiat(btc):
-    fiat_currencies = await btc.list_fiat()
-    assert ["USD", "BTC", "RUB", "JPY", "EUR"] >= fiat_currencies
-
-
 @pytest.mark.parametrize("address,expected", [("x", False), ("tb1qzq67gkmp7fl45y5h87emyhhzdl3s77904h99c8", True)])
 async def test_electrum_validate_address(btc, address, expected):
     assert await btc.server.validateaddress(address) == expected