ostium-python-sdk 2.0.21__tar.gz → 3.0.0__tar.gz

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ostium-python-sdk
-Version: 2.0.21
+Version: 3.0.0
 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
@@ -540,6 +540,43 @@ 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).
 
+## [3.0.0] - 2025-10-15
+
+### Breaking Changes
+- **IMPORTANT**: Updated to support new Ostium Protocol contract upgrade
+- `perform_trade()` now includes BuilderFee parameter in contract calls
+- `close_trade()` now requires `market_price` parameter and includes slippage protection
+
+### Added
+- Builder fee support in `perform_trade()` via optional `builder_address` and `builder_fee` parameters
+- Market price parameter in `close_trade()` for accurate slippage calculation
+- Automatic slippage protection when closing trades
+- New `close_timeout()` method to handle timed out close market orders (retry or cancel)
+- New `open_market_timeout()` method to execute timed out open market orders
+- New test suite for builder fee functionality
+
+### Changed
+- `close_trade()` signature now requires `market_price` as third parameter
+- Contract calls now use updated ABI with BuilderFee struct for `openTrade`
+- Contract calls now use updated ABI with market price and slippage for `closeTradeMarket`
+
+### Migration Guide
+- For `perform_trade()`: No changes needed if not using builder fees (defaults to zero)
+- For `close_trade()`: Must now provide current market price as third parameter
+  ```python
+  # Old: sdk.ostium.close_trade(pair_id, trade_index, close_percentage)
+  # New: sdk.ostium.close_trade(pair_id, trade_index, market_price, close_percentage)
+  ```
+- New timeout handling methods for managing timed out orders:
+  ```python
+  # Handle a timed out close order
+  sdk.ostium.close_timeout(order_id, retry=True)  # Retry the close
+  sdk.ostium.close_timeout(order_id, retry=False) # Cancel the close
+  
+  # Execute a timed out open order
+  sdk.ostium.open_market_timeout(order_id)  # Execute the open trade
+  ```
+
 ## [2.0.18] - 2025-06-23
 
 - Add delegate support for cancel_limit_order

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/ostium_python_sdk/abi/trading_abi.py

@@ -30,6 +30,11 @@ trading_abi = [
         "name": "AlreadyMarketClosed",
         "type": "error"
     },
