opinion-clob-sdk 0.1.0__tar.gz

opinion_clob_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: opinion_clob_sdk
+Version: 0.1.0
+Summary: Opinion CLOB SDK - Python SDK for Opinion Prediction Market Central Limit Order Book API
+Home-page: https://opinion.trade
+Author: Opinion Labs
+Author-email: support@opinion.trade
+Keywords: PredictionMarket,CLOB,Trading,Blockchain,Base,Opinion
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3>=2.3.0
+Requires-Dist: six>=1.17.0
+Requires-Dist: certifi>=2024.12.14
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: hexbytes>=1.2.1
+Requires-Dist: web3>=7.6.1
+Requires-Dist: eth_account>=0.13.0
+Requires-Dist: poly_eip712_structs>=0.0.1
+Requires-Dist: opinion_api>=0.1.0
+Requires-Dist: pytest>=7.0.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# Opinion CLOB SDK
+
+Python SDK for interacting with Opinion prediction markets via the CLOB (Central Limit Order Book) API.
+
+## Features
+
+- Market data queries (markets, orderbooks, prices, candles)
+- Order management (place, cancel, query orders)
+- Position and balance tracking
+- Smart contract interactions (split, merge, redeem)
+- Support for Base mainnet (chain ID 8453)
+
+## Installation
+
+```bash
+pip install opinion_clob_sdk
+```
+
+## Quick Start
+
+```python
+from opinion_clob_sdk import Client
+
+client = Client(
+    host='https://api.opinion.trade',
+    apikey='your_api_key',
+    chain_id=8453,  # Base mainnet
+    rpc_url='your_rpc_url',
+    private_key='your_private_key',
+    multi_sig_addr='your_multi_sig_address'
+)
+
+# Get markets
+markets = client.get_markets(page=1, limit=10)
+
+# Get orderbook
+orderbook = client.get_orderbook(token_id='token_id')
+
+# Place an order
+from opinion_clob_sdk.chain.py_order_utils.model.order import PlaceOrderDataInput
+from opinion_clob_sdk.chain.py_order_utils.model.sides import OrderSide
+from opinion_clob_sdk.chain.py_order_utils.model.order_type import LIMIT_ORDER
+
+order_data = PlaceOrderDataInput(
+    marketId=123,
+    tokenId='token_id',
+    side=OrderSide.BUY,
+    orderType=LIMIT_ORDER,
+    price='0.5',
+    makerAmountInQuoteToken=10
+)
+
+result = client.place_order(order_data)
+```
+    

opinion_clob_sdk-0.1.0/README.md

