cryptocloud-sdk 0.1.0__tar.gz

cryptocloud_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.3
+Name: cryptocloud-sdk
+Version: 0.1.0
+Summary: 
+Keywords: async,crypto cloud,python,sdk
+Author: Никита Прожога
+Author-email: fofmow@gmail.com
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: aiohttp (>=3.11.11,<4.0.0)
+Requires-Dist: pydantic (>=2.10.5,<3.0.0)
+Project-URL: Homepage, https://github.com/fofmow/crypto-cloud-sdk
+Project-URL: Repository, https://github.com/fofmow/crypto-cloud-sdk
+Description-Content-Type: text/markdown
+
+# Crypto Cloud SDK — простая асинхронная библиотека для работы с API [CryptoCloud](https://cryptocloud.plus/)
+
+### 💡 Регистрация мерчанта и получение API ключей [описаны в документации](https://docs.cryptocloud.plus/ru/start/get-api-keys)
+
+## Примеры использования / Use cases
+
+```python
+import asyncio
+from datetime import date, timedelta
+
+from cryptocloud_sdk import CryptoCloud, dto, errors
+
+
+async def main():
+    merchant = CryptoCloud(
+        api_token="YOUR_API_TOKEN",
+        shop_id="YOUR_SHOP_ID"
+    )
+    
+    invoice: dto.CreatedInvoice = await merchant.create_invoice(
+        invoice=dto.InvoiceInput(
+            amount=250,
+            currency="USD"  # or dto.currency.SupportedFiatCurrency.USD
+        )
+    )
+    print(f"Invoice url is {invoice.link}")
+    
+    invoices: list[dto.InvoiceInfo] = await merchant.get_invoices(uuids=[invoice.uuid])
+    
+    canceled = await merchant.cancel_invoice(invoice.uuid)
+    
+    balances: list[dto.CoinBalance] = await merchant.get_balance()
+    
+    statictics: dto.Stats = await merchant.get_stats(
+        start=date.today() - timedelta(days=3),
+        end=date.today()
+    )
+    
+    static_wallet: dto.StaticWallet = await merchant.create_static_wallet(
+        currency="BTC",  # or dto.currency.SupportedCryptoCurrency.BTC , 
+        identify="my-new-user-7"
+    )
+    
+    # Handling errors
+    try:
+        await merchant.get_balance()
+    except errors.UnauthorizedError:
+        ...  # your code
+    except errors.ForbiddenError:
+        ...  # your code
+    except errors.BadRequestError:
+        ...  # your code
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+####
+
+## [Want to donate? Look at real app used CryptoCloud 😎](https://t.me/todonators_bot)
+
+##
+
+
+

cryptocloud_sdk-0.1.0/README.md

@@ -0,0 +1,65 @@
+# Crypto Cloud SDK — простая асинхронная библиотека для работы с API [CryptoCloud](https://cryptocloud.plus/)
+
+### 💡 Регистрация мерчанта и получение API ключей [описаны в документации](https://docs.cryptocloud.plus/ru/start/get-api-keys)
+
+## Примеры использования / Use cases
+
+```python
+import asyncio
+from datetime import date, timedelta
+
+from cryptocloud_sdk import CryptoCloud, dto, errors
+
+
+async def main():
+    merchant = CryptoCloud(
+        api_token="YOUR_API_TOKEN",
+        shop_id="YOUR_SHOP_ID"
+    )
+    
+    invoice: dto.CreatedInvoice = await merchant.create_invoice(
+        invoice=dto.InvoiceInput(
+            amount=250,
+            currency="USD"  # or dto.currency.SupportedFiatCurrency.USD
+        )
+    )
+    print(f"Invoice url is {invoice.link}")
+    
+    invoices: list[dto.InvoiceInfo] = await merchant.get_invoices(uuids=[invoice.uuid])
+    
+    canceled = await merchant.cancel_invoice(invoice.uuid)
+    
+    balances: list[dto.CoinBalance] = await merchant.get_balance()
+    
+    statictics: dto.Stats = await merchant.get_stats(
+        start=date.today() - timedelta(days=3),
+        end=date.today()
+    )
+    
+    static_wallet: dto.StaticWallet = await merchant.create_static_wallet(
+        currency="BTC",  # or dto.currency.SupportedCryptoCurrency.BTC , 
+        identify="my-new-user-7"
+    )
+    
+    # Handling errors
+    try:
+        await merchant.get_balance()
+    except errors.UnauthorizedError:
+        ...  # your code
+    except errors.ForbiddenError:
+        ...  # your code
+    except errors.BadRequestError:
+        ...  # your code
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+####
+
+## [Want to donate? Look at real app used CryptoCloud 😎](https://t.me/todonators_bot)
+
+##
+
+

