aiosend 0.1.14__tar.gz

aiosend-0.1.14/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 - present VoVcHiC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aiosend-0.1.14/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.1
+Name: aiosend
+Version: 0.1.14
+Summary: sync & async Crypto Pay API client.
+Home-page: https://github.com/vovchic17/
+License: MIT
+Keywords: crypto pay,CryptoBot,Crypto Pay API
+Author: VoVcHiC
+Author-email: tsvetkovvova17@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: docs
+Provides-Extra: fastapi
+Provides-Extra: flask
+Requires-Dist: aiohttp (>=3.9,<4.0)
+Requires-Dist: certifi (>=2024.8.30,<2025.0.0)
+Requires-Dist: fastapi[standard] (>=0.115.0,<0.116.0) ; extra == "fastapi"
+Requires-Dist: flask[async] (>=3.0.3,<4.0.0) ; extra == "flask"
+Requires-Dist: furo (>=2024.0.0,<2025.0.0) ; extra == "docs"
+Requires-Dist: matplotlib (>=3.9.2,<4.0.0) ; extra == "docs"
+Requires-Dist: pydantic (>=2.4,<3.0)
+Requires-Dist: sphinx-autodoc-typehints (>=2.3.0,<3.0.0) ; extra == "docs"
+Requires-Dist: sphinx-copybutton (>=0.5.2,<0.6.0) ; extra == "docs"
+Requires-Dist: sphinxext-opengraph (>=0.9.1,<0.10.0) ; extra == "docs"
+Project-URL: Documentation, https://aiocp.rtfd.io/en/latest/
+Project-URL: Repository, https://github.com/vovchic17/
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/_static/logo.png" align="center"/>
+  <h1 align="center">aiocp</h1>
+</p>
+
+[![Python](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/main/src/badges/python310_313.json)](https://www.python.org/)
+[![Crypto Pay API](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/refs/heads/main/src/badges/cryptopayapi.json)](https://help.crypt.bot/crypto-pay-api)
+[![Documentation Status](https://readthedocs.org/projects/aiocp/badge/?version=latest)](https://aiocp.readthedocs.io/en/latest/?badge=latest)
+[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
+[![Aiohttp](https://img.shields.io/badge/aiohttp-v3-2c5bb4?logo=aiohttp)](https://docs.aiohttp.org/en/stable/)
+[![Code linter: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)
+[![Checked with mypy](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/main/src/badges/mypy.json)](https://mypy-lang.org/)
+
+**aiocp** is a syncronous & asynchronous [Crypto Pay API](https://help.crypt.bot/crypto-pay-api) client.
+
+> ## [Official documentation](https://aiocp.readthedocs.io/en/latest/)
+> ## [<img src="https://raw.githubusercontent.com/vovchic17/static/2cae16d0c4289f9556dacc13322dd4a2fcca214f/src/telegram_logo.svg" width="30" align="top">  Telegram chat](https://aiocp.t.me/)
+
+
+## Quick start
+```python
+import asyncio
+from aiocp import CryptoPay
+
+
+async def main():
+    cp = CryptoPay(token="TOKEN")
+    app = await cp.get_me()
+    print(app.name)  # Your App Name
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## aiogram 3.x integration example
+
+```python
+import asyncio
+from aiogram import Bot, Dispatcher
+from aiocp import CryptoPay
+
+cp = CryptoPay("TOKEN")
+bot = Bot("TOKEN")
+dp = Dispatcher()
+
+
+@dp.message()
+async def get_invoice(message):
+    invoice = await cp.create_invoice(1, "USDT")
+    await message.answer(f"pay: {invoice.bot_invoice_url}")
+    invoice.await_payment(message=message)
+
+
+@cp.polling_handler()
+async def handle_payment(invoice, message):
+    await message.answer(f"invoice #{invoice.invoice_id} has been paid")
+
+
+async def main():
+    await asyncio.gather(
+        dp.start_polling(bot),
+        cp.start_polling(),
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+

aiosend-0.1.14/README.md

@@ -0,0 +1,70 @@
+<p align="center">
+  <img src="docs/_static/logo.png" align="center"/>
+  <h1 align="center">aiocp</h1>
+</p>
+
+[![Python](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/main/src/badges/python310_313.json)](https://www.python.org/)
+[![Crypto Pay API](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/refs/heads/main/src/badges/cryptopayapi.json)](https://help.crypt.bot/crypto-pay-api)
+[![Documentation Status](https://readthedocs.org/projects/aiocp/badge/?version=latest)](https://aiocp.readthedocs.io/en/latest/?badge=latest)
+[![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
+[![Aiohttp](https://img.shields.io/badge/aiohttp-v3-2c5bb4?logo=aiohttp)](https://docs.aiohttp.org/en/stable/)
+[![Code linter: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)
+[![Checked with mypy](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/vovchic17/static/main/src/badges/mypy.json)](https://mypy-lang.org/)
+
+**aiocp** is a syncronous & asynchronous [Crypto Pay API](https://help.crypt.bot/crypto-pay-api) client.
+
+> ## [Official documentation](https://aiocp.readthedocs.io/en/latest/)
+> ## [<img src="https://raw.githubusercontent.com/vovchic17/static/2cae16d0c4289f9556dacc13322dd4a2fcca214f/src/telegram_logo.svg" width="30" align="top">  Telegram chat](https://aiocp.t.me/)
+
+
+## Quick start
+```python
+import asyncio
+from aiocp import CryptoPay
+
+
+async def main():
+    cp = CryptoPay(token="TOKEN")
+    app = await cp.get_me()
+    print(app.name)  # Your App Name
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## aiogram 3.x integration example
+
+```python
+import asyncio
+from aiogram import Bot, Dispatcher
+from aiocp import CryptoPay
+
+cp = CryptoPay("TOKEN")
+bot = Bot("TOKEN")
+dp = Dispatcher()
+
+
+@dp.message()
+async def get_invoice(message):
+    invoice = await cp.create_invoice(1, "USDT")
+    await message.answer(f"pay: {invoice.bot_invoice_url}")
+    invoice.await_payment(message=message)
+
+
+@cp.polling_handler()
+async def handle_payment(invoice, message):
+    await message.answer(f"invoice #{invoice.invoice_id} has been paid")
+
+
+async def main():
+    await asyncio.gather(
+        dp.start_polling(bot),
+        cp.start_polling(),
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+

aiosend-0.1.14/aiosend/__init__.py

@@ -0,0 +1,12 @@
+from aiosend.client import MAINNET, TESTNET
+from aiosend.utils.sync import CryptoPay
+
+from .__meta__ import __api_version__, __version__
+
+__all__ = (
+    "MAINNET",
+    "TESTNET",
+    "CryptoPay",
+    "__api_version__",
+    "__version__",
+)

aiosend-0.1.14/aiosend/__meta__.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.14"
+__api_version__ = "1.5"

aiosend-0.1.14/aiosend/client/__init__.py

@@ -0,0 +1,13 @@
+from .api_server import MAINNET, TESTNET, APIServer
+from .client import CryptoPay
+from .session.aiohttp import AiohttpSession
+from .session.base import BaseSession
+
+__all__ = (
+    "MAINNET",
+    "TESTNET",
+    "APIServer",
+    "AiohttpSession",
+    "BaseSession",
+    "CryptoPay",
+)

aiosend-0.1.14/aiosend/client/api_server.py

@@ -0,0 +1,54 @@
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Literal
+
+    from aiosend.enums import Asset, Fiat
+    from aiosend.methods import CryptoPayMethod
+
+
+@dataclass(frozen=True)
+class APIServer:
+    """Configuration for endpoints."""
+
+    name: str
+    """Net name"""
+    base: str
+    """Base URL"""
+
+    def url(self, method: "CryptoPayMethod") -> str:
+        """Return URL for method."""
+        return self.base.format(method=method.__method__)
+
+    def get_qr(self, link: str) -> str:
+        """Return qr code link."""
+        return f"https://qr.crypt.bot/?url={link}"
+
+    def get_image(
+        self,
+        asset: "Asset | str",
+        asset_amount: float,
+        fiat: "Fiat | str",
+        fiat_amount: float,
+        main: "Literal['asset', 'fiat']",
+    ) -> str:
+        """Return check image url."""
+        return (
+            "https://imggen.send.tg/checks/image?"
+            f"asset={asset}"
+            f"&asset_amount={asset_amount}"
+            f"&fiat={fiat}"
+            f"&fiat_amount={fiat_amount}"
+            f"&main={main}"
+        )
+
+
+MAINNET = APIServer(
+    name="MAINNET",
+    base="https://pay.crypt.bot/api/{method}",
+)
+TESTNET = APIServer(
+    name="TESTNET",
+    base="https://testnet-pay.crypt.bot/api/{method}",
+)

aiosend-0.1.14/aiosend/client/client.py

@@ -0,0 +1,85 @@
+from typing import TYPE_CHECKING
+
+from aiosend import loggers
+from aiosend.client import MAINNET, TESTNET
+from aiosend.exceptions import APIError, WrongNetworkError
+from aiosend.methods import Methods
+from aiosend.polling import PollingConfig, PollingManager
+from aiosend.tools import Tools
+from aiosend.utils import PropagatingThread
+from aiosend.webhook import AiohttpManager, RequestHandler
+
+from .session import AiohttpSession
+
+if TYPE_CHECKING:
+    from aiosend.client import APIServer
+    from aiosend.methods import CryptoPayMethod
+    from aiosend.types import _CryptoPayType
+    from aiosend.webhook import _APP, WebhookManager
+
+    from .session import BaseSession
+
+
+class CryptoPay(Methods, Tools, RequestHandler, PollingManager):
+    """
+    Client class providing API methods.
+
+    :param token: Crypto Bot API token
+    :param session: HTTP Session
+    :param api_server: Crypto Bot API server
+    """
+
+    def __init__(
+        self,
+        token: str,
+        api_server: "APIServer" = MAINNET,
+        session: "type[BaseSession]" = AiohttpSession,
+        manager: "WebhookManager[_APP] | None" = None,
+        polling_config: "PollingConfig | None" = None,
+    ) -> None:
+        self._token = token
+        self.session = session(api_server)
+        RequestHandler.__init__(self, manager or AiohttpManager())
+        PollingManager.__init__(self, polling_config or PollingConfig())
+        thread = PropagatingThread(target=self.__auth)
+        thread.start()
+        thread.join()
+
+    async def __call__(
+        self,
+        method: "CryptoPayMethod[_CryptoPayType]",
+    ) -> "_CryptoPayType":
+        """
+        Request method.
+
+        Use this method to make an API request.
+
+        :param method: CryptoPayMethod object.
+        :return: :class:`CryptoPayType` object.
+        """
+        async with self.session as session:
+            loggers.client.debug("Requesting: %s", method.__method__)
+            return await session.request(self._token, self, method)
+
+    def __auth(self) -> None:
+        try:
+            me = self.get_me()
+            loggers.client.info(
+                "Authorized as '%s' id=%d on %s",
+                me.name,
+                me.app_id,
+                self.session.api_server.name,
+            )
+        except APIError:
+            current_net = self.session.api_server
+            if current_net == MAINNET:
+                self.session = self.session.__class__(TESTNET)
+            else:
+                self.session = self.session.__class__(MAINNET)
+            self.get_me()
+            net = self.session.api_server
+            msg = (
+                "Authorization failed. Token is served by the "
+                f"{net.name}, you are using {current_net.name}"
+            )
+            raise WrongNetworkError(msg) from None

aiosend-0.1.14/aiosend/client/client.pyi

@@ -0,0 +1,212 @@
+from builtins import bool as _bool
+from builtins import float as _float
+from builtins import list as _list
+from builtins import str as _str
+from collections.abc import Awaitable, Callable, Generator
+from datetime import datetime
+from types import NoneType as _NoneType
+from typing import Any, TypeVar
+
+from typing_extensions import Self
+
+from aiosend.client import APIServer
+from aiosend.enums import (
+    Asset,
+    CheckStatus,
+    CurrencyType,
+    Fiat,
+    InvoiceStatus,
+    LiteralAsset,
+    LiteralCheckStatus,
+    LiteralCurrencyType,
+    LiteralFiat,
+    LiteralInvoiceStatus,
+    LiteralPaidBtnName,
+    PaidBtnName,
+)
+from aiosend.methods import CryptoPayMethod
+from aiosend.polling import PollingConfig
+from aiosend.polling.manager import Handler, PollingTask
+from aiosend.types import (
+    App,
+    AppStats,
+    Balance,
+    Check,
+    Currency,
+    ExchangeRate,
+    Invoice,
+    Transfer,
+    _CryptoPayType,
+)
+from aiosend.webhook import (
+    _APP,
+    WebhookManager,
+)
+
+from .session import BaseSession
+
+_T = TypeVar("_T")
+
+# These classes are needed for syncronous type hinting.
+# Stub file annotates the methods as syncronous, but
+# while using this lib asynchronously, the actual return type
+# is a coroutine that returns an annotated type, so these classes
+# will annotate awaited object as return type.
+
+class list(_list[_T]):  # noqa: A001, N801
+    def __await__(self) -> Generator[None, None, Self]: ...
+
+class bool(_bool):  # type: ignore[misc]  # noqa: A001, N801
+    def __await__(self) -> Generator[None, None, Self]: ...
+
+class str(_str):  # noqa: A001, N801
+    def __await__(self) -> Generator[None, None, Self]: ...
+
+class float(_float):  # noqa: A001, N801
+    def __await__(self) -> Generator[None, None, Self]: ...
+
+class NoneType(_NoneType):  # type: ignore[misc, valid-type]
+    def __await__(self) -> Generator[None, None, None]: ...
+
+class CryptoPay:
+    _token: _str
+    session: BaseSession
+    _timeout: int
+    _delay: int
+    _tasks: dict[int, PollingTask]
+    _handler: Handler | None
+    _exp_handler: Handler | None
+    _webhook_manager: WebhookManager
+
+    def __init__(
+        self,
+        token: _str,
+        api_server: APIServer = ...,
+        session: type[BaseSession] = ...,
+        manager: WebhookManager[_APP] | None = None,
+        polling_config: PollingConfig | None = None,
+    ) -> None: ...
+    async def __call__(
+        self,
+        method: CryptoPayMethod[_CryptoPayType],
+    ) -> _CryptoPayType: ...
+    def get_me(self) -> App: ...
+    def create_invoice(
+        self,
+        amount: _float,
+        asset: Asset | LiteralAsset | _str | None = None,
+        *,
+        currency_type: CurrencyType | LiteralCurrencyType | _str | None = None,
+        fiat: Fiat | LiteralFiat | _str | None = None,
+        accepted_assets: _list[Asset | LiteralAsset | _str] | None = None,
+        description: _str | None = None,
+        hidden_message: _str | None = None,
+        paid_btn_name: PaidBtnName | LiteralPaidBtnName | _str | None = None,
+        paid_btn_url: _str | None = None,
+        payload: _str | None = None,
+        allow_comments: bool | None = None,
+        allow_anonymous: bool | None = None,
+        expires_in: int | None = None,
+    ) -> Invoice: ...
+    def delete_invoice(
+        self,
+        invoice_id: int,
+    ) -> bool: ...
+    def create_check(
+        self,
+        amount: _float,
+        asset: Asset | LiteralAsset | _str,
+        pin_to_user_id: int | None = None,
+        pin_to_username: _str | None = None,
+    ) -> Check: ...
+    def delete_check(
+        self,
+        check_id: int,
+    ) -> bool: ...
+    def transfer(
+        self,
+        user_id: int,
+        asset: Asset | LiteralAsset | _str,
+        amount: _float,
+        spend_id: _str | None = None,
+        comment: _str | None = None,
+        disable_send_notification: bool | None = None,
+    ) -> Transfer: ...
+    def get_invoices(
+        self,
+        asset: Asset | LiteralAsset | _str | None = None,
+        fiat: Fiat | LiteralFiat | _str | None = None,
+        invoice_ids: _list[int] | None = None,
+        status: InvoiceStatus | LiteralInvoiceStatus | _str | None = None,
+        offset: int | None = None,
+        count: int | None = None,
+    ) -> list[Invoice]: ...
+    def get_checks(
+        self,
+        asset: Asset | LiteralAsset | _str | None = None,
+        check_ids: _list[int] | None = None,
+        status: CheckStatus | LiteralCheckStatus | _str | None = None,
+        offset: int | None = None,
+        count: int | None = None,
+    ) -> list[Check]: ...
+    def get_transfers(
+        self,
+        asset: Asset | LiteralAsset | _str | None = None,
+        transfer_ids: _list[int] | None = None,
+        spend_id: _str | None = None,
+        offset: int | None = None,
+        count: int | None = None,
+    ) -> list[Transfer]: ...
+    def get_balance(self) -> list[Balance]: ...
+    def get_exchange_rates(self) -> list[ExchangeRate]: ...
+    def get_currencies(self) -> list[Currency]: ...
+    def get_stats(
+        self,
+        start_at: datetime | None = None,
+        end_at: datetime | None = None,
+    ) -> AppStats: ...
+    def delete_all_checks(self) -> NoneType: ...
+    def delete_all_invoices(self) -> NoneType: ...
+    def exchange(
+        self,
+        amount: _float,
+        source: Asset | LiteralAsset | Fiat | LiteralFiat | _str,
+        target: Asset | LiteralAsset | Fiat | LiteralFiat | _str,
+    ) -> float: ...
+    def get_balance_by_asset(
+        self,
+        asset: Asset | LiteralAsset | _str,
+    ) -> float: ...
+    def polling_handler(self) -> Callable[[Handler], Handler]: ...
+    def expired_handler(self) -> Callable[[Handler], Handler]: ...
+    def webhook_handler(
+        self,
+        app: _APP,
+        path: _str,
+    ) -> Callable[
+        [Callable[[Invoice], Awaitable]],
+        Callable[[Invoice], Awaitable],
+    ]: ...
+    def feed_update(
+        self,
+        handler: Callable[[Invoice], Awaitable],
+        body: dict[_str, Any],
+        headers: dict[_str, _str],
+    ) -> NoneType: ...
+    async def __process_invoice(
+        self,
+        invoice: Invoice,
+    ) -> NoneType: ...
+    def _add_invoice(
+        self,
+        invoice: Invoice,
+        data: dict[_str, Any],
+    ) -> NoneType: ...
+    def start_polling(
+        self,
+        parallel: Callable[[], Any] | None = None,
+    ) -> NoneType: ...
+    def get_invoice(
+        self,
+        invoice: int | Invoice,
+    ) -> Invoice | NoneType: ...

aiosend-0.1.14/aiosend/client/session/__init__.py

@@ -0,0 +1,7 @@
+from .aiohttp import AiohttpSession
+from .base import BaseSession
+
+__all__ = (
+    "AiohttpSession",
+    "BaseSession",
+)

aiosend-0.1.14/aiosend/client/session/aiohttp.py

@@ -0,0 +1,69 @@
+import ssl
+from typing import TYPE_CHECKING, cast
+
+import certifi
+from aiohttp import ClientSession, TCPConnector
+from aiohttp.http import SERVER_SOFTWARE
+
+from aiosend.__meta__ import __version__
+
+from .base import BaseSession
+
+if TYPE_CHECKING:
+    import aiosend
+    from aiosend.client import APIServer
+    from aiosend.methods import CryptoPayMethod
+    from aiosend.types import _CryptoPayType
+
+
+class AiohttpSession(BaseSession):
+    """
+    Http session based on aiohttp.
+
+    This class is a wrapper of `aiohttp.ClientSession`.
+    """
+
+    def __init__(self, api_server: "APIServer") -> None:
+        super().__init__(api_server)
+        self._session: ClientSession | None = None
+
+    async def request(
+        self,
+        token: str,
+        client: "aiosend.CryptoPay",
+        method: "CryptoPayMethod[_CryptoPayType]",
+    ) -> "_CryptoPayType":
+        """Make http request."""
+        ssl_context = ssl.create_default_context(cafile=certifi.where())
+        self._session = ClientSession(
+            connector=TCPConnector(
+                ssl_context=ssl_context,
+            ),
+        )
+        async with self._session as session:
+            resp = await session.post(
+                url=self.api_server.url(method),
+                data=method.model_dump_json(exclude_none=True),
+                headers={
+                    "Crypto-Pay-API-Token": token,
+                    "Content-Type": "application/json",
+                    "User-Agent": f"{SERVER_SOFTWARE} aiosend/{__version__}",
+                },
+            )
+            response = self._check_response(client, method, await resp.text())
+        return cast("_CryptoPayType", response.result)
+
+    async def close(self) -> None:
+        """Close http session."""
+        if self._session is not None and not self._session.closed:
+            await self._session.close()
+
+    def __del__(self) -> None:
+        """Close session connector."""
+        if (
+            self._session is not None
+            and not self._session.closed
+            and self._session.connector is not None
+            and self._session.connector_owner
+        ):
+            self._session.connector.close()