solanab-jup-python-sdk 2.0.3__tar.gz

solanab_jup_python_sdk-2.0.3/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run Tests
+        env:
+          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
+        run: uv run pytest --cov=jup_python_sdk
+
+      - name: Run Linting
+        run: |
+          uv run ruff check .
+          uv run ruff format --check .

solanab_jup_python_sdk-2.0.3/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      
+      - name: Set up Python
+        run: uv python install 3.12
+      
+      - name: Build package
+        run: uv build
+      
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

solanab_jup_python_sdk-2.0.3/.gitignore

@@ -0,0 +1,77 @@
+# Python artifacts
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+pip-wheel-metadata/
+poetry.lock
+Pipfile
+Pipfile.lock
+
+# Build and distribution
+build/
+dist/
+*.egg-info/
+*.egg
+*.manifest
+*.spec
+
+# Hatch, Poetry & Setuptools artifacts
+*.whl
+*.tar.gz
+*.log
+.cache/
+.hatch/
+
+# IDE / Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*.swn
+
+# Testing & Coverage
+.tox/
+.nox/
+.coverage
+coverage.xml
+*.cover
+htmlcov/
+.pytest_cache/
+pytest_cache/
+
+# Jupyter Notebook checkpoints
+.ipynb_checkpoints/
+
+# macOS & Windows
+.DS_Store
+Thumbs.db
+
+# Git metadata (if using submodules)
+.gitmodules
+
+# Pyright or MyPy type-checking cache
+.pyright/
+.mypy_cache/
+
+# Generated Docs (if using Sphinx)
+docs/_build/
+
+# Ignore environment variables (if using dotenv)
+.env
+.env.*
+
+# UV specific
+# uv.lock  # Keep lock file for reproducible builds
+.python-version
+
+# Temporary test files
+test_*.py
+generate_*.py
+
+# Flake8 config
+.flake8

solanab_jup_python_sdk-2.0.3/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+        args: ["--line-length=88"]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 6.0.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+        args: ["--max-line-length=88"]

solanab_jup_python_sdk-2.0.3/LICENSE

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