+    {
+        "inputs": [],
+        "name": "BelowFees",
+        "type": "error"
+    },
     {
         "inputs": [],
         "name": "BelowMinLevPos",
@@ -1429,11 +1434,6 @@ trading_abi = [
     },
     {
         "inputs": [
-            {
-                "internalType": "address",
-                "name": "trader",
-                "type": "address"
-            },
             {
                 "internalType": "uint16",
                 "name": "pairIndex",
@@ -1444,68 +1444,20 @@ trading_abi = [
                 "name": "index",
                 "type": "uint8"
             },
-            {
-                "internalType": "enum IOstiumTradingStorage.LimitOrder",
-                "name": "orderType",
-                "type": "uint8"
-            }
-        ],
-        "name": "checkNoPendingTrigger",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "trader",
-                "type": "address"
-            },
             {
                 "internalType": "uint16",
-                "name": "pairIndex",
-                "type": "uint16"
-            },
-            {
-                "internalType": "uint8",
-                "name": "index",
-                "type": "uint8"
-            }
-        ],
-        "name": "checkNoPendingTriggers",
-        "outputs": [
-            {
-                "internalType": "bool",
-                "name": "",
-                "type": "bool"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint16",
-                "name": "pairIndex",
+                "name": "closePercentage",
                 "type": "uint16"
             },
             {
-                "internalType": "uint8",
-                "name": "index",
-                "type": "uint8"
+                "internalType": "uint192",
+                "name": "marketPrice",
+                "type": "uint192"
             },
             {
-                "internalType": "uint16",
-                "name": "closePercentage",
-                "type": "uint16"
+                "internalType": "uint32",
+                "name": "slippageP",
+                "type": "uint32"
             }
         ],
         "name": "closeTradeMarket",
@@ -1754,6 +1706,23 @@ trading_abi = [
                 "name": "t",
                 "type": "tuple"
             },
+            {
+                "components": [
+                    {
+                        "internalType": "address",
+                        "name": "builder",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "uint32",
+                        "name": "builderFee",
+                        "type": "uint32"
+                    }
+                ],
+                "internalType": "struct IOstiumTradingStorage.BuilderFee",
+                "name": "bf",
+                "type": "tuple"
+            },
             {
                 "internalType": "enum IOstiumTradingStorage.OpenOrderType",
                 "name": "orderType",

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/ostium_python_sdk/ostium.py

@@ -1,3 +1,4 @@
+import decimal
 import traceback
 import asyncio
 from decimal import Decimal
@@ -130,6 +131,27 @@ class Ostium:
                     raise Exception('Invalid order type')
 
             slippage = int(self.slippage_percentage * PRECISION_2)
+            
+            # Create BuilderFee struct with default values (zero address and zero fee)
+            # Can be customized if builder fees are needed in the future
+            builder_fee = {
+                'builder': '0x0000000000000000000000000000000000000000',  # Zero address
+                'builderFee': 0  # Zero fee
+            }
+            
+            # Check if custom builder fee is provided in trade_params
+            if 'builder_address' in trade_params and 'builder_fee' in trade_params:
+
+                if not self.web3.is_address(trade_params['builder_address']):
+                    raise Exception('Invalid builder address format')
+                
+                if trade_params['builder_fee'] > 0.5:
+                    raise Exception('Builder fee too high: Max 0.5 (0.5%)')
+                
+                builder_fee = {
+                    'builder': trade_params['builder_address'],
+                    'builderFee': convert_to_scaled_integer(trade_params['builder_fee'], precision=4, scale=6)
+                }
 
             if self.use_delegation and 'trader_address' in trade_params:
                 # Use delegatedAction when delegation is enabled
@@ -138,9 +160,9 @@ class Ostium:
                     f"Using delegatedAction to trade on behalf of {trader_address}")
 
                 # The correct way to encode the function call in Web3.py
-                # Create the function object for openTrade
+                # Create the function object for openTrade with BuilderFee parameter
                 open_trade_func = self.ostium_trading_contract.functions.openTrade(
-                    trade, order_type, slippage
+                    trade, builder_fee, order_type, slippage
                 )
 
                 # Get the encoded data for the openTrade function call
@@ -152,9 +174,9 @@ class Ostium:
                     trader_address, inner_encoded_data
                 ).build_transaction({'from': account.address})
             else:
-                # Standard direct function call (no delegation)
+                # Standard direct function call (no delegation) with BuilderFee parameter
                 trade_tx = self.ostium_trading_contract.functions.openTrade(
-                    trade, order_type, slippage
+                    trade, builder_fee, order_type, slippage
                 ).build_transaction({'from': account.address})
 
             trade_tx['nonce'] = self.get_nonce(account.address)
@@ -241,13 +263,14 @@ class Ostium:
             raise Exception(
                 f'{reason_string}\n\n{suggestion}' if suggestion != None else reason_string)
 
