decibel-python-sdk 0.1.0__py3-none-any.whl

decibel/write/_types.py

@@ -0,0 +1,190 @@
+from __future__ import annotations
+
+from enum import IntEnum
+from typing import TYPE_CHECKING, NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    from aptos_sdk.account import Account
+
+__all__ = [
+    "TimeInForce",
+    "PlaceOrderArgs",
+    "PlaceTwapOrderArgs",
+    "CancelOrderArgs",
+    "CancelClientOrderArgs",
+    "CancelTwapOrderArgs",
+    "ConfigureUserSettingsArgs",
+    "DelegateTradingArgs",
+    "RevokeDelegationArgs",
+    "PlaceTpSlOrderArgs",
+    "UpdateTpOrderArgs",
+    "UpdateSlOrderArgs",
+    "CancelTpSlOrderArgs",
+    "ApproveBuilderFeeArgs",
+    "RevokeBuilderFeeArgs",
+    "DeactivateSubaccountArgs",
+    "DelegateDexActionsArgs",
+    "PlaceBulkOrdersArgs",
+    "CancelBulkOrderArgs",
+]
+
+
+class TimeInForce(IntEnum):
+    GoodTillCanceled = 0
+    PostOnly = 1
+    ImmediateOrCancel = 2
+
+
+class PlaceOrderArgs(TypedDict, total=False):
+    market_name: str
+    price: float
+    size: float
+    is_buy: bool
+    time_in_force: TimeInForce
+    is_reduce_only: bool
+    client_order_id: str | None
+    stop_price: float | None
+    tp_trigger_price: float | None
+    tp_limit_price: float | None
+    sl_trigger_price: float | None
+    sl_limit_price: float | None
+    builder_addr: str | None
+    builder_fee: float | None
+    subaccount_addr: str | None
+    account_override: Account | None
+    tick_size: float | None
+
+
+class PlaceTwapOrderArgs(TypedDict, total=False):
+    market_name: str
+    size: float
+    is_buy: bool
+    is_reduce_only: bool
+    client_order_id: str | None
+    twap_frequency_seconds: int
+    twap_duration_seconds: int
+    builder_address: str | None
+    builder_fees: float | None
+    subaccount_addr: str | None
+    account_override: Account | None
+
+
+class CancelOrderArgs(TypedDict, total=False):
+    order_id: int | str
+    market_name: NotRequired[str]
+    market_addr: NotRequired[str]
+    subaccount_addr: str | None
+    account_override: Account | None
+
+
+class CancelClientOrderArgs(TypedDict):
+    client_order_id: str
+    market_name: str
+    subaccount_addr: NotRequired[str | None]
+    account_override: NotRequired[Account | None]
+
+
+class CancelTwapOrderArgs(TypedDict):
+    order_id: str
+    market_addr: str
+    subaccount_addr: NotRequired[str | None]
+    account_override: NotRequired[Account | None]
+
+
+class ConfigureUserSettingsArgs(TypedDict):
+    market_addr: str
+    subaccount_addr: str
+    is_cross: bool
+    user_leverage: int
+
+
+class DelegateTradingArgs(TypedDict):
+    subaccount_addr: str
+    account_to_delegate_to: str
+    expiration_timestamp_secs: NotRequired[int | None]
+
+
+class RevokeDelegationArgs(TypedDict):
+    account_to_revoke: str
+    subaccount_addr: NotRequired[str | None]
+
+
+class PlaceTpSlOrderArgs(TypedDict, total=False):
+    market_addr: str
+    tp_trigger_price: float | None
+    tp_limit_price: float | None
+    tp_size: float | None
+    sl_trigger_price: float | None
+    sl_limit_price: float | None
+    sl_size: float | None
+    subaccount_addr: str | None
+    account_override: Account | None
+    tick_size: float | None
+
+
+class UpdateTpOrderArgs(TypedDict, total=False):
+    market_addr: str
+    prev_order_id: int | str
+    tp_trigger_price: float | None
+    tp_limit_price: float | None
+    tp_size: float | None
+    subaccount_addr: str | None
+    account_override: Account | None
+
+
+class UpdateSlOrderArgs(TypedDict, total=False):
+    market_addr: str
+    prev_order_id: int | str
+    sl_trigger_price: float | None
+    sl_limit_price: float | None
+    sl_size: float | None
+    subaccount_addr: str | None
+    account_override: Account | None
+
+
+class CancelTpSlOrderArgs(TypedDict):
+    market_addr: str
+    order_id: int | str
+    subaccount_addr: NotRequired[str | None]
+    account_override: NotRequired[Account | None]
+
+
+class ApproveBuilderFeeArgs(TypedDict):
+    builder_addr: str
+    max_fee: int
+    subaccount_addr: NotRequired[str | None]
+
+
+class RevokeBuilderFeeArgs(TypedDict):
+    builder_addr: str
+    subaccount_addr: NotRequired[str | None]
+
+
+class DeactivateSubaccountArgs(TypedDict):
+    subaccount_addr: str
+    revoke_all_delegations: NotRequired[bool]
+
+
+class DelegateDexActionsArgs(TypedDict):
+    vault_address: str
+    account_to_delegate_to: str
+    expiration_timestamp_secs: NotRequired[int | None]
+
+
+class PlaceBulkOrdersArgs(TypedDict, total=False):
+    market_name: str
+    sequence_number: int
+    bid_prices: list[int]
+    bid_sizes: list[int]
+    ask_prices: list[int]
+    ask_sizes: list[int]
+    builder_addr: str | None
+    builder_fee: int | None
+    subaccount_addr: str | None
+    account_override: Account | None
+
+
+class CancelBulkOrderArgs(TypedDict, total=False):
+    market_name: str
+    subaccount_addr: str | None
+    account_override: Account | None

