tpluspy 0.1.0a0__tar.gz

tpluspy-0.1.0a0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade setuptools wheel
+          python setup.py sdist bdist_wheel
+
+      - name: Publish to GitHub Packages
+        run: |
+          python -m pip install --upgrade twine
+          twine upload --repository-url https://upload.pypi.github.com/ dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.GITHUB_TOKEN }}

tpluspy-0.1.0a0/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: tpluspy tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["**"]
+
+concurrency:
+  # Cancel older, in-progress jobs from the same PR, same workflow.
+  # use run_id if the job is triggered by a push to ensure
+  # push-triggered jobs to not get canceled.
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+            python-version: "3.10"
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[lint,test]
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Format
+        run: ruff format --check .
+
+# TODO: Handle type checking issues
+#      - name: Type Check
+#        run: mypy .
+
+      - name: Client Tests
+        run: pytest tests --ignore=tests/evm
+
+# TODO: Uncomment when/if this actually matters (dependency-heavy)
+#      - name: EVM Tests
+#        run: pytest tests/evm

tpluspy-0.1.0a0/.gitignore

@@ -0,0 +1,183 @@
+# Ape
+.build
+
+# Editor
+.idea
+
+# Setuptools SCM
+tplus/version.py
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

tpluspy-0.1.0a0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: check-yaml
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.7
+    hooks:
+    -   id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+    -   id: ruff-format
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+    -   id: mypy
+
+default_language_version:
+    python: python3

tpluspy-0.1.0a0/PKG-INFO

