charli3_dendrite 1.1.1.dev7__tar.gz → 1.1.1.dev12__tar.gz

{charli3_dendrite-1.1.1.dev7 → charli3_dendrite-1.1.1.dev12}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Charli3-Official and SteelSwap
-
-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.
+MIT License
+
+Copyright (c) 2024 Charli3-Official and SteelSwap
+
+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.

{charli3_dendrite-1.1.1.dev7 → charli3_dendrite-1.1.1.dev12}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: charli3_dendrite
-Version: 1.1.1.dev7
+Version: 1.1.1.dev12
 Summary: 
 Author: Elder Millenial
 Author-email: eldermillenial@protonmail.com
@@ -9,11 +9,13 @@ 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
 Requires-Dist: blockfrost-python (>=0.6.0,<0.7.0)
+Requires-Dist: bump-my-version (>=1.1.4,<2.0.0)
 Requires-Dist: psycopg[binary,pool] (>=3.1.13,<4.0.0)
-Requires-Dist: pycardano (==0.11.1)
+Requires-Dist: pycardano (==0.12.2)
 Requires-Dist: pydantic (>=2.5.2,<3.0.0)
-Requires-Dist: python-dotenv (==0.21.1)
+Requires-Dist: python-dotenv (==1.0.1)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Description-Content-Type: text/markdown
 
@@ -23,6 +25,7 @@ Description-Content-Type: text/markdown
     <p>
         <img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python version">
         <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License">
+        <img src="https://img.shields.io/pypi/dm/charli3-dendrite?style=flat-square" />
         <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome">
     </p>
 </div>
