Merge pull request #1 from deltadefi-protocol/dev

Dev

Author: HinsonSIDAN

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "python.analysis.extraPaths": ["./src"]
+}

Makefile

@@ -0,0 +1,29 @@
+
+cov: ## check code coverage
+	poetry run pytest -n 4 --cov sidan_gin
+
+cov-html: cov ## check code coverage and generate an html report
+	poetry run coverage html -d cov_html
+	$(BROWSER) cov_html/index.html
+
+test: ## runs tests
+	poetry run pytest -vv
+
+clean-test: ## remove test and coverage artifacts
+	rm -f .coverage
+	rm -fr cov_html/
+	rm -fr .pytest_cache
+
+docs: ## build the documentation
+	poetry export --dev --without-hashes > docs/requirements.txt
+	rm -r -f docs/build
+	poetry run sphinx-build docs/source docs/build/html
+	$(BROWSER) docs/build/html/index.html
+
+format: ## runs code style and formatter
+	poetry run isort .
+	poetry run black .
+
+deps:
+	poetry lock
+	poetry install

poetry.lock

@@ -0,0 +1,46 @@
+[tool.poetry]
+name = "deltadefi-python-sdk"
+version = "0.1.0"
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+]
+description = "Python SDK for DeltaDeFi protocol."
+homepage = "https://github.com/deltadefi-protocol/python-sdk"
+documentation = "https://github.com/deltadefi-protocol/python-sdk"
+keywords = ["cardano"]
+readme = "README.md"
+authors = ["HinsonSIDAN <[email protected]>"]
+license = "Apache-2.0"
+
+[tool.poetry.dependencies]
+python = ">3.11,<4.0.0"  
+sidan-gin = "0.1.1"
+requests = "^2.25"
+certifi = "2024.8.30"
+charset-normalizer = "3.4.0"
+idna = "3.10"
+urllib3 = "2.2.3"
+pycardano = "^0.12.3"
+
+[tool.poetry.dev-dependencies]
+pytest = "^8.2.0"
+pytest-xdist = "^3.5.0"
+pytest-cov = "^5.0.0"
+Sphinx = "^5.0.0"
+sphinx-rtd-theme = "^2.0.0"
+sphinx-copybutton = "^0.5.0"
+flake8 = "^7.0.0"
+isort = "^5.11.4"
+black = "^24.4.2"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

pyproject.toml

@@ -0,0 +1,4 @@
+# flake8: noqa
+from .api_config import *
+from .auth import *
+from .validation import *

src/deltadefi/__init__.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+from typing import Optional
+
+from pycardano import ExtendedSigningKey
+from sidan_gin import Network
+
+
+@dataclass
+class ApiConfig:
+    network: Optional[Network]
+    signingKey: Optional[ExtendedSigningKey]
+    jwt: Optional[str]
+    apiKey: Optional[str]

src/deltadefi/api_resources/__init__.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class AuthHeaders:
+    jwt: str
+    apiKey: str
+
+
+class ApiHeaders:
+    __annotations__ = {
+        "Content-Type": str,
+        "Authorization": Optional[str],
+        "X-API-KEY": Optional[str],
+    }

src/deltadefi/api_resources/api_config.py

@@ -0,0 +1,42 @@
+# flake8: noqa
+from dataclasses import dataclass
+from typing import List
+
+from sidan_gin import Asset
+
+"""
+ * DeltaDeFiOrderInfo is a type that represents the information of a DeltaDeFi order.
+ * @property {Asset[]} assetsToPay - The assets that are to be paid from orders in current transaction.
+ * @property {Asset[]} assetsToReturn - The assets that are to be received from orders in current transaction.
+ * @property {string} txFee - The transaction fee.
+ * @property {string} tradingFee - The trading fee.
+"""
+
+
+@dataclass
+class DeltaDeFiOrderInfo:
+    assetsToPay: List[Asset]
+    assetsToReturn: List[Asset]
+    txFee: str
+    tradingFee: str
+
+
+"""
+ * DeltaDeFiTxInfo is a type that represents the information of a DeltaDeFi transaction.
+ * @property {Asset[]} accountInput - The assets that are input from the account.
+ * @property {Asset[]} accountOutput - The assets that are output to the account.
+ * @property {Asset[]} dexInput - The assets that are input from the DEX.
+ * @property {Asset[]} dexOutput - The assets that are output to the DEX.
+ * @property {string} txFee - The transaction fee.
+ * @property {string} tradingFee - The trading fee.
+"""
+
+
+@dataclass
+class DeltaDeFiTxInfo:
+    accountInput: List[Asset]
+    accountOutput: List[Asset]
+    dexInput: List[DeltaDeFiOrderInfo]
+    dexOutput: List[DeltaDeFiOrderInfo]
+    txFee: str
+    tradingFee: str

src/deltadefi/api_resources/auth.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+from .accounts import *
+from .app import *
+from .clients import *
+from .markets import *
+from .orders import *