@@ -0,0 +1,232 @@
+# Opinion CLOB SDK
+
+Python SDK for interacting with Opinion prediction markets via the CLOB (Central Limit Order Book) API.
+
+## Overview
+
+The Opinion CLOB SDK provides a Python interface for:
+- Querying prediction market data
+- Placing and managing orders
+- Tracking positions and balances
+- Interacting with smart contracts (split, merge, redeem)
+
+Supports Base mainnet (chain ID 8453) and Base testnet (chain ID 10143).
+
+## Installation
+
+```bash
+pip install opinion_clob_sdk
+```
+
+## Quick Start
+
+```python
+from opinion_clob_sdk import Client
+
+# Initialize client
+client = Client(
+    host='https://api.opinion.trade',
+    apikey='your_api_key',
+    chain_id=8453,  # Base mainnet
+    rpc_url='your_rpc_url',
+    private_key='your_private_key',
+    multi_sig_addr='your_multi_sig_address'
+)
+
+# Get markets
+markets = client.get_markets(page=1, limit=10)
+
+# Get market detail
+market = client.get_market(market_id=123)
+
+# Get orderbook
+orderbook = client.get_orderbook(token_id='token_123')
+
+# Get latest price
+price = client.get_latest_price(token_id='token_123')
+```
+
+## Core Features
+
+### Market Data
+
+```python
+# Get all markets with filters
+from opinion_clob_sdk.model import TopicType, TopicStatusFilter
+
+markets = client.get_markets(
+    topic_type=TopicType.BINARY,
+    status=TopicStatusFilter.ACTIVATED,
+    page=1,
+    limit=20
+)
+
+# Get specific market
+market = client.get_market(market_id=123)
+
+# Get categorical market
+categorical = client.get_categorical_market(market_id=456)
+
+# Get supported currencies
+currencies = client.get_currencies()
+```
+
+### Token Data
+
+```python
+# Get orderbook
+orderbook = client.get_orderbook(token_id='token_123')
+
+# Get latest price
+price = client.get_latest_price(token_id='token_123')
+
+# Get price history
+history = client.get_price_history(
+    token_id='token_123',
+    interval='1hour',
+    bars=24
+)
+
+# Get fee rates
+fees = client.get_fee_rates(token_id='token_123')
+```
+
+### Trading
+
+```python
+from opinion_clob_sdk.chain.py_order_utils.model.order import PlaceOrderDataInput
+from opinion_clob_sdk.chain.py_order_utils.model.sides import OrderSide
+from opinion_clob_sdk.chain.py_order_utils.model.order_type import LIMIT_ORDER, MARKET_ORDER
+
+# Place a limit order
+order_data = PlaceOrderDataInput(
+    marketId=123,
+    tokenId='token_yes',
+    side=OrderSide.BUY,
+    orderType=LIMIT_ORDER,
+    price='0.5',
+    makerAmountInQuoteToken=10  # 10 USDC
+)
+result = client.place_order(order_data)
+
+# Place a market order
+market_order = PlaceOrderDataInput(
+    marketId=123,
+    tokenId='token_yes',
+    side=OrderSide.SELL,
+    orderType=MARKET_ORDER,
+    price='0',  # Market orders don't need price
+    makerAmountInBaseToken=5  # 5 YES tokens
+)
+result = client.place_order(market_order)
+
+# Cancel an order
+client.cancel_order(trans_no='order_trans_no')
+
+# Get my orders
+my_orders = client.get_my_orders(market_id=123, limit=10)
+
+# Get order by ID
+order = client.get_order_by_id(order_id='order_123')
+```
+
+### User Data
+
+```python
+# Get balances
+balances = client.get_my_balances()
+
+# Get positions
+positions = client.get_my_positions(page=1, pageSize=10)
+
+# Get trade history
+trades = client.get_my_trades(market_id=123, limit=20)
+
+# Get user auth info
+auth = client.get_user_auth()
+```
+
+### Smart Contract Operations
+
+```python
+# Enable trading (approve tokens)
+client.enable_trading()
+
+# Split collateral into outcome tokens
+tx_hash = client.split(market_id=123, amount=1000000)  # amount in wei
+
+# Merge outcome tokens back to collateral
+tx_hash = client.merge(market_id=123, amount=1000000)
+
+# Redeem winning positions
+tx_hash = client.redeem(market_id=123)
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file:
+
+```
+API_KEY=your_api_key
+RPC_URL=your_rpc_url
+PRIVATE_KEY=your_private_key
+MULTI_SIG_ADDRESS=your_multi_sig_address
+```
+
+### Chain IDs
+
+- **Base Mainnet**: 8453
+- **Base Testnet**: 10143
+
+## Development
+
+### Running Tests
+
+```bash
+# Install development dependencies
+pip install -r requirements.txt
+
+# Run unit tests
+pytest -v -m "not integration"
+
+# Run all tests (including integration)
+pytest -v
+
+# Run with coverage
+pytest --cov=opinion_clob_sdk --cov-report=html
+```
+
+### Project Structure
+
+```
+opinion_clob_sdk/
+├── __init__.py           # Package exports
+├── sdk.py                # Main Client class
+├── model.py              # Enums and types
+├── config.py             # Configuration constants
+├── chain/                # Blockchain interactions
+│   ├── contract_caller.py
+│   ├── py_order_utils/   # Order building and signing
+│   └── safe/             # Gnosis Safe integration
+└── tests/                # Test suite
+    ├── test_sdk.py
+    ├── test_model.py
+    ├── test_order_calculations.py
+    └── test_integration.py
+```
+
+## API Reference
+
+See the [full API documentation](https://docs.opinion.trade) for detailed information.
+
+## Support
+
+- Documentation: https://docs.opinion.trade
+- Email: support@opinion.trade
+- GitHub Issues: https://github.com/opinionlabs/openapi/issues
+
+## License
+
+MIT License - see LICENSE file for details