@@ -218,5 +221,5 @@ poetry run pytest --benchmark-disable -v --slow -n auto
 ```
 
 ## Contributing
-Contributions to Charli3 Dendrite are welcome! Please refer to the `CONTRIBUTING.md` file for guidelines on how to contribute to the project.
+Contributions to Charli3 Dendrite are welcome! Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute to the project.
 

{charli3_dendrite-1.1.1.dev7 → charli3_dendrite-1.1.1.dev12}/README.md

@@ -1,202 +1,203 @@
-<div align="center">
-    <h1 align="center">Charli3 Dendrite</h1>
-    <p align="center">Python SDK for interacting with Cardano DEXs</p>
-    <p>
-        <img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python version">
-        <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License">
-        <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome">
-    </p>
-</div>
-
-## Overview
-
-Charli3 Dendrite is a powerful Python SDK designed for seamless interaction with multiple Decentralized Exchanges (DEXs) on the Cardano blockchain. It provides a unified interface for developers to access various DEX functionalities, simplifying the process of building applications in the Cardano ecosystem.
-
-## Key Features
-
-- 🔄 Multi-DEX Support: Integrate with Minswap, MuesliSwap, Spectrum, SundaeSwap, VyFi, GeniusYield, Axo, and WingRiders
-- 💧 Liquidity Pool Data: Fetch and analyze pool information across different DEXs
-- 💱 Swap Operations: Execute token swaps with ease
-- 🧩 Flexible Asset Handling: Manage various asset types and pool states efficiently
-- 🔗 On-chain Data Integration: Connect with DB-sync, BlockFrost, and Ogmios/Kupo
-- 🛠 Extensible Architecture: Easily add support for new DEXs and features
-
-
-## Installation
-
-```bash
-# Using pip
-pip install charli3_dendrite
-
-# Using Poetry
-poetry add charli3_dendrite
-```
-
-## Supported DEXs
-Charli3 Dendrite currently supports the following Cardano DEXs:
-
-- Minswap
-- MuesliSwap
-- Spectrum
-- SundaeSwap
-- VyFi
-- WingRiders
-- GeniusYield
-- Axo
-
-### Not Yet Implemented
-
-- CardanoSwaps
-- Metadex
-- CSwap
-- TeddySwap
-- Cerra
-- SaturnSwap
-- Splash
-
-Each DEX is implemented as a separate module within the `charli3_dendrite.dexs.amm` package.
-
-## Configuration
-Charli3 Dendrite can be configured using environment variables or a `.env` file. See `sample.env` for an example of the configuration options.
-
-### Backend Configuration
-
-Charli3 Dendrite supports multiple backend options for interacting with the Cardano blockchain:
-
-#### DBSync Configuration
-
-To use a DBSync instance as the blockchain connection, set the following environment variables:
-
-```bash
-DBSYNC_HOST="your-dbsync-host"
-DBSYNC_PORT="your-dbsync-port"
-DBSYNC_DB_NAME="your-dbsync-database-name"
-DBSYNC_USER="your-dbsync-username"
-DBSYNC_PASS="your-dbsync-password"
-```
-
-#### BlockFrost Configuration
-
-To use BlockFrost as the backend, set the following environment variables:
-
-```bash
-BLOCKFROST_PROJECT_ID="your-blockfrost-project-id"
-CARDANO_NETWORK="mainnet"  # or "testnet" for the Cardano testnet
-```
-
-#### Ogmios/Kupo Configuration
-
-To use Ogmios and Kupo as the backend, set the following environment variables:
-
-```bash
-OGMIOS_URL="ws://your-ogmios-url:port"
-KUPO_URL="http://your-kupo-url:port"
-CARDANO_NETWORK="mainnet"  # or "testnet" for the Cardano testnet
-```
-
-The backend will be automatically selected based on the available environment variables. If multiple backend configurations are present, the priority order is: DBSync, BlockFrost, Ogmios/Kupo.
-
-### Backend Limitations
-
-While Charli3 Dendrite supports multiple backends, it's important to note that the BlockFrost and Ogmios/Kupo backends have some limitations compared to the DBSync backend:
-
-- **BlockFrost Backend**: Due to limitations in the BlockFrost API, the following methods are not implemented:
-  - `get_historical_order_utxos`
-  - `get_order_utxos_by_block_or_tx`
-  - `get_cancel_utxos`
-  - `get_axo_target`
-
-- **Ogmios/Kupo Backend**: The Ogmios/Kupo backend also has limitations due to the nature of these services:
-  - `get_historical_order_utxos`
-  - `get_order_utxos_by_block_or_tx`
-  - `get_cancel_utxos`
-
-These methods will raise a `NotImplementedError` when called using the BlockFrost or Ogmios/Kupo backends. If your application requires these functionalities, consider using the DBSync backend.
-
-## Usage
-
-### Retrieving Orders and Pool Data
-
-To retrieve orders and pool data, first configure the global backend:
-
-```python
-from charli3_dendrite.backend import set_backend, get_backend
-from charli3_dendrite.backend.dbsync import DbsyncBackend
-from charli3_dendrite.backend.blockfrost import BlockFrostBackend
-from charli3_dendrite.backend.ogmios_kupo import OgmiosKupoBackend
-from pycardano import Network
-
-# Choose one of the following backends:
-# set_backend(DbsyncBackend())
-# set_backend(BlockFrostBackend("your-project-id"))
-set_backend(OgmiosKupoBackend("ws://ogmios-url:port", "http://kupo-url:port", Network.MAINNET))
-
-backend = get_backend()
-```
-
-The `AbstractBackend` interface offers methods for interacting with the Cardano blockchain, regardless of the underlying data source. This abstraction allows seamless switching between different backends without changing your application code.
-
-To retrieve pool information, use the `pool_selector` method provided by each DEX's state class:
-
-```python
-from charli3_dendrite import VyFiCPPState
-
-selector = VyFiCPPState.pool_selector()
-result = backend.get_pool_utxos(
-    limit=100000,
-    historical=False,
-    **selector.model_dump(),
-)
-```
-To process and parse the retrieved results (`list[PoolStateInfo]`), the following approach can be utilized:
-```python
-pool_data = {}
-total_tvl = 0
-for pool in result:
-    d = dex.model_validate(pool.model_dump())
-    try:
-        logger.info("Get TVL %s", d.tvl)
-        logger.info("Price %s", d.price)
-        logger.info("Token name of asset A: %s", d.unit_a)
-        logger.info("Token name of asset B: %s", d.unit_b)
-    except NoAssetsError:
-        pass
-    except InvalidLPError:
-        pass
-    except InvalidPoolError:
-        pass
-    except Exception as e:
-        logger.debug(f"{dex.__name__}: {e}")
-```
-This approach is applicable across all supported DEXs. For example, the following list of AbstractPoolState subclasses can be defined to support various DEX states:
-```python
-DEXS: list[AbstractPoolState] = [
-    GeniusYieldOrderState,
-    MinswapCPPState,
-    MinswapV2CPPState,
-    MinswapDJEDiUSDStableState,
-    MinswapDJEDUSDCStableState,
-    MinswapDJEDUSDMStableState,
-    MuesliSwapCPPState,
-    SpectrumCPPState,
-    SundaeSwapCPPState,
-    SundaeSwapV3CPPState,
-    VyFiCPPState,
-    WingRidersCPPState,
-    WingRidersSSPState,
-]
-```
-## Development
-To set up the development environment:
-
-1. Clone the repository
-2. Install dependencies: `poetry install`
-3. Set up pre-commit hooks: `pre-commit install`
-
-## Running Tests
-```bash
-poetry run pytest --benchmark-disable -v --slow -n auto
-```
-
-## Contributing
-Contributions to Charli3 Dendrite are welcome! Please refer to the `CONTRIBUTING.md` file for guidelines on how to contribute to the project.
+<div align="center">
+    <h1 align="center">Charli3 Dendrite</h1>
+    <p align="center">Python SDK for interacting with Cardano DEXs</p>
+    <p>
+        <img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python version">
+        <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License">
+        <img src="https://img.shields.io/pypi/dm/charli3-dendrite?style=flat-square" />
+        <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome">
+    </p>
+</div>
+
+## Overview
+
+Charli3 Dendrite is a powerful Python SDK designed for seamless interaction with multiple Decentralized Exchanges (DEXs) on the Cardano blockchain. It provides a unified interface for developers to access various DEX functionalities, simplifying the process of building applications in the Cardano ecosystem.
+
+## Key Features
+
+- 🔄 Multi-DEX Support: Integrate with Minswap, MuesliSwap, Spectrum, SundaeSwap, VyFi, GeniusYield, Axo, and WingRiders
+- 💧 Liquidity Pool Data: Fetch and analyze pool information across different DEXs
+- 💱 Swap Operations: Execute token swaps with ease
+- 🧩 Flexible Asset Handling: Manage various asset types and pool states efficiently
+- 🔗 On-chain Data Integration: Connect with DB-sync, BlockFrost, and Ogmios/Kupo
+- 🛠 Extensible Architecture: Easily add support for new DEXs and features
+
+
+## Installation
+
+```bash
+# Using pip
+pip install charli3_dendrite
+
+# Using Poetry
+poetry add charli3_dendrite
+```
+
+## Supported DEXs
+Charli3 Dendrite currently supports the following Cardano DEXs:
+
+- Minswap
+- MuesliSwap
+- Spectrum
+- SundaeSwap
+- VyFi
+- WingRiders
+- GeniusYield
+- Axo
+
+### Not Yet Implemented
+
+- CardanoSwaps
+- Metadex
+- CSwap
+- TeddySwap
+- Cerra
+- SaturnSwap
+- Splash
+
+Each DEX is implemented as a separate module within the `charli3_dendrite.dexs.amm` package.
+
+## Configuration
+Charli3 Dendrite can be configured using environment variables or a `.env` file. See `sample.env` for an example of the configuration options.
+
+### Backend Configuration
+
+Charli3 Dendrite supports multiple backend options for interacting with the Cardano blockchain:
+
+#### DBSync Configuration
+
+To use a DBSync instance as the blockchain connection, set the following environment variables:
+
+```bash
+DBSYNC_HOST="your-dbsync-host"
+DBSYNC_PORT="your-dbsync-port"
+DBSYNC_DB_NAME="your-dbsync-database-name"
+DBSYNC_USER="your-dbsync-username"
+DBSYNC_PASS="your-dbsync-password"
+```
+
+#### BlockFrost Configuration
+
+To use BlockFrost as the backend, set the following environment variables:
+
+```bash
+BLOCKFROST_PROJECT_ID="your-blockfrost-project-id"
+CARDANO_NETWORK="mainnet"  # or "testnet" for the Cardano testnet
+```
+
+#### Ogmios/Kupo Configuration
+
+To use Ogmios and Kupo as the backend, set the following environment variables:
+
+```bash
+OGMIOS_URL="ws://your-ogmios-url:port"
+KUPO_URL="http://your-kupo-url:port"
+CARDANO_NETWORK="mainnet"  # or "testnet" for the Cardano testnet
+```
+
+The backend will be automatically selected based on the available environment variables. If multiple backend configurations are present, the priority order is: DBSync, BlockFrost, Ogmios/Kupo.
+
+### Backend Limitations
+
+While Charli3 Dendrite supports multiple backends, it's important to note that the BlockFrost and Ogmios/Kupo backends have some limitations compared to the DBSync backend:
+
+- **BlockFrost Backend**: Due to limitations in the BlockFrost API, the following methods are not implemented:
+  - `get_historical_order_utxos`
+  - `get_order_utxos_by_block_or_tx`
+  - `get_cancel_utxos`
+  - `get_axo_target`
+
+- **Ogmios/Kupo Backend**: The Ogmios/Kupo backend also has limitations due to the nature of these services:
+  - `get_historical_order_utxos`
+  - `get_order_utxos_by_block_or_tx`
+  - `get_cancel_utxos`
+
+These methods will raise a `NotImplementedError` when called using the BlockFrost or Ogmios/Kupo backends. If your application requires these functionalities, consider using the DBSync backend.
+
+## Usage
+
+### Retrieving Orders and Pool Data
+
+To retrieve orders and pool data, first configure the global backend:
+
+```python
+from charli3_dendrite.backend import set_backend, get_backend
+from charli3_dendrite.backend.dbsync import DbsyncBackend
+from charli3_dendrite.backend.blockfrost import BlockFrostBackend
+from charli3_dendrite.backend.ogmios_kupo import OgmiosKupoBackend
+from pycardano import Network
+
+# Choose one of the following backends:
+# set_backend(DbsyncBackend())
+# set_backend(BlockFrostBackend("your-project-id"))
+set_backend(OgmiosKupoBackend("ws://ogmios-url:port", "http://kupo-url:port", Network.MAINNET))
+
+backend = get_backend()
+```
+
+The `AbstractBackend` interface offers methods for interacting with the Cardano blockchain, regardless of the underlying data source. This abstraction allows seamless switching between different backends without changing your application code.
+
+To retrieve pool information, use the `pool_selector` method provided by each DEX's state class:
+
+```python
+from charli3_dendrite import VyFiCPPState
+
+selector = VyFiCPPState.pool_selector()
+result = backend.get_pool_utxos(
+    limit=100000,
+    historical=False,
+    **selector.model_dump(),
+)
+```
+To process and parse the retrieved results (`list[PoolStateInfo]`), the following approach can be utilized:
+```python
+pool_data = {}
+total_tvl = 0
+for pool in result:
+    d = dex.model_validate(pool.model_dump())
+    try:
+        logger.info("Get TVL %s", d.tvl)
+        logger.info("Price %s", d.price)
+        logger.info("Token name of asset A: %s", d.unit_a)
+        logger.info("Token name of asset B: %s", d.unit_b)
+    except NoAssetsError:
+        pass
+    except InvalidLPError:
+        pass
+    except InvalidPoolError:
+        pass
+    except Exception as e:
+        logger.debug(f"{dex.__name__}: {e}")
+```
+This approach is applicable across all supported DEXs. For example, the following list of AbstractPoolState subclasses can be defined to support various DEX states:
+```python
+DEXS: list[AbstractPoolState] = [
+    GeniusYieldOrderState,
+    MinswapCPPState,
+    MinswapV2CPPState,
+    MinswapDJEDiUSDStableState,
+    MinswapDJEDUSDCStableState,
+    MinswapDJEDUSDMStableState,
+    MuesliSwapCPPState,
+    SpectrumCPPState,
+    SundaeSwapCPPState,
+    SundaeSwapV3CPPState,
+    VyFiCPPState,
+    WingRidersCPPState,
+    WingRidersSSPState,
+]
+```
+## Development
+To set up the development environment:
+
+1. Clone the repository
+2. Install dependencies: `poetry install`
+3. Set up pre-commit hooks: `pre-commit install`
+
+## Running Tests
+```bash
+poetry run pytest --benchmark-disable -v --slow -n auto
+```
+
+## Contributing
+Contributions to Charli3 Dendrite are welcome! Please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute to the project.

{charli3_dendrite-1.1.1.dev7 → charli3_dendrite-1.1.1.dev12}/pyproject.toml

@@ -1,51 +1,83 @@
-[tool.poetry]
-name = "charli3_dendrite"
-version = "1.1.1-dev7"
-description = ""
-authors = ["Elder Millenial <eldermillenial@protonmail.com>"]
-readme = "README.md"
-packages = [{ include = "charli3_dendrite", from = "src" }]
-
-[tool.poetry.dependencies]
-python = "^3.10"
-requests = "^2.31.0"
-pydantic = "^2.5.2"
-psycopg = { extras = ["binary", "pool"], version = "^3.1.13" }
-python-dotenv = "0.21.1"
-pycardano = "0.11.1"
-blockfrost-python = "^0.6.0"
-
-
-[tool.poetry.group.dev.dependencies]
-black = "^23.11.0"
-ruff = "^0.1.6"
-pre-commit = "^3.5.0"
-bump2version = "^1.0.1"
-isort = "^5.13.2"
-flake8 = "^6.1.0"
-mypy = "^1.7.1"
-pytest = "^7.4.3"
-pytest-benchmark = "^4.0.0"
-pytest-dependency = "^0.5.1"
-pytest-xdist = "^3.6.1"
-mkdocs = "^1.6.0"
-mkdocs-material = "^9.5.32"
-mkdocstrings = { extras = ["python"], version = "^0.25.2" }
-
-
-[tool.poetry.group.devs.dependencies]
-pytest-subtests = "^0.11.0"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.isort]
-profile = "black"
-
-[tool.mypy]
-plugins = ["pydantic.mypy"]
-
-[[tool.mypy.overrides]]
-module = ["pycardano", "pycardano.*", "dotenv", "nox"]
-ignore_missing_imports = true
+[tool.poetry]
+name = "charli3_dendrite"
+version = "1.1.1-dev12"
+description = ""
+authors = ["Elder Millenial <eldermillenial@protonmail.com>"]
+readme = "README.md"
+packages = [{ include = "charli3_dendrite", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.31.0"
+pydantic = "^2.5.2"
+psycopg = { extras = ["binary", "pool"], version = "^3.1.13" }
+python-dotenv = "1.0.1"
+pycardano = "0.12.2"
+blockfrost-python = "^0.6.0"
+bump-my-version = "^1.1.4"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.11.0"
+ruff = "^0.1.6"
+pre-commit = "^3.5.0"
+isort = "^5.13.2"
+flake8 = "^6.1.0"
+mypy = "^1.7.1"
+pytest = "^7.4.3"
+pytest-benchmark = "^4.0.0"
+pytest-dependency = "^0.5.1"
+pytest-xdist = "^3.6.1"
+mkdocs = "^1.6.0"
+mkdocs-material = "^9.5.32"
+mkdocstrings = { extras = ["python"], version = "^0.25.2" }
+pytest-subtests = "^0.14.1"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[[tool.mypy.overrides]]
+module = ["pycardano", "pycardano.*", "dotenv", "nox"]
+ignore_missing_imports = true
+
+[tool.bumpversion]
+current_version = "1.1.1-dev12"
+parse = """(?x)
+    (?P<major>\\d+)\\.
+    (?P<minor>\\d+)\\.
+    (?P<patch>\\d+)
+    (\\-(?P<release>[a-z]+)(?P<dev>\\d+))?
+"""
+serialize = [
+	"{major}.{minor}.{patch}-{release}{dev}",
+	"{major}.{minor}.{patch}",
+]
+search = "{current_version}"
+replace = "{new_version}"
+regex = false
+ignore_missing_version = false
+tag = true
+sign_tags = false
+tag_name = "v{new_version}"
+tag_message = "Bump version: {current_version} → {new_version}"
+allow_dirty = false
+commit = true
+message = "Bump version: {current_version} → {new_version}"
+commit_args = "--no-verify"
+
+[tool.bumpversion.parts.release]
+values = ["dev", "release"]
+optional_value = "release"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = "version = \"{current_version}\""
+replace = "version = \"{new_version}\""