cryptocloud_sdk-0.1.0/cryptocloud_sdk/__init__.py

@@ -0,0 +1,5 @@
+from .merchant import CryptoCloud
+
+__all__ = [
+    "CryptoCloud",
+]

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/__init__.py

@@ -0,0 +1,25 @@
+from .balance import CoinBalance
+from .currency import InvoiceCurrency, BalanceCurrency, SupportedCryptoCurrency, SupportedFiatCurrency
+from .invoice import TimeToPay, AddedInvoiceParamsInput, InvoiceInput, CreatedInvoice, InvoiceInfo
+from .network import CurrencyNetwork
+from .postback import InvoicePostback
+from .project import Project
+from .static_wallet import StaticWallet
+from .stats import Stats
+
+__all__ = [
+    "InvoiceCurrency",
+    "BalanceCurrency",
+    "SupportedCryptoCurrency",
+    "SupportedFiatCurrency",
+    "TimeToPay",
+    "AddedInvoiceParamsInput",
+    "InvoiceInput",
+    "CreatedInvoice",
+    "InvoiceInfo",
+    "Project",
+    "CoinBalance",
+    "StaticWallet",
+    "InvoicePostback",
+    "Stats"
+]

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/balance.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel, confloat
+
+from .currency import BalanceCurrency
+
+
+class CoinBalance(BaseModel):
+    currency: BalanceCurrency
+    balance_crypto: confloat(ge=0)
+    balance_usd: confloat(ge=0)
+    available_balance: confloat(ge=0)
+    available_balance_usd: confloat(ge=0)

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/currency.py

@@ -0,0 +1,82 @@
+from dataclasses import dataclass
+
+from pydantic import BaseModel, conint
+
+from .network import CurrencyNetwork
+
+
+@dataclass(slots=True, frozen=True)
+class SupportedCryptoCurrency:
+    """ Supported Crypto Currencies
+    https://docs.cryptocloud.plus/ru/api-reference-v2/create-invoice#opisanie-dopolnitelnykh-parametrov
+    """
+    USDT_TRC20 = "USDT_TRC20"
+    USDC_TRC20 = "USDC_TRC20"
+    TUSD_TRC20 = "TUSD_TRC20"
+    USDT_ERC20 = "USDT_ERC20"
+    USDC_ERC20 = "USDC_ERC20"
+    TUSD_ERC20 = "TUSD_ERC20"
+    USDD_TRC20 = "USDD_TRC20"
+    SHIB_ERC20 = "SHIB_ERC20"
+    USDT_BSC = "USDT_BSC"
+    USDC_BSC = "USDC_BSC"
+    TUSD_BSC = "TUSD_BSC"
+    USDT_TON = "USDT_TON"
+    BTC = "BTC"
+    LTC = "LTC"
+    ETH = "ETH"
+    TRX = "TRX"
+    BNB = "BNB"
+    TON = "TON"
+
+
+@dataclass(slots=True, frozen=True)
+class SupportedFiatCurrency:
+    USD = "USD"
+    UZS = "UZS"
+    KGS = "KGS"
+    KZT = "KZT"
+    AMD = "AMD"
+    AZN = "AZN"
+    BYN = "BYN"
+    AUD = "AUD"
+    TRY = "TRY"
+    AED = "AED"
+    CAD = "CAD"
+    CNY = "CNY"
+    HKD = "HKD"
+    IDR = "IDR"
+    INR = "INR"
+    JPY = "JPY"
+    PHP = "PHP"
+    SGD = "SGD"
+    THB = "THB"
+    VND = "VND"
+    MYR = "MYR"
+    RUB = "RUB"
+    UAH = "UAH"
+    EUR = "EUR"
+    GBP = "GBP"
+
+
+class _BaseCurrency(BaseModel):
+    id: conint(ge=0)
+    code: str
+    name: str
+    is_email_required: bool
+    stablecoin: bool
+    icon_base: str
+    icon_network: str
+    icon_qr: str
+    order: conint(ge=0)
+
+
+class InvoiceCurrency(_BaseCurrency):
+    network: CurrencyNetwork
+    fullcode: str
+
+
+class BalanceCurrency(_BaseCurrency):
+    enable: bool | None = None
+    obj_network: CurrencyNetwork
+    short_code: str

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/invoice.py

