predict-sdk 0.0.1__tar.gz

predict_sdk-0.0.1/.gitignore

@@ -0,0 +1,110 @@
+# 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
+*.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/
+pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+venv-test/
+
+# 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/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Local development
+.python-version
+.pdm.toml
+pdm.lock
+
+# Secrets (never commit these)
+*.pem
+*.key
+.env.local
+.env.*.local

predict_sdk-0.0.1/LICENSE

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

predict_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,308 @@
+Metadata-Version: 2.4
+Name: predict_sdk
+Version: 0.0.1
+Summary: A Python SDK to help developers interface with the Predict.fun protocol
+Project-URL: Homepage, https://predict.fun/
+Project-URL: Documentation, https://dev.predict.fun/
+Project-URL: Repository, https://github.com/PredictDotFun/sdk-python
+Project-URL: Issues, https://github.com/PredictDotFun/sdk-python/issues
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: eth-abi>=5.0.0
+Requires-Dist: eth-account>=0.11.0
+Requires-Dist: eth-typing>=4.0.0
+Requires-Dist: web3<8.0.0,>=6.0.0
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Predict SDK for Python
+
+A Python SDK to help developers interface with the [Predict.fun](https://predict.fun/) protocol.
+
+## Installation
+
+```bash
+pip install predict-sdk
+```
+
+## Quick Start
+
+```python
+from predict_sdk import (
+    OrderBuilder,
+    ChainId,
+    Side,
+    BuildOrderInput,
+    LimitHelperInput,
+)
+
+# Create an OrderBuilder without a signer (read-only)
+builder = OrderBuilder.make(ChainId.BNB_MAINNET)
+
+# Calculate order amounts for a LIMIT order
+amounts = builder.get_limit_order_amounts(
+    LimitHelperInput(
+        side=Side.BUY,
+        price_per_share_wei=500000000000000000,  # 0.5 USDT per share
+        quantity_wei=10000000000000000000,  # 10 shares
+    )
+)
+
+print(f"Maker Amount: {amounts.maker_amount}")
+print(f"Taker Amount: {amounts.taker_amount}")
+
+# Build an order
+order = builder.build_order(
+    "LIMIT",
+    BuildOrderInput(
+        side=Side.BUY,
+        token_id="YOUR_TOKEN_ID",
+        maker_amount=str(amounts.maker_amount),
+        taker_amount=str(amounts.taker_amount),
+        fee_rate_bps=100,  # Get from GET /markets endpoint
+    ),
+)
+```
+
+## With a Signer
+
+```python
+from eth_account import Account
+from predict_sdk import OrderBuilder, ChainId
+
+# Create from private key
+private_key = "0x..."  # Your private key
+signer = Account.from_key(private_key)
+
+# Or pass private key directly
+builder = OrderBuilder.make(ChainId.BNB_MAINNET, private_key)
+
+# Now you can sign orders and interact with contracts
+typed_data = builder.build_typed_data(
+    order,
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+signed_order = builder.sign_typed_data_order(typed_data)
+print(f"Signature: {signed_order.signature}")
+```
+
+## Setting Approvals
+
+Before trading, you need to set approvals for the exchange contracts:
+
+```python
+# Set all approvals at once
+result = builder.set_approvals(is_yield_bearing=False)
+
+if result.success:
+    print("All approvals set successfully!")
+else:
+    print("Some approvals failed")
+    for tx in result.transactions:
+        if not tx.success:
+            print(f"Failed: {tx.cause}")
+
+# Or set individual approvals
+builder.set_ctf_exchange_approval(is_neg_risk=False, is_yield_bearing=False)
+builder.set_ctf_exchange_allowance(is_neg_risk=False, is_yield_bearing=False)
+```
+
+## Using Predict Accounts (Smart Wallets)
+
+```python
+from predict_sdk import OrderBuilder, ChainId, OrderBuilderOptions
+
+builder = OrderBuilder.make(
+    ChainId.BNB_MAINNET,
+    private_key,  # Must be the Privy exported wallet
+    OrderBuilderOptions(
+        predict_account="0x...",  # Your Predict account address
+    ),
+)
+```
+
+## Market Orders
+
+```python
+from predict_sdk import MarketHelperInput, MarketHelperValueInput
+
+# Market order by quantity (number of shares)
+amounts = builder.get_market_order_amounts(
+    MarketHelperInput(
+        side=Side.BUY,
+        quantity_wei=10000000000000000000,  # 10 shares
+    ),
+    orderbook,  # From GET /orderbook/{marketId}
+)
+
+# Market BUY by value (total USDT to spend)
+amounts = builder.get_market_order_amounts(
+    MarketHelperValueInput(
+        side=Side.BUY,
+        value_wei=5000000000000000000,  # 5 USDT
+    ),
+    orderbook,
+)
+```
+
+## Redeeming Positions
+
+```python
+# For standard markets
+result = builder.redeem_positions(
+    condition_id="0x...",
+    index_set=1,  # 1 or 2
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+# For NegRisk (winner-takes-all) markets
+result = builder.redeem_positions(
+    condition_id="0x...",
+    index_set=1,
+    amount=1000000000000000000,  # Required for NegRisk
+    is_neg_risk=True,
+    is_yield_bearing=False,
+)
+```
+
+## Merging Positions
+
+Merge both outcome tokens back into collateral (USDT). Useful when holding equal amounts of both YES and NO positions.
+
+```python
+# For standard markets
+result = builder.merge_positions(
+    condition_id="0x...",
+    amount=1000000000000000000,  # Amount to merge (in wei)
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+# For NegRisk (winner-takes-all) markets
+result = builder.merge_positions(
+    condition_id="0x...",
+    amount=1000000000000000000,
+    is_neg_risk=True,
+    is_yield_bearing=False,
+)
+```
+
+## Canceling Orders
+
+```python
+from predict_sdk import CancelOrdersOptions
+
+result = builder.cancel_orders(
+    orders=[order1, order2],
+    options=CancelOrdersOptions(
+        is_neg_risk=False,
+        is_yield_bearing=False,
+    ),
+)
+```
+
+## Checking Balance
+
+```python
+balance = builder.balance_of("USDT")
+print(f"USDT Balance: {balance}")
+```
+
+## Async Support
+
+All contract interaction methods have async versions:
+
+```python
+import asyncio
+
+async def main():
+    balance = await builder.balance_of_async("USDT")
+    result = await builder.set_approvals_async(is_yield_bearing=False)
+
+asyncio.run(main())
+```
+
+## API Reference
+
+### OrderBuilder
+
+The main class for building and signing orders.
+
+#### Factory Method
+
+```python
+OrderBuilder.make(
+    chain_id: ChainId,
+    signer: LocalAccount | str | None = None,
+    options: OrderBuilderOptions | None = None,
+) -> OrderBuilder
+```
+
+#### Order Building Methods
+
+- `get_limit_order_amounts(data: LimitHelperInput) -> OrderAmounts`
+- `get_market_order_amounts(data: MarketHelperInput | MarketHelperValueInput, book: Book) -> OrderAmounts`
+- `build_order(strategy: "MARKET" | "LIMIT", data: BuildOrderInput) -> Order`
+- `build_typed_data(order: Order, *, is_neg_risk: bool, is_yield_bearing: bool) -> EIP712TypedData`
+- `build_typed_data_hash(typed_data: EIP712TypedData) -> str`
+- `sign_typed_data_order(typed_data: EIP712TypedData) -> SignedOrder`
+
+#### Approval Methods
+
+- `set_approvals(*, is_yield_bearing: bool = False) -> SetApprovalsResult`
+- `set_ctf_exchange_approval(*, is_neg_risk: bool, is_yield_bearing: bool, approved: bool = True) -> TransactionResult`
+- `set_neg_risk_adapter_approval(*, is_yield_bearing: bool, approved: bool = True) -> TransactionResult`
+- `set_ctf_exchange_allowance(*, is_neg_risk: bool, is_yield_bearing: bool, amount: int = MAX_UINT256) -> TransactionResult`
+
+#### Position Management
+
+- `balance_of(token: "USDT" = "USDT", address: str | None = None) -> int`
+- `redeem_positions(condition_id: str, index_set: 1 | 2, amount: int | None = None, *, is_neg_risk: bool, is_yield_bearing: bool) -> TransactionResult`
+- `merge_positions(condition_id: str, amount: int, *, is_neg_risk: bool, is_yield_bearing: bool) -> TransactionResult`
+
+#### Order Cancellation
+
+- `cancel_orders(orders: list[Order], options: CancelOrdersOptions) -> TransactionResult`
+- `validate_token_ids(token_ids: list[int], *, is_neg_risk: bool, is_yield_bearing: bool) -> bool`
+
+### Types
+
+```python
+from predict_sdk import (
+    ChainId,       # BNB_MAINNET (56), BNB_TESTNET (97)
+    Side,          # BUY (0), SELL (1)
+    SignatureType, # EOA (0), POLY_PROXY (1), POLY_GNOSIS_SAFE (2)
+    Order,
+    SignedOrder,
+    BuildOrderInput,
+    OrderAmounts,
+    LimitHelperInput,
+    MarketHelperInput,
+    MarketHelperValueInput,
+    Book,
+    EIP712TypedData,
+    TransactionResult,
+    SetApprovalsResult,
+    CancelOrdersOptions,
+    OrderBuilderOptions,
+)
+```
+
+## Requirements
+
+- Python >= 3.11
+- web3.py >= 6.0.0
+
+## License
+
+MIT

predict_sdk-0.0.1/README.md

@@ -0,0 +1,284 @@
+# Predict SDK for Python
+
+A Python SDK to help developers interface with the [Predict.fun](https://predict.fun/) protocol.
+
+## Installation
+
+```bash
+pip install predict-sdk
+```
+
+## Quick Start
+
+```python
+from predict_sdk import (
+    OrderBuilder,
+    ChainId,
+    Side,
+    BuildOrderInput,
+    LimitHelperInput,
+)
+
+# Create an OrderBuilder without a signer (read-only)
+builder = OrderBuilder.make(ChainId.BNB_MAINNET)
+
+# Calculate order amounts for a LIMIT order
+amounts = builder.get_limit_order_amounts(
+    LimitHelperInput(
+        side=Side.BUY,
+        price_per_share_wei=500000000000000000,  # 0.5 USDT per share
+        quantity_wei=10000000000000000000,  # 10 shares
+    )
+)
+
+print(f"Maker Amount: {amounts.maker_amount}")
+print(f"Taker Amount: {amounts.taker_amount}")
+
+# Build an order
+order = builder.build_order(
+    "LIMIT",
+    BuildOrderInput(
+        side=Side.BUY,
+        token_id="YOUR_TOKEN_ID",
+        maker_amount=str(amounts.maker_amount),
+        taker_amount=str(amounts.taker_amount),
+        fee_rate_bps=100,  # Get from GET /markets endpoint
+    ),
+)
+```
+
+## With a Signer
+
+```python
+from eth_account import Account
+from predict_sdk import OrderBuilder, ChainId
+
+# Create from private key
+private_key = "0x..."  # Your private key
+signer = Account.from_key(private_key)
+
+# Or pass private key directly
+builder = OrderBuilder.make(ChainId.BNB_MAINNET, private_key)
+
+# Now you can sign orders and interact with contracts
+typed_data = builder.build_typed_data(
+    order,
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+signed_order = builder.sign_typed_data_order(typed_data)
+print(f"Signature: {signed_order.signature}")
+```
+
+## Setting Approvals
+
+Before trading, you need to set approvals for the exchange contracts:
+
+```python
+# Set all approvals at once
+result = builder.set_approvals(is_yield_bearing=False)
+
+if result.success:
+    print("All approvals set successfully!")
+else:
+    print("Some approvals failed")
+    for tx in result.transactions:
+        if not tx.success:
+            print(f"Failed: {tx.cause}")
+
+# Or set individual approvals
+builder.set_ctf_exchange_approval(is_neg_risk=False, is_yield_bearing=False)
+builder.set_ctf_exchange_allowance(is_neg_risk=False, is_yield_bearing=False)
+```
+
+## Using Predict Accounts (Smart Wallets)
+
+```python
+from predict_sdk import OrderBuilder, ChainId, OrderBuilderOptions
+
+builder = OrderBuilder.make(
+    ChainId.BNB_MAINNET,
+    private_key,  # Must be the Privy exported wallet
+    OrderBuilderOptions(
+        predict_account="0x...",  # Your Predict account address
+    ),
+)
+```
+
+## Market Orders
+
+```python
+from predict_sdk import MarketHelperInput, MarketHelperValueInput
+
+# Market order by quantity (number of shares)
+amounts = builder.get_market_order_amounts(
+    MarketHelperInput(
+        side=Side.BUY,
+        quantity_wei=10000000000000000000,  # 10 shares
+    ),
+    orderbook,  # From GET /orderbook/{marketId}
+)
+
+# Market BUY by value (total USDT to spend)
+amounts = builder.get_market_order_amounts(
+    MarketHelperValueInput(
+        side=Side.BUY,
+        value_wei=5000000000000000000,  # 5 USDT
+    ),
+    orderbook,
+)
+```
+
+## Redeeming Positions
+
+```python
+# For standard markets
+result = builder.redeem_positions(
+    condition_id="0x...",
+    index_set=1,  # 1 or 2
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+# For NegRisk (winner-takes-all) markets
+result = builder.redeem_positions(
+    condition_id="0x...",
+    index_set=1,
+    amount=1000000000000000000,  # Required for NegRisk
+    is_neg_risk=True,
+    is_yield_bearing=False,
+)
+```
+
+## Merging Positions
+
+Merge both outcome tokens back into collateral (USDT). Useful when holding equal amounts of both YES and NO positions.
+
+```python
+# For standard markets
+result = builder.merge_positions(
+    condition_id="0x...",
+    amount=1000000000000000000,  # Amount to merge (in wei)
+    is_neg_risk=False,
+    is_yield_bearing=False,
+)
+
+# For NegRisk (winner-takes-all) markets
+result = builder.merge_positions(
+    condition_id="0x...",
+    amount=1000000000000000000,
+    is_neg_risk=True,
+    is_yield_bearing=False,
+)
+```
+
+## Canceling Orders
+
+```python
+from predict_sdk import CancelOrdersOptions
+
+result = builder.cancel_orders(
+    orders=[order1, order2],
+    options=CancelOrdersOptions(
+        is_neg_risk=False,
+        is_yield_bearing=False,
+    ),
+)
+```
+
+## Checking Balance
+
+```python
+balance = builder.balance_of("USDT")
+print(f"USDT Balance: {balance}")
+```
+
+## Async Support
+
+All contract interaction methods have async versions:
+
+```python
+import asyncio
+
+async def main():
+    balance = await builder.balance_of_async("USDT")
+    result = await builder.set_approvals_async(is_yield_bearing=False)
+
+asyncio.run(main())
+```
+
+## API Reference
+
+### OrderBuilder
+
+The main class for building and signing orders.
+
+#### Factory Method
+
+```python
+OrderBuilder.make(
+    chain_id: ChainId,
+    signer: LocalAccount | str | None = None,
+    options: OrderBuilderOptions | None = None,
+) -> OrderBuilder
+```
+
+#### Order Building Methods
+
+- `get_limit_order_amounts(data: LimitHelperInput) -> OrderAmounts`
+- `get_market_order_amounts(data: MarketHelperInput | MarketHelperValueInput, book: Book) -> OrderAmounts`
+- `build_order(strategy: "MARKET" | "LIMIT", data: BuildOrderInput) -> Order`
+- `build_typed_data(order: Order, *, is_neg_risk: bool, is_yield_bearing: bool) -> EIP712TypedData`
+- `build_typed_data_hash(typed_data: EIP712TypedData) -> str`
+- `sign_typed_data_order(typed_data: EIP712TypedData) -> SignedOrder`
+
+#### Approval Methods
+
+- `set_approvals(*, is_yield_bearing: bool = False) -> SetApprovalsResult`
+- `set_ctf_exchange_approval(*, is_neg_risk: bool, is_yield_bearing: bool, approved: bool = True) -> TransactionResult`
+- `set_neg_risk_adapter_approval(*, is_yield_bearing: bool, approved: bool = True) -> TransactionResult`
+- `set_ctf_exchange_allowance(*, is_neg_risk: bool, is_yield_bearing: bool, amount: int = MAX_UINT256) -> TransactionResult`
+
+#### Position Management
+
+- `balance_of(token: "USDT" = "USDT", address: str | None = None) -> int`
+- `redeem_positions(condition_id: str, index_set: 1 | 2, amount: int | None = None, *, is_neg_risk: bool, is_yield_bearing: bool) -> TransactionResult`
+- `merge_positions(condition_id: str, amount: int, *, is_neg_risk: bool, is_yield_bearing: bool) -> TransactionResult`
+
+#### Order Cancellation
+
+- `cancel_orders(orders: list[Order], options: CancelOrdersOptions) -> TransactionResult`
+- `validate_token_ids(token_ids: list[int], *, is_neg_risk: bool, is_yield_bearing: bool) -> bool`
+
+### Types
+
+```python
+from predict_sdk import (
+    ChainId,       # BNB_MAINNET (56), BNB_TESTNET (97)
+    Side,          # BUY (0), SELL (1)
+    SignatureType, # EOA (0), POLY_PROXY (1), POLY_GNOSIS_SAFE (2)
+    Order,
+    SignedOrder,
+    BuildOrderInput,
+    OrderAmounts,
+    LimitHelperInput,
+    MarketHelperInput,
+    MarketHelperValueInput,
+    Book,
+    EIP712TypedData,
+    TransactionResult,
+    SetApprovalsResult,
+    CancelOrdersOptions,
+    OrderBuilderOptions,
+)
+```
+
+## Requirements
+
+- Python >= 3.11
+- web3.py >= 6.0.0
+
+## License
+
+MIT