import sys
from typing import Callable
from polaris.integrations.fees import calculate_fee, registered_fee_func
from polaris.integrations.forms import TransactionForm, CreditCardForm
from polaris.integrations.toml import get_stellar_toml, registered_toml_func
from polaris.integrations.javascript import scripts, registered_scripts_func
from polaris.integrations.transactions import (
DepositIntegration,
WithdrawalIntegration,
registered_deposit_integration,
registered_withdrawal_integration,
)
[docs]def register_integrations(
deposit: DepositIntegration = None,
withdrawal: WithdrawalIntegration = None,
toml_func: Callable = None,
scripts_func: Callable = None,
fee_func: Callable = None,
):
"""
Registers instances of user-defined subclasses of
``WithdrawalIntegration`` and
``DepositIntegration`` with Polaris.
Call this function in the relevant Django AppConfig.ready() function:
::
from django.apps import AppConfig
class PolarisIntegrationApp(AppConfig):
name = 'Polaris Integration'
verbose_name = name
def ready(self):
from polaris.integrations import register_integrations
from myapp.integrations import (MyDepositIntegration,
MyWithdrawalIntegration)
register_integrations(
deposit=MyDepositIntegration(),
withdrawal=MyWithdrawalIntegration()
)
These integration classes provide a structured interface for implementing
user-defined logic used by Polaris, specifically for deposit and withdrawal
flows.
See the integration classes for more information on implementation.
:param deposit: the ``DepositIntegration`` subclass instance to be
used by Polaris
:param withdrawal: the ``WithdrawalIntegration`` subclass instance to
be used by Polaris
:param toml_func: a function that returns stellar.toml data as a dictionary
:param scripts_func: a function that returns a list of script tags as
strings
:param fee_func: a function that returns the fee that would be charged
:raises ValueError: missing argument(s)
:raises TypeError: arguments are not subclasses of DepositIntegration or
Withdrawal
"""
this = sys.modules[__name__]
if not (deposit or withdrawal):
raise ValueError("Must pass at least one integration class")
elif deposit and not issubclass(deposit.__class__, DepositIntegration):
raise TypeError("deposit must be a subclass of DepositIntegration")
elif withdrawal and not issubclass(withdrawal.__class__, WithdrawalIntegration):
raise TypeError("withdrawal must be a subclass of WithdrawalIntegration")
elif toml_func and not callable(toml_func):
raise TypeError("toml_func is not callable")
elif scripts_func and not callable(scripts_func):
raise TypeError("javascript_func is not callable")
elif fee_func and not callable(fee_func):
raise TypeError("javascript_func is not callable")
for obj, attr in [
(deposit, "registered_deposit_integration"),
(withdrawal, "registered_withdrawal_integration"),
(toml_func, "registered_toml_func"),
(scripts_func, "registered_scripts_func"),
(fee_func, "registered_fee_func"),
]:
if obj:
setattr(this, attr, obj)