solanab_jup_python_sdk-2.0.3/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: solanab-jup-python-sdk
+Version: 2.0.3
+Summary: High-performance sync/async Python SDK for Jupiter Exchange APIs, powered by curl_cffi.
+Project-URL: homepage, https://github.com/solanab/jup-python-sdk
+Project-URL: repository, https://github.com/solanab/jup-python-sdk
+Author-email: Fiji <charismoutafidis@gmail.com>, solanab <whiredj@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: jupiter,sdk,solana
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: base58>=2.1.1
+Requires-Dist: curl-cffi>=0.12
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: solana>=0.36.6
+Requires-Dist: solders>=0.26.0
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7; extra == 'dev'
+Requires-Dist: black>=25.1.0; extra == 'dev'
+Requires-Dist: flake8>=7.1.1; extra == 'dev'
+Requires-Dist: isort>=6.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.15.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.7; extra == 'dev'
+Requires-Dist: pytest-cov>=6.1.1; extra == 'dev'
+Requires-Dist: pytest>=8.3.4; extra == 'dev'
+Requires-Dist: python-dotenv>=1.1.0; extra == 'dev'
+Requires-Dist: responses>=0.25.6; extra == 'dev'
+Requires-Dist: safety>=2.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# **Jup Python SDK**
+
+A high-performance, async-first Python SDK for seamless interaction with the Jupiter Ultra API, powered by `curl_cffi` for maximum speed and flexibility.<br>
+With Ultra API, you don't need to manage or connect to any RPC endpoints, or deal with complex configurations.<br>
+Everything from getting quotes to transaction execution happens directly through a powerful API.<br>
+
+Or as we like to say around here:<br>
+**"RPCs are for NPCs."**
+
+For a deeper understanding of the Ultra API, including its features and benefits, check out the [Ultra API Docs](https://dev.jup.ag/docs/ultra-api/).
+
+## **Installation**
+
+To install the SDK in your project, run:
+```sh
+pip install jup-python-sdk
+```
+
+## **Quick Start (Async)**
+
+Below is a simple asynchronous example to fetch and execute an Ultra order.
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+from jup_python_sdk.models.ultra_api.ultra_order_request_model import UltraOrderRequest
+
+async def main():
+   load_dotenv()
+   # Note: For async client, methods are awaited.
+   client = AsyncUltraApiClient()
+
+   order_request = UltraOrderRequest(
+      input_mint="So11111111111111111111111111111111111111112",  # WSOL
+      output_mint="EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",  # USDC
+      amount=10000000,  # 0.01 WSOL
+      taker=await client.get_public_key(),
+   )
+
+   try:
+      client_response = await client.order_and_execute(order_request)
+      signature = str(client_response["signature"])
+
+      print("Order and Execute API Response:")
+      print(f"  - Status: {client_response.get('status')}")
+      if client_response.get("status") == "Failed":
+         print(f"  - Code: {client_response.get('code')}")
+         print(f"  - Error: {client_response.get('error')}")
+
+      print(f"  - Transaction Signature: {signature}")
+      print(f"  - View on Solscan: https://solscan.io/tx/{signature}")
+
+   except Exception as e:
+      print("Error occurred while processing the swap:", str(e))
+   finally:
+      await client.close()
+
+if __name__ == "__main__":
+   asyncio.run(main())
+```
+
+> **Note**: A synchronous client (`UltraApiClient`) is also available. See the [examples](./examples) folder for both sync and async usage.
+
+## **Setup Instructions**
+
+Before using the SDK, please ensure you have completed the following steps:
+
+1. **Environment Variables**:  
+   Set up your required environment variables.  
+   The SDK supports both base58 string and uint8 array formats for your private key.
+   ```sh
+   # Base58 format
+   export PRIVATE_KEY=your_base58_private_key_here
+
+   # OR as a uint8 array
+   export PRIVATE_KEY=[10,229,131,132,213,96,74,22,...]
+   ```
+   
+> **Note**: `PRIVATE_KEY` can be either a base58-encoded string (default Solana format), or a uint8 array (e.g. `[181,99,240,...]`). The SDK will automatically detect and parse the format.
+
+2. **Optional Configuration**:  
+   Depending on your credentials and setup, you have a couple of options for initializing the `UltraApiClient`:
+   - **API Key**: Use an API key from [the Jupiter Portal](https://portal.jup.ag/onboard) for enhanced access. This will use the `https://api.jup.ag/` endpoint.
+   - **Custom Private Key Env Var**: Specify a different environment variable name for your private key.
+
+    ```python
+    from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+    client = AsyncUltraApiClient(
+        api_key="YOUR_API_KEY",
+        private_key_env_var="YOUR_CUSTOM_ENV_VAR"
+    )
+    ```
+
+## **Advanced Configuration (Proxies, Custom DNS)**
+
+The SDK is built on `curl_cffi`, allowing you to pass any valid `curl_cffi` client parameter during initialization for advanced network control.
+
+### Using a SOCKS5 Proxy
+
+```python
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+proxies = {"httpss": "socks5://user:pass@host:port"}
+client = AsyncUltraApiClient(client_kwargs={"proxies": proxies, "impersonate": "chrome110"})
+```
+
+### Using Custom DNS Resolution
+
+This is useful for bypassing local DNS caches or using a specialized DNS resolver.
+
+```python
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+# Tell the client to resolve jup.ag to a specific IP address
+resolve_string = "jup.ag:443:1.2.3.4"
+client = AsyncUltraApiClient(client_kwargs={"resolve": [resolve_string]})
+```
+
+## **Disclaimer**
+
+🚨 **This project is actively worked on.**  
+While we don't expect breaking changes as the SDK evolves, we recommend you stay updated with the latest releases.  
+Any important updates will be announced in the [Discord server](https://discord.gg/jup).

solanab_jup_python_sdk-2.0.3/README-dev.md

@@ -0,0 +1,16 @@
+## **Local Development**
+If you want to make changes to the SDK and test it locally:
+
+1. In this project's directory, install the package in editable mode by running:
+   ```sh
+   pip install -e .
+   ```
+
+2. To use this library in another project while making changes to it, install the package from its local path in that project:
+   ```sh
+   pip install -e /path/to/jup-python-sdk
+   ```
+
+   Replace `/path/to/jup-python-sdk` with the absolute or relative path to this project directory.
+
+By installing in editable mode, any changes you make to the SDK will immediately reflect in your tests without needing to reinstall the package.

solanab_jup_python_sdk-2.0.3/README-release.md

@@ -0,0 +1,30 @@
+## **Making a New Release**
+To create and publish a new release of the package to PyPI:
+
+1. **Update the Version:**
+   - Update the version in your `pyproject.toml` file following [semantic versioning](https://semver.org/), e.g., `0.0.1` → `0.1.0` for a minor update.
+
+2. **Commit the Changes:**
+   - Commit and push the version update to the main branch:
+     ```sh
+     git add pyproject.toml
+     git commit -m "Bump version to vX.Y.Z"
+     git push origin main
+     ```
+
+3. **Create a Tag:**
+   - Tag the commit with the new version:
+     ```sh
+     git tag vX.Y.Z
+     git push origin vX.Y.Z
+     ```
+
+   Replace `vX.Y.Z` with the actual version number.
+
+4. **GitHub Actions Workflow:**
+   - When the tag is pushed, the `release.yml` GitHub Actions workflow will automatically:
+      - Build the package using Poetry.
+      - Publish the package to PyPI.
+
+5. **Confirm the Release:**
+   - Check [PyPI](https://pypi.org/project/jup-python-sdk/) to ensure the new version has been published successfully.

solanab_jup_python_sdk-2.0.3/README.md

@@ -0,0 +1,125 @@
+# **Jup Python SDK**
+
+A high-performance, async-first Python SDK for seamless interaction with the Jupiter Ultra API, powered by `curl_cffi` for maximum speed and flexibility.<br>
+With Ultra API, you don't need to manage or connect to any RPC endpoints, or deal with complex configurations.<br>
+Everything from getting quotes to transaction execution happens directly through a powerful API.<br>
+
+Or as we like to say around here:<br>
+**"RPCs are for NPCs."**
+
+For a deeper understanding of the Ultra API, including its features and benefits, check out the [Ultra API Docs](https://dev.jup.ag/docs/ultra-api/).
+
+## **Installation**
+
+To install the SDK in your project, run:
+```sh
+pip install jup-python-sdk
+```
+
+## **Quick Start (Async)**
+
+Below is a simple asynchronous example to fetch and execute an Ultra order.
+
+```python
+import asyncio
+from dotenv import load_dotenv
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+from jup_python_sdk.models.ultra_api.ultra_order_request_model import UltraOrderRequest
+
+async def main():
+   load_dotenv()
+   # Note: For async client, methods are awaited.
+   client = AsyncUltraApiClient()
+
+   order_request = UltraOrderRequest(
+      input_mint="So11111111111111111111111111111111111111112",  # WSOL
+      output_mint="EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",  # USDC
+      amount=10000000,  # 0.01 WSOL
+      taker=await client.get_public_key(),
+   )
+
+   try:
+      client_response = await client.order_and_execute(order_request)
+      signature = str(client_response["signature"])
+
+      print("Order and Execute API Response:")
+      print(f"  - Status: {client_response.get('status')}")
+      if client_response.get("status") == "Failed":
+         print(f"  - Code: {client_response.get('code')}")
+         print(f"  - Error: {client_response.get('error')}")
+
+      print(f"  - Transaction Signature: {signature}")
+      print(f"  - View on Solscan: https://solscan.io/tx/{signature}")
+
+   except Exception as e:
+      print("Error occurred while processing the swap:", str(e))
+   finally:
+      await client.close()
+
+if __name__ == "__main__":
+   asyncio.run(main())
+```
+
+> **Note**: A synchronous client (`UltraApiClient`) is also available. See the [examples](./examples) folder for both sync and async usage.
+
+## **Setup Instructions**
+
+Before using the SDK, please ensure you have completed the following steps:
+
+1. **Environment Variables**:  
+   Set up your required environment variables.  
+   The SDK supports both base58 string and uint8 array formats for your private key.
+   ```sh
+   # Base58 format
+   export PRIVATE_KEY=your_base58_private_key_here
+
+   # OR as a uint8 array
+   export PRIVATE_KEY=[10,229,131,132,213,96,74,22,...]
+   ```
+   
+> **Note**: `PRIVATE_KEY` can be either a base58-encoded string (default Solana format), or a uint8 array (e.g. `[181,99,240,...]`). The SDK will automatically detect and parse the format.
+
+2. **Optional Configuration**:  
+   Depending on your credentials and setup, you have a couple of options for initializing the `UltraApiClient`:
+   - **API Key**: Use an API key from [the Jupiter Portal](https://portal.jup.ag/onboard) for enhanced access. This will use the `https://api.jup.ag/` endpoint.
+   - **Custom Private Key Env Var**: Specify a different environment variable name for your private key.
+
+    ```python
+    from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+    client = AsyncUltraApiClient(
+        api_key="YOUR_API_KEY",
+        private_key_env_var="YOUR_CUSTOM_ENV_VAR"
+    )
+    ```
+
+## **Advanced Configuration (Proxies, Custom DNS)**
+
+The SDK is built on `curl_cffi`, allowing you to pass any valid `curl_cffi` client parameter during initialization for advanced network control.
+
+### Using a SOCKS5 Proxy
+
+```python
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+proxies = {"httpss": "socks5://user:pass@host:port"}
+client = AsyncUltraApiClient(client_kwargs={"proxies": proxies, "impersonate": "chrome110"})
+```
+
+### Using Custom DNS Resolution
+
+This is useful for bypassing local DNS caches or using a specialized DNS resolver.
+
+```python
+from jup_python_sdk.clients.ultra_api_client import AsyncUltraApiClient
+
+# Tell the client to resolve jup.ag to a specific IP address
+resolve_string = "jup.ag:443:1.2.3.4"
+client = AsyncUltraApiClient(client_kwargs={"resolve": [resolve_string]})
+```
+
+## **Disclaimer**
+
+🚨 **This project is actively worked on.**  
+While we don't expect breaking changes as the SDK evolves, we recommend you stay updated with the latest releases.  
+Any important updates will be announced in the [Discord server](https://discord.gg/jup).

solanab_jup_python_sdk-2.0.3/check_code.sh

@@ -0,0 +1,5 @@
+black jup_python_sdk tests --line-length 79
+isort jup_python_sdk tests
+flake8 jup_python_sdk tests
+mypy jup_python_sdk tests
+pytest