v0.4.0

- Support for BlockBee
- Fetch all supported cryptocurrencies and cache them
- Updated API Helper
- Added conversion endpoint
- Added support for BlockBee API Key
- Added UI for payments
- Added store application to provide examples on how to implement
- General improvements
- Fixed bugs

Author: arianoangelo

.gitignore

@@ -1,3 +1,6 @@
+# MacOS
+.DS_STORE
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -21,6 +24,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+django_store/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

MANIFEST.in

@@ -1,4 +1,5 @@
-![CryptAPI](https://i.imgur.com/IfMAa7E.png)
+[<img src="https://i.imgur.com/IfMAa7E.png" width="300"/>](image.png)
+
 
 # CryptAPI's Django Library
 Django's implementation of CryptAPI's payment gateway
@@ -99,7 +100,7 @@ from cryptapi import Invoice
 def order_creation_view(request):
     ...
     invoice = Invoice(
-        request=request,
+        request=request, # This if your view request. It's meant to create the callback URL
         order_id=user_order.id,
         coin='btc',
         value=user_order.value
@@ -117,10 +118,14 @@ def order_creation_view(request):
 #### Where:
 
 ``request`` is Django's view HttpRequest object  
+
 ``order_id`` is just your order id  
-``coin`` is the ticker of the coin you wish to use, any of our supported coins (https://cryptapi.io/pricing/). You need to have a ``Provider`` set up for that coin.  
+
+``coin`` is the ticker of the coin you wish to use, any of our supported coins (https://cryptapi.io/cryptocurrencies/). You need to have a ``Provider`` set up for that coin.  
+
 ``value`` is an integer of the value of your order, either in satoshi, litoshi, wei, piconero or IOTA
 
+&nbsp;
 
 ### Getting notified when the user pays
 
@@ -134,18 +139,15 @@ def payment_received(order_id, payment, value):
     ...
 ```
 
-
 Where:  
 
 ``order_id`` is the id of the order that you provided earlier, used to fetch your order  
 ``payment`` is an ``cryptapi.models.Payment`` object with the payment details, such as TXID, number of confirmations, etc.  
 ``value`` is the value the user paid, either in satoshi, litoshi, wei or IOTA
 
 
-&nbsp;
-
-
->#### Important:
+#### Important:
+>
 >Don't forget to import your signals file. 
 >
 >On your App's `apps.py` file:
@@ -163,76 +165,142 @@ Where:
 >[django docs](https://docs.djangoproject.com/en/3.0/topics/signals/#django.dispatch.receiver)
 
 
+
+### Using our provided interface
+
+Create a view in ``views.py``
+
+```python
+def payment(_r, request_id):
+    try:
+        req = Request.objects.get(id=request_id)
+        coin = req.provider.coin
+
+        qrcode = get_qrcode(coin, req.address_in)
+
+        fiat = get_conversion(coin, 'eur', req.value_requested)
+
+        print(fiat)
+
+        ctx = {
+            'req': req,
+            'qrcode': qrcode,
+            'fiat': fiat['value_coin']
+        }
+
+        return render(_r, 'payment.html', context=ctx)
+
+    except Request.DoesNotExist:
+        pass
+
+    return redirect('store:request')
+```
+In your template HTML
+
+```djangotemplate
+{% extends 'base.html' %}
+{% load cryptapi_helper %}
+{% block content %}
+    {% generate_payment_template %}
+{% endblock %}
+```
+
 &nbsp;
 
 
 ### Helpers
 
-This library has a couple of helpers to help you get started
+This library has a couple of helpers to help you get started. They are present in the file ``utils.py``.
 
 ``cryptapi.valid_providers()`` is a method that returns a list of tuples of the active providers that you can just feed into the choices of a ``form.ChoiceField``
 
-``cryptapi.get_order_invoices(order_id)`` returns a list of ``cryptapi.models.Request`` objects of your order (you can have multiple objects for the same order if the user mistakenly initiated the payment with another coin)
+``cryptapi.get_order_invoices(order_id)`` returns a list of ``cryptapi.models.Request`` objects of your order (you can have multiple objects for the same order if the user mistakenly initiated the payment with another coin or if he mistakenly didn't send the full payment)
 
+``cryptapi.callback_url(_r, params)`` build your callback URL to provide to ``get_request``. Should be used inside a view since ``_r = request``
 
-### Template Tags
-There's also some template tags which you can import to help you with conversions and the protocols.
-You just need to load ``cryptapi_helper`` on your template and use the following tags / filters:  
+&nbsp;
 
-* #### QR code (with `cryptapi.models.Request` object)
-If you want the library to generate and display a clickable QR code for you, just use our `generate_qrcode_for_request`, like this:
+### CryptAPI Helper
 
-```djangotemplate
-{% generate_qrcode_for_request payment_request %}
-```
+This is the helper responsible for the connections ot the API itself. All these functions are in the ``cryptapi.py`` file. 
 
-You just need to feed it the `payment_request` object created with `invoice.request()` 
+``get_info(coin)`` returns the information of all cryptocurrencies or just if ``coin=''`` or a specific cryptocurrency if ``coin='ltc'`` for example. [docs](https://docs.cryptapi.io/#operation/info)
 
-The QR code that can also be clicked on mobile devices to launch the user's wallet.
+``get_supported_coins()`` returns all the support cryptocurrencies. You can consult them in this [list](https://cryptapi.io/fees/). 
 
-* #### QR code (with address, coin and value)
-If you want the library to generate and display a clickable QR code for you, just use our `generate_qrcode`, like this:
+``get_logs(coin, callback_url)`` returns all the callback logs related to a request. ``callback_url`` should be the callback provided to our API. [docs](https://docs.cryptapi.io/#operation/logs)
 
-```djangotemplate
-{% generate_qrcode btc 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3 0.001 %}
-```
+``get_qrcode(coin, address, value, size)`` returns a PNG of a QR Code with the address for payment. [docs](https://docs.cryptapi.io/tag/Bitcoin#operation/btcqrcode)
+
+``get_conversion(origin, to, value)`` returns the converted value in the parameter ``value_coin`` to the currency you wish, FIAT or Cryptocurrency.
+
+``get_estimate(coin)`` returns the estimation of the blockchain fees for the cryptocurrency specified in the parameter ``coin``. E.g: ``get_estimate('trc20_usdt')`` [docs](https://docs.cryptapi.io/#operation/estimate)
+
+``get_address(coin, address_out, callback_url, pending, api_key)`` requests a payment address to CryptAPI. If you don't wish to use [BlockBee](https://dash.blockbee.io/), you can leave ``api_key`` empty. [docs](https://docs.cryptapi.io/#operation/create)
 
-It takes 3 arguments: the coin, the payment address and the value in the main denomination of the coin, and it will output a neat QR code for your page. 
+&nbsp;
 
-The QR code that can also be clicked on mobile devices to launch the user's wallet.
+### How to use the QR code (with address, coin and value)
 
-##### Example:
+To generate a QR Code you must use ``get_qrcode`` in your view and feed the parameters to your template. To generate a QR Code image you must place content of the API response after ``data:image/png;base64,{{qr_code}}`` so the browser generates the QR Code.
 ```djangotemplate
-{% load cryptapi_helper %}
-<body>
-    <div class="row">
-        <div class="col-sm-12">
-            {% generate_qrcode btc 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3 0.001 %}
-        </div>
-    </div>
-</body>
+<img src="data:image/png;base64,{{ qrcode.qr_code }}" alt="Payment QR Code"/>
 ```
 
-* #### Payment URI
-If you just want to build a full payment URI to plug into your own QR code, you can use our `build_payment_uri` tag, like so:
+You can also make the QR Code clickable.
 
 ```djangotemplate
-{% build_payment_uri btc 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3 0.001 %}
+<a href='{{ qrcode.payment_uri }}'>
+    <img src="data:image/png;base64,{{ qrcode.qr_code }}" alt="Payment QR Code"/>
+</a>
 ```
 
-It will output: `bitcoin:1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3?amount=0.001`
+You can also add a value to the QR Code setting the ``value`` parameter to the value of your order (e.g ``0.2 LTC``). This may not function correctly in some wallets. **Use at your own risk.**
 
-Same arguments as for the QR code
+## What is the Store application?
 
-* #### Helpers
+We made the ``store`` application to provide you with code examples on how to implement our service. It also has the code for our suggested UI (both CSS and HTML).
 
-``{% convert_value coin value %}`` where the coin is the coin ticker and the value is the value in satoshi, litoshi, wei or IOTA, will convert to the main coin unit.  
 
+## Help
 
-``{{ coin|coin_name }}`` will output the properly formatted cryptocurrency name.
+Need help?  
+Contact us @ https://cryptapi.io/contacts/
 
 
-## Help
+### Changelog 
 
-Need help?  
-Contact us @ https://cryptapi.io/contact/
+#### 0.1.2
+* Version bump
+
+#### 0.1.3
+* Pending transactions (through the `payment_pending` signal)
+* Monero
+
+#### 0.1.5
+* Fixed bug with MySQL database varchar length limitations
+* Added build payment URI tag, to help you generate payment URIs to feed into any QR Code generator
+
+#### 0.2.0
+* Added ERC-20 token support
+* Added payment QR code
+* Improved documentation
+* Fixed bugs
+
+#### 0.2.7
+* Added coin info helper
+
+#### 0.3.1
+* New API URL
+* New general info API
+
+#### 0.4.0
+* Support for BlockBee
+* Fetch all supported cryptocurrencies and cache them
+* Updated API Helper
+* Added conversion endpoint
+* Added support for BlockBee API Key
+* Added UI for payments
+* Added store application to provide examples on how to implement
+* General improvements
+* Fixed bugs

README.md

@@ -1,7 +1,5 @@
 from cryptapi.meta import VERSION
 from cryptapi.dispatchers import RequestDispatcher as Invoice  # noqa
-from cryptapi.utils import get_active_providers as valid_providers, get_order_request as get_order_invoices, info as coin_info  # noqa
-from cryptapi.helpers import get_coin_multiplier, round_sig
+from cryptapi.utils import get_active_providers as valid_providers, get_order_request as get_order_invoices, build_callback_url as callback_url
 
 __version__ = str(VERSION)
-

cryptapi/__init__.py

@@ -1,5 +1,6 @@
 from django.contrib import admin
-from cryptapi.models import Provider, Request, Payment, RequestLog, PaymentLog
+from .models import Provider, Request, Payment, RequestLog, PaymentLog, Metadata
+from .forms import CreateProviderForm
 
 
 class ReadOnlyAdmin(admin.ModelAdmin):
@@ -18,41 +19,17 @@ def has_delete_permission(self, request, obj=None):
 
 
 class ProviderAdmin(admin.ModelAdmin):
-    add_fieldsets = (
-        ('Coin', {
-            'fields': ('coin',),
-            'description': 'Select provider coin'
-        }),
-        ('Cold Wallet', {
-            'fields': ('cold_wallet',),
-            'description': "Insert your cold wallet's address"
-        }),
-        ('Active', {
-            'fields': ('active',),
-            'description': "Enable this provider"
-        }),
-    )
-
-    fieldsets = (
-        ('Coin', {
-            'fields': ('coin', ),
-            'description': 'Select provider coin'
-        }),
-        ('Cold Wallet', {
-            'fields': ('cold_wallet', ),
-            'description': "Insert your cold wallet's address"
-        }),
-        ('Active', {
-            'fields': (('active',), ('last_updated', ), ),
-            'description': "Enable this provider"
-        }),
-    )
-
-    readonly_fields = ('last_updated', )
-
-
-admin.site.register(Provider)
+    readonly_fields = ['last_updated']
+    form = CreateProviderForm
+
+
+class MetadataAdmin(ReadOnlyAdmin):
+    list_display = ('__str__', 'last_updated',)
+
+
+admin.site.register(Provider, ProviderAdmin)
 admin.site.register(Request, ReadOnlyAdmin)
 admin.site.register(RequestLog, ReadOnlyAdmin)
 admin.site.register(Payment, ReadOnlyAdmin)
 admin.site.register(PaymentLog, ReadOnlyAdmin)
+admin.site.register(Metadata, MetadataAdmin)

cryptapi/admin.py

@@ -1,50 +1,9 @@
 from django.utils.translation import gettext_lazy as _
 
-TOKENS = [
-    ('erc20_usdt', 'ERC-20 USDT', '0xdAC17F958D2ee523a2206206994597C13D831ec7', 6, 4),
-    ('erc20_usdc', 'ERC-20 USDC', '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 6, 4),
-    ('erc20_busd', 'ERC-20 BUSD', '0x4Fabb145d64652a948d72533023f6E7A623C7C53', 18, 16),
-    ('erc20_pax', 'ERC-20 PAX', '0x8E870D67F660D95d5be530380D0eC0bd388289E1', 18, 16),
-    ('erc20_tusd', 'ERC-20 TUSD', '0x0000000000085d4780B73119b644AE5ecd22b376', 18, 16),
-    ('erc20_bnb', 'ERC-20 BNB', '0xB8c77482e45F1F44dE1745F52C74426C631bDD52', 18, 0),
-    ('erc20_link', 'ERC-20 ChainLink', '0x514910771AF9Ca656af840dff83E8264EcF986CA', 18, 0),
-    ('erc20_cro', 'ERC-20 Crypto.com Coin', '0xA0b73E1Ff0B80914AB6fe0444E65848C4C34450b', 8, 0),
-    ('erc20_mkr', 'ERC-20 Maker', '0x9f8F72aA9304c8B593d555F12eF6589cC3A579A2', 18, 0),
-    ('erc20_nexo', 'ERC-20 NEXO', '0xB62132e35a6c13ee1EE0f84dC5d40bad8d815206', 18, 0),
-    ('erc20_bcz', 'ERC-20 BECAZ', '0x08399ab5eBBE96870B289754A7bD21E7EC8c6FCb', 18, 0),
-]
-
-
-TOKEN_DICT = {t[0]: t for t in TOKENS}
-
-
-COINS = [
-    ('btc', 'Bitcoin'),
-    ('eth', 'Ethereum'),
-    ('bch', 'Bitcoin Cash'),
-    ('ltc', 'Litecoin'),
-    ('iota', 'IOTA'),
-    ('xmr', 'Monero'),
-] + [(t[0], t[1]) for t in TOKENS]  # Tokens
-
-
 STATUS = (
     ('created', _('Created')),
     ('pending', _('Pending')),
     ('insufficient', _('Payment Insufficient')),
     ('received', _('Received')),
     ('done', _('Done')),
-)
-
-
-COIN_MULTIPLIERS = {
-    'btc': 10**8,
-    'bch': 10**8,
-    'ltc': 10**8,
-    'eth': 10**18,
-    'iota': 10**6,
-    'xmr': 10**12,
-
-    # Tokens
-    **{t[0]: 10**t[3] for t in TOKENS}
-}
+)