api.rst

API Reference

CLI Commands

process_pending_deposits

polaris.management.commands.process_pending_deposits.Command()

watch_transactions

polaris.management.commands.watch_transactions.Command()

execute_outgoing_transactions

polaris.management.commands.execute_outgoing_transactions.Command()

poll_outgoing_transactions

polaris.management.commands.poll_outgoing_transactions.Command()

testnet

polaris.management.commands.testnet.Command()

Forms

polaris.integrations.TransactionForm()

Integrations

Fees

polaris.integrations.calculate_fee

Customers

polaris.integrations.CustomerIntegration

Deposits

polaris.integrations.DepositIntegration

Stellar Info File (TOML)

polaris.integrations.get_stellar_toml

SEP-6 Info

polaris.integrations.default_info_func

Rails

polaris.integrations.RailsIntegration

Register Integrations

polaris.integrations.register_integrations

SEP-31 Transactions

polaris.integrations.SEP31ReceiverIntegration

Withdrawals

polaris.integrations.WithdrawalIntegration

Quotes

polaris.integrations.QuoteIntegration

Custody

polaris.integrations.CustodyIntegration

Middleware

polaris.middleware.TimezoneMiddleware

Miscellaneous

polaris.sep10.token.SEP10Token

Models

Asset

polaris.models.Asset()

Delivery Method

polaris.models.DeliveryMethod()

Exchange Pair

polaris.models.ExchangePair()

Off-Chain Asset

polaris.models.OffChainAsset()

Transaction

polaris.models.Transaction()

Quote

polaris.models.Quote()

Exceptions

While Polaris does have some custom exceptions defined below, most of the exceptions used in Polaris are built-in exceptions such as ValueError. For example, Polaris expects anchors to raise a ValueError from DepositIntegration.save_sep9_fields() if any of the SEP-9 KYC fields passed are not valid.

However, this approach is not ideal for reasons outlined in a GitHub issue on the Polaris repository.

Starting with Polaris 3.0, all exceptions expected to be raised from integration functions will be defined here.

polaris.exceptions