@@ -0,0 +1,63 @@
+from datetime import datetime
+from typing import Literal
+
+from pydantic import BaseModel, confloat
+
+from .currency import InvoiceCurrency
+from .project import Project
+
+
+class _BasePostInvoice(BaseModel):
+    uuid: str
+    expiry_date: datetime
+    address: str
+    side_commission: str
+    amount: confloat(gt=0)
+    amount_usd: confloat(gt=0)
+    fee: confloat(gt=0)
+    fee_usd: confloat(gt=0)
+    service_fee: confloat(gt=0)
+    service_fee_usd: confloat(gt=0)
+    status: str
+    currency: InvoiceCurrency
+    project: Project
+    test_mode: bool
+
+
+class TimeToPay(BaseModel):
+    minutes: int | None = 00
+    hours: int | None = 2
+
+
+class AddedInvoiceParamsInput(BaseModel):
+    time_to_pay: TimeToPay | None = None
+    email_to_send: str | None = None
+    available_currencies: list[str] | None = None
+    cryptocurrency: str | None = None
+    period: Literal["month", "week", "day"] | None = None
+
+
+class InvoiceInput(BaseModel):
+    amount: confloat(gt=0)
+    
+    currency: str | None = "USD"
+    order_id: str | None = None
+    email: str | None = None
+    
+    add_fields: AddedInvoiceParamsInput | None = None
+
+
+class CreatedInvoice(_BasePostInvoice):
+    created: datetime
+    amount_in_fiat: confloat(gt=0)
+    fiat_currency: str
+    side_commission_service: str
+    is_email_required: bool
+    link: str
+
+
+class InvoiceInfo(_BasePostInvoice):
+    received: confloat(ge=0)
+    received_usd: confloat(ge=0)
+    order_id: str | None = None
+    side_commission_cc: str

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/network.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel, conint
+
+
+class CurrencyNetwork(BaseModel):
+    code: str
+    id: conint(ge=0)
+    icon: str
+    fullname: str

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/postback.py

@@ -0,0 +1,15 @@
+from typing import Literal
+
+from pydantic import BaseModel, constr, confloat
+
+
+class InvoicePostback(BaseModel):
+    """ Invoice postback
+    https://docs.cryptocloud.plus/ru/api-reference-v2/postback
+    """
+    status: Literal["success"]
+    invoice_id: constr(max_length=12)
+    amount_crypto: confloat(ge=0)
+    currency: constr(max_length=12)
+    amount_usdt: confloat(ge=0)
+    order_id: int | None = None

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/project.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel, conint
+
+
+class Project(BaseModel):
+    id: conint(ge=0)
+    name: str
+    fail: str
+    success: str
+    logo: str | None = None

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/static_wallet.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+from .currency import BalanceCurrency
+
+
+class StaticWallet(BaseModel):
+    uuid: str
+    address: str
+    currency: BalanceCurrency