@@ -0,0 +1,266 @@
+Metadata-Version: 2.1
+Name: tpluspy
+Version: 0.1.0a0
+Summary: tpluspy: Client utilities for interacting with tplus
+Home-page: https://github.com/tpluslabs/tpluspy
+Author: TPlus Labs
+Author-email: admin@tlus.cx
+License: Apache-2.0
+Keywords: ethereum
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+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-Python: >=3.10,<4
+Description-Content-Type: text/markdown
+Requires-Dist: cryptography>=44.0.1
+Requires-Dist: ecdsa>=0.17
+Requires-Dist: httpx>=0.20
+Requires-Dist: pycryptodome>=3.17.1
+Requires-Dist: pydantic<3,>=2.10.4
+Requires-Dist: websockets<14,>=13.1
+Requires-Dist: eth-pydantic-types<0.3,>=0.2.2
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-timeout<3,>=2.2.0; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Provides-Extra: lint
+Requires-Dist: mypy<2,>=1.15.0; extra == "lint"
+Requires-Dist: ruff>=0.11.7; extra == "lint"
+Requires-Dist: mypy<2,>=1.15.0; extra == "lint"
+Provides-Extra: release
+Requires-Dist: setuptools>=75.6.0; extra == "release"
+Requires-Dist: wheel; extra == "release"
+Requires-Dist: twine; extra == "release"
+Provides-Extra: evm
+Requires-Dist: ape-tokens; extra == "evm"
+Requires-Dist: click; extra == "evm"
+Requires-Dist: eip712; extra == "evm"
+Requires-Dist: eth-ape<0.9,>=0.8.32; extra == "evm"
+
+# TPlus Python Client Utilities
+
+Python clients for interacting with tplus.
+
+## Install
+
+To install, use either `pip` or `uv pip`:
+
+```shell
+uv pip install -e .
+```
+
+## Usage Example
+
+### REST and WebSocket Client (`tplus.client`)
+
+The `tpluspy` library also provides an asynchronous client (`OrderBookClient`) for interacting with the `tplus-core` REST API and WebSocket streams.
+
+#### Initialization
+
+To use the client, first initialize it with a `User` object (for signing requests) and the base URL of your `tplus-core` instance:
+
+```python
+import asyncio
+from tplus.client import OrderBookClient
+from tplus.utils.user import User
+
+API_BASE_URL = "http://127.0.0.1:8000"  # Replace with your API URL
+user = User()
+
+async def run_client():
+    # Use async context manager for automatic cleanup
+    async with OrderBookClient(user=user, base_url=API_BASE_URL) as client:
+        print("Client initialized.")
+        # ... use client methods ...
+
+asyncio.run(run_client())
+```
+
+#### REST API Usage
+
+The client offers async methods for common REST endpoints:
+
+**Fetching Data:**
+
+```python
+# Get Order Book Snapshot for asset index 200
+from tplus.model.asset_identifier import AssetIdentifier
+
+example_asset = AssetIdentifier(Index=200)
+orderbook = await client.get_orderbook_snapshot(example_asset)
+print(f"Snapshot Sequence: {orderbook.sequence_number}")
+
+# Get Klines for an asset
+klines = await client.get_klines(example_asset)
+print(f"Klines: {klines}")
+
+# Get Market Details for an asset
+market_details = await client.get_market(example_asset)
+print(f"Market Details: Price Decimals={market_details.book_price_decimals}, Quantity Decimals={market_details.book_quantity_decimals}")
+
+# Get orders for the user
+user_orders, _ = await client.get_user_orders()
+print(f"User Orders: {user_orders}")
+
+# Get trades for the user and asset
+user_asset_trades = await client.get_user_trades_for_asset(example_asset)
+print(f"User Asset Trades: {user_asset_trades}")
+
+# Get user inventory
+inventory = await client.get_user_inventory()
+print(f"Inventory: {inventory}")
+```
+
+**Creating Orders:**
+
+```python
+# Ensure example_asset is defined (e.g., from "Fetching Data" section)
+from tplus.model.asset_identifier import AssetIdentifier
+example_asset = AssetIdentifier(200)
+
+# Create a Market for an asset (idempotent)
+market_creation_response = await client.create_market(asset_id=example_asset)
+print(f"Market Creation Response: {market_creation_response}")
+
+# Create a Market Order for a specific asset
+market_response = await client.create_market_order(
+    asset_id=example_asset,
+    quantity=10,  # integer quantity
+    side="Buy",
+    fill_or_kill=False,
+)
+print(f"Market Order Response: {market_response}")
+
+# Create a Limit Order for a specific asset
+# Good-Till-Cancelled limit order
+from tplus.model.limit_order import GTC
+limit_response = await client.create_limit_order(
+    asset_id=example_asset,
+    quantity=5,
+    price=1_000,
+    side="Sell",
+    time_in_force=GTC(),
+)
+print(f"Limit Order Response: {limit_response}")
+
+# Cancel an Order
+# Order ID should be obtained from an order creation response.
+order_id_to_cancel = "actual-order-id-from-api"  # Replace with a real order ID
+cancel_response = await client.cancel_order(
+    order_id=order_id_to_cancel,
+    asset_id=example_asset
+)
+print(f"Cancel Order Response: {cancel_response}")
+
+# Replace an Order
+# Original Order ID should be from an existing, open order.
+original_order_id_to_replace = "actual-original-order-id"  # Replace with a real order ID
+replace_response = await client.replace_order(
+    original_order_id=original_order_id_to_replace,
+    asset_id=example_asset,
+    new_quantity=6, # Optional: New integer quantity
+    new_price=1050   # Optional: New integer price
+)
+print(f"Replace Order Response: {replace_response}")
+```
+
+See `examples/rest_usage.py` for a runnable demonstration.
+
+#### WebSocket Streaming
+
+The client provides async iterators to stream real-time data:
+
+```python
+from tplus.model.asset_identifier import AssetIdentifier
+from tplus.model.orderbook import OrderBookDiff
+from tplus.model.trades import Trade
+
+example_asset = AssetIdentifier(200)
+
+# Stream Order Book Diffs
+async for diff_update in client.stream_depth(example_asset):
+    if isinstance(diff_update, OrderBookDiff):
+        print(f"[Depth] Seq={diff_update.sequence_number}, Asks={len(diff_update.asks)}, Bids={len(diff_update.bids)}")
+    # Add logic to handle the update, e.g., update a local order book
+
+# Stream Finalized Trades
+async for trade in client.stream_finalized_trades():
+     if isinstance(trade, Trade):
+        print(f"[Trade] ID: {trade.trade_id}, Price: {trade.price}, Qty: {trade.quantity}")
+    # Add logic to handle the trade
+
+# Other available streams:
+# client.stream_orders() -> OrderEvent
+# client.stream_all_trades() -> TradeEvent
+# client.stream_klines(asset_id) -> KlineUpdate
+```
+
+See `examples/websocket_usage.py` for a runnable demonstration using `asyncio.gather` to run multiple streams concurrently.
+
+### Contracts
+
+To interact with the contracts or sign T+ specific EIP-712 messages, ensure you have installed the `evm` extra:
+
+```shell
+pip install tpluspy[evm]
+```
+
+Use the `tplusp.contracts` module to read data from t+ contracts.
+For example, launch a Sepolia-connected Ape console:
+
+```shell
+ape console --network ethereum:sepolia:alchemy
+```
+
+**Note**: You can use any provider you want or a RPC directly, it doesn't have to be Alchemy.
+
+Then, once in the console, you will already have access to contracts that you can call methods on:
+
+```python
+In [1]: registry.getAssets()
+Out[1]: [getAssets_return(assetAddress=HexBytes('0x000000000000000000000000f08a50178dfcde18524640ea6618a1f965821715'), chainId=11155111, maxDeposits=100)]
+In [2]: registry.admin()
+Out[2]: '0x467a95fC5359edE5d5dDc4f10A1F4B680694858E'
+```
+
+#### EIP-712
+
+Sign EIP-712 messages, such as settlements, using the `eip712` library.
+
+```python
+from ape import accounts, convert, chain
+from tplus.evm.eip712 import Order
+from tplus.evm.contracts import vault
+from tplus.utils.user import UserManager
+
+# Load your Ethereum account for t+.
+tplus_user = accounts.load("tplus-account")
+
+# Load your t+ user (public key).
+user_id = UserManager.load("my_user").public_key
+
+# Get the nonce from t+ or the contracts directly.
+nonce = vault.getDepositNonce(tplus_user)
+
+order = Order(
+    tokenOut="0x62622E77D1349Face943C6e7D5c01C61465FE1dc",
+    amountOut=convert("1 ether", int),
+    tokenIn="0x58372ab62269A52fA636aD7F200d93999595DCAF",
+    amountIn=convert("1 ether", int),
+    userId=user_id,
+    nonce=nonce,
+    validUntil=chain.pending_timestamp,
+)
+
+# Use this signature for the settlement.
+signature = tplus_user.sign_message(order).encode_rsv()
+print(signature)
+```