lifi-py 0.1.0__tar.gz

lifi_py-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint-type:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e '.[dev,exec]'
+      - name: ruff
+        run: ruff check .
+      - name: mypy --strict
+        run: mypy
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e '.[dev]'
+      - name: pytest
+        run: pytest -v

lifi_py-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

lifi_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Ruben
+
+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.

lifi_py-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: lifi-py
+Version: 0.1.0
+Summary: Python client for the LI.FI API: bridge + DEX aggregator for any-to-any cross-chain swaps.
+Project-URL: Homepage, https://github.com/robertruben98/lifi-py
+Project-URL: Documentation, https://docs.li.fi/api-reference/introduction
+Project-URL: Repository, https://github.com/robertruben98/lifi-py
+Project-URL: Issues, https://github.com/robertruben98/lifi-py/issues
+Author: Robert Ruben
+License: MIT
+License-File: LICENSE
+Keywords: bridge,cross-chain,defi,dex,ethereum,li.fi,lifi,web3
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.24
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: respx>=0.20; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: exec
+Requires-Dist: web3>=6.0; extra == 'exec'
+Description-Content-Type: text/markdown
+
+# lifi-py
+
+A typed Python client for the [LI.FI API](https://docs.li.fi/api-reference/introduction)
+— the bridge + DEX aggregator for **any-to-any cross-chain** swaps and bridges
+across 74 chains.
+
+The killer feature: `get_quote()` returns a **ready-to-sign `transactionRequest`**
+directly — one call, no separate assemble step.
+
+- Sync (`LifiClient`) and async (`AsyncLifiClient`) clients on top of `httpx`.
+- All responses parsed into `pydantic` v2 models with full type hints (`py.typed`).
+- Built-in rate-limit awareness: reads the `ratelimit-*` headers, throttles
+  proactively, and retries `429`s with backoff.
+- Optional `web3.py` integration for signing/sending the returned transaction.
+
+## Install
+
+```bash
+pip install lifi-py
+# with web3 signing helpers:
+pip install 'lifi-py[exec]'
+```
+
+## Quickstart — cross-chain quote with a ready-to-sign tx (keyless, <5 lines)
+
+```python
+from lifi_py import LifiClient
+
+quote = LifiClient().get_quote(
+    from_chain=42161, to_chain=8453,                                  # Arbitrum -> Base
+    from_token="0xaf88d065e77c8cC2239327C5EDb3A432268e5831",          # USDC (Arbitrum)
+    to_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",            # USDC (Base)
+    from_amount="1000000", from_address="0x47E2D28169738039755586743E2dfCF3bd643f86",
+)
+print(quote.estimate.to_amount, quote.transaction_request.to)  # ~995000, 0x1231DEB6...
+```
+
+`quote.transaction_request` is an EVM transaction ready to sign and broadcast.
+
+## Signing & sending (optional, `[exec]` extra)
+
+```python
+tx = quote.transaction_request.as_web3_tx()   # hex fields decoded to ints, web3-shaped
+signed = account.sign_transaction({**tx, "nonce": w3.eth.get_transaction_count(account.address)})
+tx_hash = w3.eth.send_raw_transaction(signed.raw_transaction)
+```
+
+## Tracking a bridge to completion
+
+```python
+client = LifiClient()
+status = client.poll_status(tx_hash="0x...", bridge=quote.tool)  # polls until DONE/FAILED
+print(status.status, status.is_done)
+```
+
+`get_status()` does a single check; `poll_status()` polls with exponential backoff
+until the transfer reaches a terminal state (or raises `TimeoutError`).
+
+## Async
+
+```python
+import asyncio
+from lifi_py import AsyncLifiClient
+
+async def main():
+    async with AsyncLifiClient() as client:
+        quote = await client.get_quote(...)
+
+asyncio.run(main())
+```
+
+## Endpoints
+
+| Method | API endpoint |
+| --- | --- |
+| `get_quote(...)` | `GET /quote` — best single-step route + `transactionRequest` |
+| `get_status(...)` / `poll_status(...)` | `GET /status` — track a transfer |
+| `get_routes(...)` | `POST /advanced/routes` — multiple candidate routes |
+| `get_step_transaction(step)` | `POST /advanced/stepTransaction` — calldata for one step |
+| `get_chains()` | `GET /chains` |
+| `get_tokens()` | `GET /tokens` |
+| `get_tools()` | `GET /tools` — bridges + exchanges |
+| `get_connections(...)` | `GET /connections` |
+
+## Authentication & rate limits
+
+An API key is **optional** — every endpoint above works keyless. A key only raises
+your rate limits:
+
+```python
+client = LifiClient(api_key="your-key")                 # sent as `x-lifi-api-key`
+client = LifiClient(api_key="k", api_key_header="x-custom-key")  # configurable header
+client = LifiClient(base_url="https://staging.li.quest/v1")      # configurable base URL
+```
+
+The client reads the API's `ratelimit-limit` / `ratelimit-remaining` / `ratelimit-reset`
+response headers (exposed via `client.rate_limit`). When the quota is exhausted it
+pauses before the next request; on a `429` it retries with backoff respecting the
+reset window, raising `LifiRateLimitError` once retries are exhausted.
+
+## Configuration
+
+| Argument | Default | Description |
+| --- | --- | --- |
+| `api_key` | `None` | Optional; raises rate limits. |
+| `base_url` | `https://li.quest/v1` | API base URL. |
+| `api_key_header` | `x-lifi-api-key` | Header name for the key. |
+| `timeout` | `30.0` | Per-request timeout (seconds). |
+| `max_retries` | `3` | Max `429` retries before raising. |
+| `http_client` | `None` | Inject your own `httpx.Client` / `AsyncClient`. |
+
+## Development
+
+```bash
+pip install -e '.[dev,exec]'
+ruff check .
+mypy
+pytest                 # unit tests (mocked HTTP, no network)
+pytest -m integration  # live smoke tests against the keyless API
+```
+
+## License
+
+MIT

lifi_py-0.1.0/README.md

@@ -0,0 +1,124 @@
+# lifi-py
+
+A typed Python client for the [LI.FI API](https://docs.li.fi/api-reference/introduction)
+— the bridge + DEX aggregator for **any-to-any cross-chain** swaps and bridges
+across 74 chains.
+
+The killer feature: `get_quote()` returns a **ready-to-sign `transactionRequest`**
+directly — one call, no separate assemble step.
+
+- Sync (`LifiClient`) and async (`AsyncLifiClient`) clients on top of `httpx`.
+- All responses parsed into `pydantic` v2 models with full type hints (`py.typed`).
+- Built-in rate-limit awareness: reads the `ratelimit-*` headers, throttles
+  proactively, and retries `429`s with backoff.
+- Optional `web3.py` integration for signing/sending the returned transaction.
+
+## Install
+
+```bash
+pip install lifi-py
+# with web3 signing helpers:
+pip install 'lifi-py[exec]'
+```
+
+## Quickstart — cross-chain quote with a ready-to-sign tx (keyless, <5 lines)
+
+```python
+from lifi_py import LifiClient
+
+quote = LifiClient().get_quote(
+    from_chain=42161, to_chain=8453,                                  # Arbitrum -> Base
+    from_token="0xaf88d065e77c8cC2239327C5EDb3A432268e5831",          # USDC (Arbitrum)
+    to_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",            # USDC (Base)
+    from_amount="1000000", from_address="0x47E2D28169738039755586743E2dfCF3bd643f86",
+)
+print(quote.estimate.to_amount, quote.transaction_request.to)  # ~995000, 0x1231DEB6...
+```
+
+`quote.transaction_request` is an EVM transaction ready to sign and broadcast.
+
+## Signing & sending (optional, `[exec]` extra)
+
+```python
+tx = quote.transaction_request.as_web3_tx()   # hex fields decoded to ints, web3-shaped
+signed = account.sign_transaction({**tx, "nonce": w3.eth.get_transaction_count(account.address)})
+tx_hash = w3.eth.send_raw_transaction(signed.raw_transaction)
+```
+
+## Tracking a bridge to completion
+
+```python
+client = LifiClient()
+status = client.poll_status(tx_hash="0x...", bridge=quote.tool)  # polls until DONE/FAILED
+print(status.status, status.is_done)
+```
+
+`get_status()` does a single check; `poll_status()` polls with exponential backoff
+until the transfer reaches a terminal state (or raises `TimeoutError`).
+
+## Async
+
+```python
+import asyncio
+from lifi_py import AsyncLifiClient
+
+async def main():
+    async with AsyncLifiClient() as client:
+        quote = await client.get_quote(...)
+
+asyncio.run(main())
+```
+
+## Endpoints
+
+| Method | API endpoint |
+| --- | --- |
+| `get_quote(...)` | `GET /quote` — best single-step route + `transactionRequest` |
+| `get_status(...)` / `poll_status(...)` | `GET /status` — track a transfer |
+| `get_routes(...)` | `POST /advanced/routes` — multiple candidate routes |
+| `get_step_transaction(step)` | `POST /advanced/stepTransaction` — calldata for one step |
+| `get_chains()` | `GET /chains` |
+| `get_tokens()` | `GET /tokens` |
+| `get_tools()` | `GET /tools` — bridges + exchanges |
+| `get_connections(...)` | `GET /connections` |
+
+## Authentication & rate limits
+
+An API key is **optional** — every endpoint above works keyless. A key only raises
+your rate limits:
+
+```python
+client = LifiClient(api_key="your-key")                 # sent as `x-lifi-api-key`
+client = LifiClient(api_key="k", api_key_header="x-custom-key")  # configurable header
+client = LifiClient(base_url="https://staging.li.quest/v1")      # configurable base URL
+```
+
+The client reads the API's `ratelimit-limit` / `ratelimit-remaining` / `ratelimit-reset`
+response headers (exposed via `client.rate_limit`). When the quota is exhausted it
+pauses before the next request; on a `429` it retries with backoff respecting the
+reset window, raising `LifiRateLimitError` once retries are exhausted.
+
+## Configuration
+
+| Argument | Default | Description |
+| --- | --- | --- |
+| `api_key` | `None` | Optional; raises rate limits. |
+| `base_url` | `https://li.quest/v1` | API base URL. |
+| `api_key_header` | `x-lifi-api-key` | Header name for the key. |
+| `timeout` | `30.0` | Per-request timeout (seconds). |
+| `max_retries` | `3` | Max `429` retries before raising. |
+| `http_client` | `None` | Inject your own `httpx.Client` / `AsyncClient`. |
+
+## Development
+
+```bash
+pip install -e '.[dev,exec]'
+ruff check .
+mypy
+pytest                 # unit tests (mocked HTTP, no network)
+pytest -m integration  # live smoke tests against the keyless API
+```
+
+## License
+
+MIT

lifi_py-0.1.0/examples/async_quote.py

@@ -0,0 +1,29 @@
+"""Async variant: fetch a keyless cross-chain quote with AsyncLifiClient.
+
+Run:  python examples/async_quote.py
+"""
+
+from __future__ import annotations
+
+import asyncio
+
+from lifi_py import AsyncLifiClient
+
+
+async def main() -> None:
+    async with AsyncLifiClient() as client:
+        quote = await client.get_quote(
+            from_chain=42161,  # Arbitrum
+            to_chain=8453,  # Base
+            from_token="0xaf88d065e77c8cC2239327C5EDb3A432268e5831",  # USDC
+            to_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",  # USDC
+            from_amount="1000000",
+            from_address="0x47E2D28169738039755586743E2dfCF3bd643f86",
+        )
+        print(f"{quote.tool}: receive {quote.estimate.to_amount} USDC on Base")
+        assert quote.transaction_request is not None
+        print(f"tx to: {quote.transaction_request.to}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

lifi_py-0.1.0/examples/quote_and_status.py

@@ -0,0 +1,63 @@
+"""Reproduce the validated flow: a keyless cross-chain quote, then status polling.
+
+Quotes 1 USDC from Arbitrum -> Base. The quote includes a ready-to-sign
+``transactionRequest``; once you sign and broadcast it, feed the resulting tx
+hash to ``poll_status`` to track the bridge to completion.
+
+Run:  python examples/quote_and_status.py
+"""
+
+from __future__ import annotations
+
+from lifi_py import LifiClient
+
+# Chain ids and token addresses for the validated example.
+ARBITRUM = 42161
+BASE = 8453
+USDC_ARBITRUM = "0xaf88d065e77c8cC2239327C5EDb3A432268e5831"
+USDC_BASE = "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
+WALLET = "0x47E2D28169738039755586743E2dfCF3bd643f86"
+
+
+def main() -> None:
+    # No API key needed — keyless quotes work out of the box.
+    with LifiClient() as client:
+        quote = client.get_quote(
+            from_chain=ARBITRUM,
+            to_chain=BASE,
+            from_token=USDC_ARBITRUM,
+            to_token=USDC_BASE,
+            from_amount="1000000",  # 1 USDC (6 decimals)
+            from_address=WALLET,
+        )
+
+        print(f"Best tool:   {quote.tool}")
+        print(f"You receive: {quote.estimate.to_amount} (min {quote.estimate.to_amount_min})")
+        print(f"Duration:    ~{quote.estimate.execution_duration}s")
+
+        tx = quote.transaction_request
+        assert tx is not None
+        print("\nReady-to-sign transaction:")
+        print(f"  to:      {tx.to}")
+        print(f"  chainId: {tx.chain_id}")
+        print(f"  value:   {tx.value}")
+        print(f"  data:    {tx.data[:42] if tx.data else None}...")
+
+        # For signing with web3.py (extra: pip install 'lifi-py[exec]'):
+        #   web3_tx = tx.as_web3_tx()
+        #   signed = account.sign_transaction(web3_tx)
+        #   tx_hash = w3.eth.send_raw_transaction(signed.raw_transaction)
+        #
+        # Then track the bridge until it completes on the destination chain:
+        #   final = client.poll_status(tx_hash=tx_hash.hex(), bridge=quote.tool)
+        #   print(final.status)  # DONE / FAILED
+
+        if client.rate_limit is not None:
+            print(
+                f"\nRate limit: {client.rate_limit.remaining}/{client.rate_limit.limit} "
+                f"remaining (resets in {client.rate_limit.reset}s)"
+            )
+
+
+if __name__ == "__main__":
+    main()