cryptocloud_sdk-0.1.0/cryptocloud_sdk/dto/stats.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel, conint, confloat
+
+
+class StatsCount(BaseModel):
+    all: conint(ge=0)
+    created: conint(ge=0)
+    paid: conint(ge=0)
+    overpaid: conint(ge=0)
+    partial: conint(ge=0)
+    canceled: conint(ge=0)
+
+
+class StatsAmount(BaseModel):
+    all: confloat(ge=0)
+    created: confloat(ge=0)
+    paid: confloat(ge=0)
+    overpaid: confloat(ge=0)
+    partial: confloat(ge=0)
+    canceled: confloat(ge=0)
+
+
+class Stats(BaseModel):
+    count: StatsCount
+    amount: StatsAmount

cryptocloud_sdk-0.1.0/cryptocloud_sdk/errors.py

@@ -0,0 +1,10 @@
+class BadRequestError(Exception):
+    ...
+
+
+class UnauthorizedError(Exception):
+    ...
+
+
+class ForbiddenError(Exception):
+    ...

cryptocloud_sdk-0.1.0/cryptocloud_sdk/http_executor.py

@@ -0,0 +1,60 @@
+from abc import ABC, abstractmethod
+from typing import Literal
+
+import aiohttp
+
+from .errors import BadRequestError, UnauthorizedError, ForbiddenError
+
+
+class BaseHttpExecutor(ABC):
+    def __init__(
+        self,
+        headers: dict
+    ):
+        self.__headers = headers
+    
+    async def make_request(
+        self,
+        url: str,
+        method: Literal["get", "post"] = "post",
+        load_response_body: bool = True,
+        **kwargs
+    ) -> (aiohttp.ClientResponse, dict):
+        async with aiohttp.ClientSession() as session:
+            async with getattr(session, method)(
+                url=url,
+                headers=self.__headers,
+                **kwargs
+            ) as resp:
+                if resp.status == 404:
+                    raise BadRequestError(f"The requested {url=} not found. Check API updates.")
+                
+                resp_body = await resp.json()
+                
+                self._check_response_status(resp, resp_body)
+                
+                return resp, resp_body if load_response_body else {}
+    
+    @abstractmethod
+    def _check_response_status(self, response: aiohttp.ClientResponse, response_body: dict) -> None:
+        raise NotImplementedError
+
+
+class CryptoCloudHttpExecutor(BaseHttpExecutor):
+    def _check_response_status(self, response: aiohttp.ClientResponse, response_body: dict) -> None:
+        resp_code = response.status
+        
+        match resp_code:
+            case 400:
+                raise BadRequestError(self._format_error(resp_code, response_body.get("result")))
+            case 401:
+                raise UnauthorizedError(self._format_error(resp_code, response_body.get("detail")))
+            case 403:
+                raise ForbiddenError(self._format_error(resp_code, response_body.get("detail")))
+    
+    @staticmethod
+    def _format_error(code: int, tip: str) -> str:
+        text = f"Returned [{code}] error because - '{tip}'. " \
+               "Make sure that creds and params was correctly passed."
+        
+        return text

cryptocloud_sdk-0.1.0/cryptocloud_sdk/merchant.py