decibel_python_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: decibel-python-sdk
+Version: 0.1.0
+Summary: Python SDK for interacting with Decibel, a fully on-chain trading engine built on Aptos.
+Keywords: decibel,aptos,blockchain,trading,sdk
+Author: Decibel
+Author-email: Decibel <support@decibel.trade>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: aptos-sdk>=0.11.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: websockets>=14.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# decibel-python-sdk
+
+<div align="center">
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Type checked: pyright](https://img.shields.io/badge/type%20checked-pyright-blue.svg)](https://github.com/microsoft/pyright)
+[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Python SDK for interacting with [Decibel](https://decibel.trade), a fully on-chain trading engine built on [Aptos](https://aptos.dev).
+
+**[📚 View Full Documentation →](https://docs.decibel.trade)**
+
+</div>
+
+## Installation
+
+```bash
+pip install decibel-python-sdk
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add decibel-python-sdk
+```
+
+## Configuration
+
+Set the following environment variables:
+
+```bash
+# Required for write operations
+export PRIVATE_KEY="your_private_key_hex"
+
+# Optional: for better rate limits
+export APTOS_NODE_API_KEY="your_aptos_node_api_key"
+```
+
+> **New to Decibel?** Follow the [Getting Started Guide](https://docs.decibel.trade/quickstart/overview) to create your API Wallet and get your API key from [Geomi](https://geomi.dev).
+
+## Quick Start
+
+### Reading Market Data
+
+```python
+import asyncio
+from decibel import NETNA_CONFIG
+from decibel.read import DecibelReadDex
+
+async def main():
+    read = DecibelReadDex(NETNA_CONFIG)
+
+    # Get all markets
+    markets = await read.markets.get_all()
+    for market in markets:
+        print(f"{market.market_name}: {market.max_leverage}x leverage")
+
+    # Get market prices
+    prices = await read.market_prices.get_all()
+    for price in prices:
+        print(f"{price.market}: ${price.mark_px}")
+
+asyncio.run(main())
+```
+
+### Placing Orders
+
+```python
+import asyncio
+import os
+from aptos_sdk.account import Account
+from aptos_sdk.ed25519 import PrivateKey
+from decibel import (
+    NETNA_CONFIG,
+    BaseSDKOptions,
+    DecibelWriteDex,
+    GasPriceManager,
+    PlaceOrderSuccess,
+    TimeInForce,
+    amount_to_chain_units,
+)
+from decibel.read import DecibelReadDex
+
+async def main():
+    private_key = PrivateKey.from_hex(os.environ["PRIVATE_KEY"])
+    account = Account.load_key(private_key.hex())
+
+    gas = GasPriceManager(NETNA_CONFIG)
+    await gas.initialize()
+
+    read = DecibelReadDex(NETNA_CONFIG)
+    markets = await read.markets.get_all()
+    btc = next(m for m in markets if m.market_name == "BTC/USD")
+
+    write = DecibelWriteDex(
+        NETNA_CONFIG,
+        account,
+        opts=BaseSDKOptions(gas_price_manager=gas),
+    )
+
+    result = await write.place_order(
+        market_name="BTC/USD",
+        price=amount_to_chain_units(100000.0, btc.px_decimals),
+        size=amount_to_chain_units(0.001, btc.sz_decimals),
+        is_buy=True,
+        time_in_force=TimeInForce.GoodTilCancelled,
+        is_reduce_only=False,
+    )
+
+    if isinstance(result, PlaceOrderSuccess):
+        print(f"Order placed! ID: {result.order_id}")
+    else:
+        print(f"Order failed: {result.error}")
+
+    await gas.destroy()
+
+asyncio.run(main())
+```
+
+### WebSocket Streaming
+
+```python
+import asyncio
+from decibel import NETNA_CONFIG
+from decibel.read import DecibelReadDex
+
+async def main():
+    read = DecibelReadDex(NETNA_CONFIG)
+
+    def on_price(msg):
+        price = msg.price
+        print(f"BTC/USD: ${price.mark_px}")
+
+    unsubscribe = read.market_prices.subscribe_by_name("BTC/USD", on_price)
+
+    await asyncio.sleep(30)
+    unsubscribe()
+    await read.ws.close()
+
+asyncio.run(main())
+```
+
+## Examples
+
+See the [examples](examples) directory for complete working examples:
+
+- **[examples/read](examples/read)** - REST API queries (markets, prices, positions, orders)
+- **[examples/read/ws](examples/read/ws)** - WebSocket subscriptions (real-time streaming)
+- **[examples/write](examples/write)** - Trading operations (orders, deposits, withdrawals)
+
+## API Reference
+
+### Network Configs
+
+```python
+from decibel import NETNA_CONFIG, TESTNET_CONFIG
+
+# NETNA_CONFIG - Dev Network
+# TESTNET_CONFIG - Test network
+```
+
+### Read Client
+
+```python
+from decibel.read import DecibelReadDex
+
+read = DecibelReadDex(config, api_key=None)
+
+# Market data
+read.markets.get_all()
+read.market_prices.get_all()
+read.market_prices.get_by_name(market_name)
+read.market_depth.get_by_name(market_name, limit=50)
+read.market_trades.get_by_name(market_name)
+read.candlesticks.get_by_name(market_name, interval, start_time, end_time)
+
+# User data
+read.user_positions.get_by_addr(sub_addr)
+read.user_open_orders.get_by_addr(sub_addr)
+read.user_order_history.get_by_addr(sub_addr)
+read.user_trade_history.get_by_addr(sub_addr)
+read.account_overview.get_by_addr(sub_addr)
+
+# WebSocket subscriptions
+read.market_prices.subscribe_by_name(market_name, callback)
+read.market_depth.subscribe_by_name(market_name, aggregation_size, callback)
+read.user_positions.subscribe_by_addr(sub_addr, callback)
+```
+
+### Write Client
+
+```python
+from decibel import DecibelWriteDex, TimeInForce
+
+write = DecibelWriteDex(config, account, opts)
+
+# Orders
+write.place_order(market_name, price, size, is_buy, time_in_force, is_reduce_only)
+write.cancel_order(market_name, order_id)
+write.cancel_order_by_client_id(market_name, client_order_id)
+
+# TP/SL
+write.place_tp_sl_for_position(market_name, tp_price, sl_price, ...)
+write.update_tp_order(market_name, order_id, new_trigger_price, ...)
+write.update_sl_order(market_name, order_id, new_trigger_price, ...)
+
+# Collateral
+write.deposit(amount)
+write.withdraw(amount)
+```
+
+## Development
+
+```bash
+uv sync --all-extras       # Install dependencies
+uv run pre-commit install  # Setup pre-commit hooks
+uv run pytest              # Run tests
+uv run ruff check .        # Lint
+uv run pyright             # Type check
+```
+
+## Resources
+
+- [📚 Documentation](https://docs.decibel.trade) - Full API documentation
+- [🌐 Trading Platform](https://app.decibel.trade) - Decibel trading interface
+- [💬 Discord](https://discord.gg/decibel) - Community support
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

decibel_python_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,53 @@
+decibel/__init__.py,sha256=2izkLHNyNNFzEkpzkzRbVjex-yL0e5F_8GPnWsWj8uM,5952
+decibel/_base.py,sha256=dfpMPL9tNgGx9wX9Wwxm-ttu6ykkSKlbDMah_4adKfM,25894
+decibel/_constants.py,sha256=dbQVBwCupucXT-bmp8-KggbdxjNRYxFmreOdAmZhGfg,4955
+decibel/_fee_pay.py,sha256=zyBfqnOChlHBdO9lTO6BfR-0pARQE6Sldcta-iZVwts,9466
+decibel/_gas_price_manager.py,sha256=-nZYWrpzwvGbCu1ywRLzdoIxU79TI1C0UR9tCpuJM8g,7915
+decibel/_order_status.py,sha256=siqf0iL8FDKixz0B0usq7zH2jVkS2bl0XqDCEdMVdvs,4000
+decibel/_order_types.py,sha256=mmmcFRX1rbeeUmWEd1zpq9qhutmSozZdFgohEvV_CWc,2378
+decibel/_pagination.py,sha256=ZJ02B3cnM2UHE6X1q2QDc_GvVd8Tgwqf00QiJdmM3TU,1842
+decibel/_subaccount_types.py,sha256=Khp_iXyAGX8CaFpJfd9ARnXN6qVMwcT-ANylaXuJOZw,972
+decibel/_transaction_builder.py,sha256=PXoFvQ6kknzhX2PUPkEj89fKDeedHQNZCIsRiNDyIMg,10727
+decibel/_utils.py,sha256=-i1yHiAXPkiWjqm9-BWgBOjVE4JnRKJOS95VDjLraxw,12851
+decibel/_version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+decibel/abi/__init__.py,sha256=0H9wpejYMJj-t-0z6ZazPUb4VJEd34zIdlNBDJ8eHu8,398
+decibel/abi/__main__.py,sha256=AJQyxHBa3B7PuVpexW7vGmxtBpd4Q_RfHzIZZTq6mD4,75
+decibel/abi/_registry.py,sha256=nQnP2z90NcuAOic_QXdlRqVK2gwnVHROhDKzctt0zoc,2716
+decibel/abi/_types.py,sha256=3mcLZQZMZtY7YfNXUCLAZIDbf3omd7e7YV3O5ETDYNg,1241
+decibel/abi/generate.py,sha256=Ukx_ZXHmFFn4zZunCf5FiTx5p_j5xM2REE-qrjv14w0,5554
+decibel/abi/json/netna.json,sha256=MmM-09B49lnXZvCyZv-P0qmqoKvgqlHIba_QqHI5jTU,83693
+decibel/abi/json/testnet.json,sha256=uKBgFK_hK3VI9XCRe4PGN37-lzx0cRVowiVfSw4-NOA,100182
+decibel/admin.py,sha256=7oL9EtmafnWow8k9wUSoIFEcCaisp6XS8-WNgj6ec3o,29404
+decibel/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+decibel/read/__init__.py,sha256=paIZctG0lOuHJu-PYG33nTJWtRpBml9V5m-OMUH98yQ,7183
+decibel/read/_account_overview.py,sha256=fx5N72HHwsFFVfCyM4SaMUw35y9dSIf95sXu0IVZlK8,3378
+decibel/read/_base.py,sha256=rwPhe6cg7-1vm4cbi8tonXY1R9fj30cY2Jr91RUBXiI,2932
+decibel/read/_candlesticks.py,sha256=-WSODzZd8YEueW8uhFhJEqJyUJ6S5E2vjUTIG9XPynI,2583
+decibel/read/_delegations.py,sha256=SEWIHbVKq2m_iTuSVkM1EYs8s1AzM77OA_FZfAHhbfo,761
+decibel/read/_leaderboard.py,sha256=QQUTpjilH9TIdbC-gURouUqFWrVt4NVf75VgU9qH7nM,1682
+decibel/read/_market_contexts.py,sha256=kx1aO1ZXRW_Cdbw2EAOGm0NF92qN14lW4yiNcVz-cBw,898
+decibel/read/_market_depth.py,sha256=2Cv7_pRkby1OH0bDBT0tZkhS1jE8lIyYUAlBVxW7C4Y,2350
+decibel/read/_market_prices.py,sha256=W9Hb_Pl61YVsnZe3B1BeL3rjqBkmJSlD-H2uIqY89KI,2805
+decibel/read/_market_trades.py,sha256=-r5L1SIrysiV2qRMOc1IPPn_2HlfeFlPxtAesiF6-0k,2066
+decibel/read/_markets.py,sha256=hrOEJ8OWCRBWsOjN6KME64Kvh80Eu80WN-LL5g5S_5Q,4212
+decibel/read/_portfolio_chart.py,sha256=4hr1XE0KJ1cED3wj0sbA0SMJ5RRz8lCnHW7zgMes7r8,1187
+decibel/read/_trading_points.py,sha256=U6b_lNQdWeav4-q3sAd1lSIi7_ymDtydGjwvY_PDQ5s,866
+decibel/read/_types.py,sha256=9GvuaOjxJ6kucxkxwy0laTk_oLGkqIw391OFg7W8AtY,3047
+decibel/read/_user_active_twaps.py,sha256=JU34bH7IQH5lomhuUsy22AInaWYj_wvphl5YdXL_FJY,1752
+decibel/read/_user_bulk_orders.py,sha256=nu4HFzl0kYHe3tr62DV55aWk62j_QteFAaWqUkhcqwQ,1889
+decibel/read/_user_fund_history.py,sha256=UoG_ItqysDHeNWERJHe2xLKSBdv_JPiI6_0KxCoO9Bw,1179
+decibel/read/_user_funding_history.py,sha256=FRut1YrnfSJM8MD7RTwvRQ1Hp7_jRl5YoysG2lr-RpQ,1079
+decibel/read/_user_notifications.py,sha256=qjf0T-ZB02KASWUubHxIoeiVFm5nHJpAhNczKoJwkoA,2556
+decibel/read/_user_open_orders.py,sha256=QLI27Er0-IgE2_JFTyuJJgRQqt051k-hRw4eLZx7RAc,2341
+decibel/read/_user_order_history.py,sha256=cVQoU9eGC2U71_lVA0YpSLCxv6Pwy9qZqTd-gXlxfSo,2395
+decibel/read/_user_positions.py,sha256=8kNYFKOBi9_IKP65y7V-sd6Oh8vF8RyUyYaC59jccJo,2142
+decibel/read/_user_subaccounts.py,sha256=pGCy4W_OYideDZ2qknNa9juG2bO8rj7CETDoqiouCCo,910
+decibel/read/_user_trade_history.py,sha256=XpvDujyntU_vaXl7zb_74IKMyII6CW5Mfk81J2FIZI0,1892
+decibel/read/_user_twap_history.py,sha256=K6OBZw2HAkMm-K5Z0SFHg1VTBasVL7YppybJ5Ndt7J8,800
+decibel/read/_vaults.py,sha256=ajmDBNOdgF3ieBxPZzdFmECJ1-WRavWv7Kg5mbTfDac,6039
+decibel/read/_ws.py,sha256=GIFMQFI603mdY9ZUtw-YGaxE8wPPTdYqj0hkjyCigbA,8473
+decibel/write/__init__.py,sha256=iffod3tCkXMV7Jp-2fmHiUvHgpFxF081iIs4u8pC14Q,69093
+decibel/write/_types.py,sha256=gdFa4u6QXF5nQbQeJhfMeo4sX0f6aVCpl5Hy7DjXC8s,4693
+decibel_python_sdk-0.1.0.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+decibel_python_sdk-0.1.0.dist-info/METADATA,sha256=8umFjvUTr48fDVoOz3wJjcZ5OQYjq-UMichIu84Q6o8,7177
+decibel_python_sdk-0.1.0.dist-info/RECORD,,

decibel_python_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.28
+Root-Is-Purelib: true
+Tag: py3-none-any