ostium-python-sdk 0.1.28__tar.gz → 0.1.31__tar.gz

{ostium_python_sdk-0.1.28 → ostium_python_sdk-0.1.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.28
+Version: 0.1.31
 Summary: A python based SDK developed for interacting with Ostium, a leveraged trading application for trading currencies, commodities, indices, crypto and more.
 Home-page: https://github.com/0xOstium/ostium-python-sdk
 Author: ami@ostium.io
@@ -26,7 +26,10 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-[Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+# Changelog
+[![Changelog](https://img.shields.io/badge/changelog-View%20Latest%20Changes-blue.svg)](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+
+Track all notable changes, updates, and improvements to the Ostium Python SDK in our [Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md).
 
 # Ostium Python SDK
 
@@ -454,7 +457,11 @@ python examples/example-get-balance.py
 See [example-get-balance.py](https://github.com/0xOstium/ostium_python_sdk/blob/main/examples/example-get-balance.py) for an example of how to use the SDK.
 
 
+## Run an example from local install
 
+```bash
+ pip uninstall ostium-python-sdk  &&  pip install -e .  &&  python examples/example-pairs-details.py
+```
 
 
 
@@ -465,6 +472,11 @@ All notable changes to the Ostium Python SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.31] - 2025-01-13
+
+### Added
+- Add `get_formatted_pairs_details` on sdk class
+
 ## [0.1.25] - 2025-01-13
 
 ### Added

{ostium_python_sdk-0.1.28 → ostium_python_sdk-0.1.31}/README.md

@@ -1,4 +1,7 @@
-[Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+# Changelog
+[![Changelog](https://img.shields.io/badge/changelog-View%20Latest%20Changes-blue.svg)](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+
+Track all notable changes, updates, and improvements to the Ostium Python SDK in our [Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md).
 
 # Ostium Python SDK
 
@@ -426,5 +429,9 @@ python examples/example-get-balance.py
 See [example-get-balance.py](https://github.com/0xOstium/ostium_python_sdk/blob/main/examples/example-get-balance.py) for an example of how to use the SDK.
 
 
+## Run an example from local install
 
+```bash
+ pip uninstall ostium-python-sdk  &&  pip install -e .  &&  python examples/example-pairs-details.py
+```
 

{ostium_python_sdk-0.1.28 → ostium_python_sdk-0.1.31}/ostium_python_sdk/constants.py

@@ -2,10 +2,14 @@
 # Constants
 from decimal import Decimal
 
-PRECISION_2 = Decimal('100')
+
 MAX_PROFIT_P = Decimal('900')  # 900% * PRECISION_6
 MAX_STOP_LOSS_P = Decimal('85')
+
+PRECISION_2 = Decimal('100')
 PRECISION_6 = Decimal('1000000')
+PRECISION_9 = Decimal('1000000000')
 PRECISION_12 = Decimal('1000000000000')
 PRECISION_18 = Decimal('1000000000000000000')
+
 LIQ_THRESHOLD_P = Decimal('90')  # -90% (of collateral)

ostium_python_sdk-0.1.31/ostium_python_sdk/sdk.py

@@ -0,0 +1,165 @@
+from dotenv import load_dotenv
+import os
+from decimal import Decimal
+from .constants import PRECISION_2, PRECISION_6, PRECISION_12, PRECISION_18, PRECISION_9
+
+from ostium_python_sdk.faucet import Faucet
+from .balance import Balance
+from .price import Price
+from web3 import Web3
+from .ostium import Ostium
+from .config import NetworkConfig
+from typing import Union
+from .subgraph import SubgraphClient
+
+
+class OstiumSDK:
+    def __init__(self, network: Union[str, NetworkConfig], private_key: str = None, rpc_url: str = None):
+        load_dotenv()
+        self.private_key = private_key or os.getenv('PRIVATE_KEY')
+        if not self.private_key:
+            raise ValueError(
+                "No private key provided. Please provide via constructor or PRIVATE_KEY environment variable")
+
+        self.rpc_url = rpc_url or os.getenv('RPC_URL')
+        if not self.rpc_url:
+            network_name = "mainnet" if isinstance(
+                network, str) and network == "mainnet" else "testnet"
+            raise ValueError(
+                f"No RPC URL provided for {network_name}. Please provide via constructor or RPC_URL environment variable")
+
+        # Initialize Web3
+        self.w3 = Web3(Web3.HTTPProvider(self.rpc_url))
+
+        # Get network configuration
+        if isinstance(network, NetworkConfig):
+            self.network_config = network
+        elif isinstance(network, str):
+            if network == "mainnet":
+                self.network_config = NetworkConfig.mainnet()
+            elif network == "testnet":
+                self.network_config = NetworkConfig.testnet()
+            else:
+                raise ValueError(
+                    f"Unsupported network: {network}. Use 'mainnet' or 'testnet'")
+        else:
+            raise ValueError(
+                "Network must be either a NetworkConfig instance or a string ('mainnet' or 'testnet')")
+
+        # Initialize Ostium instance
+        self.ostium = Ostium(
+            self.w3,
+            self.network_config.contracts["usdc"],
+            self.network_config.contracts["tradingStorage"],
+            self.network_config.contracts["trading"],
+            private_key=self.private_key
+        )
+
+        # Initialize subgraph client
+        self.subgraph = SubgraphClient(url=self.network_config.graph_url)
+
+        self.balance = Balance(self.w3, self.network_config.contracts["usdc"])
+        self.price = Price()
+
+        if self.network_config.is_testnet:
+            self.faucet = Faucet(self.w3, self.private_key)
+        else:
+            self.faucet = None
+
+    async def get_formatted_pairs_details(self) -> list:
+        """
+        Get formatted details for all trading pairs, with proper decimal conversion.
+
+        Crypto pairs example:
+        BTC-USD:
+            - price: 65432.50
+            - longOI: 0.41008148 (410.08148 BTC)
+            - shortOI: 2.59812309 (2,598.12309 BTC)
+            - maxOI: 1000.00000000
+            - utilizationP: 80.00%
+            - makerFeeP: 0.01%
+            - takerFeeP: 0.10%
+            - maxLeverage: 50x
+            - group: crypto
+
+        ETH-USD:
+            - price: 3050.50
+            - longOI: 5.90560023 (5,905.60023 ETH)
+            - shortOI: 0.00000000
+            - maxOI: 1000.00000000
+            - utilizationP: 80.00%
+            - makerFeeP: 0.01%
+            - takerFeeP: 0.10%
+            - maxLeverage: 50x
+            - group: crypto
+
+        Returns:
+            list: List of dictionaries containing formatted pair details including:
+                - id: Pair ID
+                - from: Base asset (e.g., 'BTC')
+                - to: Quote asset (e.g., 'USD')
+                - price: Current market price
+                - isMarketOpen: Market open status
+                - longOI: Total long open interest in notional value
+                - shortOI: Total short open interest in notional value
+                - maxOI: Maximum allowed open interest
+                - utilizationP: Utilization threshold percentage
+                - makerFeeP: Maker fee percentage
+                - takerFeeP: Taker fee percentage
+                - usageFeeP: Usage fee percentage
+                - maxLeverage: Maximum allowed leverage
+                - minLeverage: Minimum allowed leverage
+                - makerMaxLeverage: Maximum leverage for makers
+                - group: Trading group name
+                - groupMaxCollateralP: Maximum collateral percentage for the group
+                - minLevPos: Minimum leverage position size
+                - lastFundingRate: Latest funding rate
+                - curFundingLong: Current funding for longs
+                - curFundingShort: Current funding for shorts
+                - lastFundingBlock: Block number of last funding update
+                - lastFundingVelocity: Velocity of last funding rate change
+        """
+        pairs = await self.subgraph.get_pairs()
+        formatted_pairs = []
+
+        for pair in pairs:
+            pair_details = await self.subgraph.get_pair_details(pair['id'])
+
+            # Get current price and market status
+            try:
+                price, is_market_open = await self.price.get_price(
+                    pair_details['from'],
+                    pair_details['to']
+                )
+            except ValueError:
+                price = 0
+                is_market_open = False
+
+            formatted_pair = {
+                'id': int(pair_details['id']),
+                'from': pair_details['from'],
+                'to': pair_details['to'],
+                'price': price,
+                'isMarketOpen': is_market_open,
+                'longOI': Decimal(pair_details['longOI']) / PRECISION_18,
+                'shortOI': Decimal(pair_details['shortOI']) / PRECISION_18,
+                'maxOI': Decimal(pair_details['maxOI']) / PRECISION_18,
+                'utilizationP': Decimal(pair_details['utilizationThresholdP']) / PRECISION_2,
+                'makerFeeP': Decimal(pair_details['makerFeeP']) / PRECISION_6,
+                'takerFeeP': Decimal(pair_details['takerFeeP']) / PRECISION_6,
+                'usageFeeP': Decimal(pair_details['usageFeeP']) / PRECISION_6,
+                'maxLeverage': Decimal(pair_details['group']['maxLeverage']) / PRECISION_2,
+                'minLeverage': Decimal(pair_details['group']['minLeverage']) / PRECISION_2,
+                'makerMaxLeverage': Decimal(pair_details['makerMaxLeverage']) / PRECISION_2,
+                'group': pair_details['group']['name'],
+                'groupMaxCollateralP': Decimal(pair_details['group']['maxCollateralP']) / PRECISION_2,
+                'minLevPos': Decimal(pair_details['fee']['minLevPos']) / PRECISION_9,
+                'lastFundingRate': Decimal(pair_details['lastFundingRate']) / PRECISION_9,
+                'curFundingLong': Decimal(pair_details['curFundingLong']) / PRECISION_9,
+                'curFundingShort': Decimal(pair_details['curFundingShort']) / PRECISION_9,
+                'lastFundingBlock': int(pair_details['lastFundingBlock']),
+                'lastFundingVelocity': int(pair_details['lastFundingVelocity'])
+            }
+            formatted_pairs.append(formatted_pair)
+
+        return formatted_pairs

{ostium_python_sdk-0.1.28 → ostium_python_sdk-0.1.31}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.28
+Version: 0.1.31
 Summary: A python based SDK developed for interacting with Ostium, a leveraged trading application for trading currencies, commodities, indices, crypto and more.
 Home-page: https://github.com/0xOstium/ostium-python-sdk
 Author: ami@ostium.io
@@ -26,7 +26,10 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-[Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+# Changelog
+[![Changelog](https://img.shields.io/badge/changelog-View%20Latest%20Changes-blue.svg)](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md)
+
+Track all notable changes, updates, and improvements to the Ostium Python SDK in our [Changelog](https://github.com/0xOstium/ostium-python-sdk/blob/main/CHANGELOG.md).
 
 # Ostium Python SDK
 
@@ -454,7 +457,11 @@ python examples/example-get-balance.py
 See [example-get-balance.py](https://github.com/0xOstium/ostium_python_sdk/blob/main/examples/example-get-balance.py) for an example of how to use the SDK.
 
 
+## Run an example from local install
 
+```bash
+ pip uninstall ostium-python-sdk  &&  pip install -e .  &&  python examples/example-pairs-details.py
+```
 
 
 
@@ -465,6 +472,11 @@ All notable changes to the Ostium Python SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.31] - 2025-01-13
+
+### Added
+- Add `get_formatted_pairs_details` on sdk class
+
 ## [0.1.25] - 2025-01-13
 
 ### Added

{ostium_python_sdk-0.1.28 → ostium_python_sdk-0.1.31}/setup.py

@@ -12,7 +12,7 @@ if changelog_path.exists():
 
 setup(
     name="ostium-python-sdk",
-    version="0.1.28",
+    version="0.1.31",
     packages=find_packages(),
     install_requires=[
         "web3>=6.0.0",

ostium_python_sdk-0.1.28/ostium_python_sdk/sdk.py

@@ -1,65 +0,0 @@
-from dotenv import load_dotenv
-import os
-
-from ostium_python_sdk.faucet import Faucet
-from .balance import Balance
-from .price import Price
-from web3 import Web3
-from .ostium import Ostium
-from .config import NetworkConfig
-from typing import Union
-from .subgraph import SubgraphClient
-
-
-class OstiumSDK:
-    def __init__(self, network: Union[str, NetworkConfig], private_key: str = None, rpc_url: str = None):
-        load_dotenv()
-        self.private_key = private_key or os.getenv('PRIVATE_KEY')
-        if not self.private_key:
-            raise ValueError(
-                "No private key provided. Please provide via constructor or PRIVATE_KEY environment variable")
-
-        self.rpc_url = rpc_url or os.getenv('RPC_URL')
-        if not self.rpc_url:
-            network_name = "mainnet" if isinstance(
-                network, str) and network == "mainnet" else "testnet"
-            raise ValueError(
-                f"No RPC URL provided for {network_name}. Please provide via constructor or RPC_URL environment variable")
-
-        # Initialize Web3
-        self.w3 = Web3(Web3.HTTPProvider(self.rpc_url))
-
-        # Get network configuration
-        if isinstance(network, NetworkConfig):
-            self.network_config = network
-        elif isinstance(network, str):
-            if network == "mainnet":
-                self.network_config = NetworkConfig.mainnet()
-            elif network == "testnet":
-                self.network_config = NetworkConfig.testnet()
-            else:
-                raise ValueError(
-                    f"Unsupported network: {network}. Use 'mainnet' or 'testnet'")
-        else:
-            raise ValueError(
-                "Network must be either a NetworkConfig instance or a string ('mainnet' or 'testnet')")
-
-        # Initialize Ostium instance
-        self.ostium = Ostium(
-            self.w3,
-            self.network_config.contracts["usdc"],
-            self.network_config.contracts["tradingStorage"],
-            self.network_config.contracts["trading"],
-            private_key=self.private_key
-        )
-
-        # Initialize subgraph client
-        self.subgraph = SubgraphClient(url=self.network_config.graph_url)
-
-        self.balance = Balance(self.w3, self.network_config.contracts["usdc"])
-        self.price = Price()
-
-        if self.network_config.is_testnet:
-            self.faucet = Faucet(self.w3, self.private_key)
-        else:
-            self.faucet = None