@@ -0,0 +1,114 @@
+from datetime import date
+
+from . import dto
+from .http_executor import CryptoCloudHttpExecutor
+
+
+class CryptoCloud:
+    def __init__(
+        self,
+        api_token: str,
+        shop_id: str,
+        host="https://api.cryptocloud.plus",
+        version: str = "/v2"
+    ):
+        self._http = CryptoCloudHttpExecutor(
+            headers={
+                "Content-Type": "application/json",
+                "Authorization": f"Token {api_token}"
+            }
+        )
+        self._base_url = f"{host}{version}"
+        self._shop_id = shop_id
+    
+    async def create_invoice(self, invoice: dto.InvoiceInput) -> dto.CreatedInvoice:
+        """
+        https://docs.cryptocloud.plus/ru/api-reference-v2/create-invoice#request-body
+        """
+        url = self._base_url + "/invoice/create"
+        payload = invoice.model_dump(exclude_none=True) | {"shop_id": self._shop_id}
+        
+        _, body = await self._http.make_request(
+            url=url,
+            json=payload,
+        )
+        
+        return dto.CreatedInvoice(**body.get("result"))
+    
+    async def get_invoices(self, uuids: list[str]) -> list[dto.InvoiceInfo]:
+        """
+        https://docs.cryptocloud.plus/ru/api-reference-v2/invoice-list#request-body
+        """
+        url = self._base_url + "/invoice/merchant/info"
+        
+        _, body = await self._http.make_request(
+            url=url,
+            json={"uuids": uuids},
+        )
+        
+        return [dto.InvoiceInfo(**i) for i in body.get("result")]
+    
+    async def cancel_invoice(self, uuid: str) -> None:
+        """ https://docs.cryptocloud.plus/ru/api-reference-v2/cancel-invoice#request-body
+        
+        Request will be executed successfully only when invoice has 'created' status
+        :return None -> if canceled without any problem
+        :return Exception -> when some param is not correct """
+        
+        url = self._base_url + "/invoice/merchant/canceled"
+        
+        _, body = await self._http.make_request(
+            url=url,
+            json={"uuid": uuid},
+        )
+    
+    async def get_balance(
+        self, in_currency: dto.SupportedCryptoCurrency | None = None
+    ) -> list[dto.CoinBalance] | dto.CoinBalance:
+        """
+        https://docs.cryptocloud.plus/ru/api-reference-v2/balance#poluchit-balans
+        """
+        url = self._base_url + "/merchant/wallet/balance/all"
+        
+        _, body = await self._http.make_request(url=url)
+        
+        if in_currency:
+            in_curr = [b for b in body.get("result") if b.get("currency").get("code") == in_currency]
+            if in_curr:
+                return dto.CoinBalance(**in_curr.pop())
+        
+        return [dto.CoinBalance(**i) for i in body.get("result")]
+    
+    async def get_stats(self, start: date, end: date) -> dto.Stats:
+        """
+        https://docs.cryptocloud.plus/ru/api-reference-v2/statistics#request-body
+        """
+        url = self._base_url + "/invoice/merchant/statistics"
+        payload = {
+            "start": start.strftime("%d.%m.%Y"),
+            "end": end.strftime("%d.%m.%Y")
+        }
+        
+        _, body = await self._http.make_request(
+            url=url,
+            json=payload,
+        )
+        
+        return dto.Stats(**body.get("result"))
+    
+    async def create_static_wallet(self, currency: str, identify: str) -> dto.StaticWallet:
+        """
+        https://docs.cryptocloud.plus/ru/api-reference-v2/static-wallet#request-body
+        """
+        url = self._base_url + "/invoice/static/create"
+        
+        _, body = await self._http.make_request(
+            url=url,
+            json={
+                "shop_id": self._shop_id,
+                "currency": currency,
+                "identify": identify,
+            },
+        )
+        
+        return dto.StaticWallet(**body.get("result"))

cryptocloud_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "cryptocloud-sdk"
+version = "0.1.0"
+description = ""
+authors = [
+    { name = "Никита Прожога", email = "fofmow@gmail.com" }
+]
+urls = { "homepage" = "https://github.com/fofmow/crypto-cloud-sdk", "repository" = "https://github.com/fofmow/crypto-cloud-sdk" }
+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+keywords = ["async", "crypto cloud", "python", "sdk"]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "aiohttp (>=3.11.11,<4.0.0)",
+    "pydantic (>=2.10.5,<3.0.0)"
+]
+
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"