-    def close_trade(self, pair_id, trade_index, close_percentage=100, trader_address=None):
+    def close_trade(self, pair_id, trade_index, market_price, close_percentage=100, trader_address=None):
         """
         Close a trade partially or completely
 
         Args:
             pair_id: The ID of the trading pair
             trade_index: The index of the trade
+            market_price: The current market price for the trade
             close_percentage: The percentage of the position to close (1-100, default: 100)
             trader_address: Optional address of the trader if different from the account (for delegation)
 
@@ -258,15 +281,22 @@ class Ostium:
         account = self._get_account()
 
         close_percentage = to_base_units(close_percentage, decimals=2)
+        
+        # Convert market price to the correct format (uint192)
+        market_price_scaled = convert_to_scaled_integer(market_price)
+        
+        # Calculate slippage using the same percentage as for opening trades
+        slippage = int(self.slippage_percentage * PRECISION_2)
 
         if self.use_delegation and trader_address:
             self.log(
                 f"Using delegatedAction to close trade on behalf of {trader_address}")
 
             # The correct way to encode the function call in Web3.py
-            # Create the function object for closeTradeMarket
+            # Create the function object for closeTradeMarket with new parameters
             close_trade_func = self.ostium_trading_contract.functions.closeTradeMarket(
-                int(pair_id), int(trade_index), int(close_percentage)
+                int(pair_id), int(trade_index), int(close_percentage), 
+                market_price_scaled, slippage
             )
 
             # Get the encoded data for the closeTradeMarket function call
@@ -278,9 +308,10 @@ class Ostium:
                 trader_address, inner_encoded_data
             ).build_transaction({'from': account.address})
         else:
-            # Standard direct function call (no delegation)
+            # Standard direct function call (no delegation) with new parameters
             trade_tx = self.ostium_trading_contract.functions.closeTradeMarket(
-                int(pair_id), int(trade_index), int(close_percentage)
+                int(pair_id), int(trade_index), int(close_percentage),
+                market_price_scaled, slippage
             ).build_transaction({'from': account.address})
 
         trade_tx['nonce'] = self.get_nonce(account.address)
@@ -314,6 +345,122 @@ class Ostium:
             'order_id': order_id
         }
 
+    def close_market_timeout(self, order_id, retry=False, trader_address=None):
+        """
+        Close a trade that has timed out in the market
+        
+        Args:
+            order_id: The ID of the order that has timed out
+            retry: Whether to retry the close operation (True) or cancel it (False)
+            trader_address: Optional address of the trader if different from the account (for delegation)
+        
+        Returns:
+            A dictionary containing the transaction receipt
+        """
+        self.log(f"Closing market timeout for order {order_id}, retry={retry}")
+        account = self._get_account()
+        
+        try:
+            if self.use_delegation and trader_address:
+                self.log(
+                    f"Using delegatedAction to close market timeout on behalf of {trader_address}")
+                
+                close_market_timeout_func = self.ostium_trading_contract.functions.closeTradeMarketTimeout(
+                    int(order_id), bool(retry)
+                )
+                
+                inner_encoded_data = close_market_timeout_func.build_transaction({'gas': 0})['data']
+                
+                tx = self.ostium_trading_contract.functions.delegatedAction(
+                    trader_address, inner_encoded_data
+                ).build_transaction({'from': account.address})
+            else:
+                tx = self.ostium_trading_contract.functions.closeTradeMarketTimeout(
+                    int(order_id), bool(retry)
+                ).build_transaction({'from': account.address})
+            
+            tx['nonce'] = self.get_nonce(account.address)
+            
+            signed_tx = self.web3.eth.account.sign_transaction(
+                tx, private_key=self.private_key)
+            tx_hash = self.web3.eth.send_raw_transaction(
+                signed_tx.raw_transaction)
+            self.log(f"Close Market Timeout TX Hash: {tx_hash.hex()}")
+            
+            receipt = self.web3.eth.wait_for_transaction_receipt(tx_hash)
+            self.log(f"Close Market Timeout successful for order {order_id}")
+            
+            return {
+                'receipt': receipt,
+                'order_id': order_id,
+                'retry': retry
+            }
+            
+        except Exception as e:
+            reason_string, suggestion = fromErrorCodeToMessage(
+                e, verbose=self.verbose)
+            print(
+                f"An error ({str(e)}) occurred during close market timeout - parsed as {reason_string}")
+            raise Exception(
+                f'{reason_string}\n\n{suggestion}' if suggestion != None else reason_string)
+
+    def open_market_timeout(self, order_id, trader_address=None):
+        """
+        Open/execute a trade that has timed out in the market
+        
+        Args:
+            order_id: The ID of the order that has timed out
+            trader_address: Optional address of the trader if different from the account (for delegation)
+        
+        Returns:
+            A dictionary containing the transaction receipt
+        """
+        self.log(f"Opening market timeout for order {order_id}")
+        account = self._get_account()
+        
+        try:
+            if self.use_delegation and trader_address:
+                self.log(
+                    f"Using delegatedAction to open market timeout on behalf of {trader_address}")
+                
+                open_timeout_func = self.ostium_trading_contract.functions.openTradeMarketTimeout(
+                    int(order_id)
+                )
+                
+                inner_encoded_data = open_timeout_func.build_transaction({'gas': 0})['data']
+                
+                tx = self.ostium_trading_contract.functions.delegatedAction(
+                    trader_address, inner_encoded_data
+                ).build_transaction({'from': account.address})
+            else:
+                tx = self.ostium_trading_contract.functions.openTradeMarketTimeout(
+                    int(order_id)
+                ).build_transaction({'from': account.address})
+            
+            tx['nonce'] = self.get_nonce(account.address)
+            
+            signed_tx = self.web3.eth.account.sign_transaction(
+                tx, private_key=self.private_key)
+            tx_hash = self.web3.eth.send_raw_transaction(
+                signed_tx.raw_transaction)
+            self.log(f"Open Market Timeout TX Hash: {tx_hash.hex()}")
+            
+            receipt = self.web3.eth.wait_for_transaction_receipt(tx_hash)
+            self.log(f"Open Market Timeout successful for order {order_id}")
+            
+            return {
+                'receipt': receipt,
+                'order_id': order_id
+            }
+            
+        except Exception as e:
+            reason_string, suggestion = fromErrorCodeToMessage(
+                e, verbose=self.verbose)
+            print(
+                f"An error ({str(e)}) occurred during open market timeout - parsed as {reason_string}")
+            raise Exception(
+                f'{reason_string}\n\n{suggestion}' if suggestion != None else reason_string)
+
     def remove_collateral(self, pair_id, trade_index, remove_amount):
         self.log(
             f"Remove collateral for trade for pair {pair_id}, index {trade_index}: {remove_amount} USDC")

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ostium-python-sdk
-Version: 2.0.21
+Version: 3.0.0
 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
@@ -540,6 +540,43 @@ 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).
 
+## [3.0.0] - 2025-10-15
+
+### Breaking Changes
+- **IMPORTANT**: Updated to support new Ostium Protocol contract upgrade
+- `perform_trade()` now includes BuilderFee parameter in contract calls
+- `close_trade()` now requires `market_price` parameter and includes slippage protection
+
+### Added
+- Builder fee support in `perform_trade()` via optional `builder_address` and `builder_fee` parameters
+- Market price parameter in `close_trade()` for accurate slippage calculation
+- Automatic slippage protection when closing trades
+- New `close_timeout()` method to handle timed out close market orders (retry or cancel)
+- New `open_market_timeout()` method to execute timed out open market orders
+- New test suite for builder fee functionality
+
+### Changed
+- `close_trade()` signature now requires `market_price` as third parameter
+- Contract calls now use updated ABI with BuilderFee struct for `openTrade`
+- Contract calls now use updated ABI with market price and slippage for `closeTradeMarket`
+
+### Migration Guide
+- For `perform_trade()`: No changes needed if not using builder fees (defaults to zero)
+- For `close_trade()`: Must now provide current market price as third parameter
+  ```python
+  # Old: sdk.ostium.close_trade(pair_id, trade_index, close_percentage)
+  # New: sdk.ostium.close_trade(pair_id, trade_index, market_price, close_percentage)
+  ```
+- New timeout handling methods for managing timed out orders:
+  ```python
+  # Handle a timed out close order
+  sdk.ostium.close_timeout(order_id, retry=True)  # Retry the close
+  sdk.ostium.close_timeout(order_id, retry=False) # Cancel the close
+  
+  # Execute a timed out open order
+  sdk.ostium.open_market_timeout(order_id)  # Execute the open trade
+  ```
+
 ## [2.0.18] - 2025-06-23
 
 - Add delegate support for cancel_limit_order

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/ostium_python_sdk.egg-info/SOURCES.txt

@@ -35,6 +35,8 @@ ostium_python_sdk/scscript/funding.py
 ostium_python_sdk/scscript/pairinfos.py
 tests/__init__.py
 tests/conftest.py
+tests/disabled_test_builder_fee.py
+tests/disabled_test_close_trade.py
 tests/disabled_test_funding.py
 tests/disabled_test_slippage.py
 tests/test_current_total_profit_p.py

{ostium_python_sdk-2.0.21 → ostium_python_sdk-3.0.0}/setup.py

@@ -22,7 +22,7 @@ if changelog_path.exists():
 
 setup(
     name="ostium-python-sdk",
-    version="2.0.21",
+    version="3.0.0",
     packages=find_packages(),
     install_requires=read_requirements('requirements.txt'),
     extras_require={