ostium-python-sdk 2.0.15__tar.gz → 2.0.17__tar.gz

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ostium-python-sdk
-Version: 2.0.15
+Version: 2.0.17
 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
@@ -463,38 +463,6 @@ except Exception as e:
 
 <b>NOTE:</b> Similiarly you can create a Stop order, just use 'STOP' as the order_type and make sure at_price is set to an acceptable stop loss price.
 
-
-### Add Colateral
-
-Added in version 0.1.2
-
-### Add control of Slippage - Not only default 2%
-
-Added in version 0.1.25
-
-### Remove Colleteral - Add when Audit is done
-TBD
-
-### Tp / Sl - explain not specifying what means - 900 % for TP max and SL meaning
-TBD
-
-### Maybe take or Make sure we have the error mapping from code to string errro msgs.
-TBD
-
-
-### Get a certain Pair Net Rate % (Funding Fees, Rollover)
-
-```bash 
-### Use sdk.get_pair_net_rate_percent_per_hours()
-```
-
-### Open Trade Fees calculation - SDK to get breakdown of FF, RF, PnL, etc.
-
-```bash
-## Use sdk.get_open_trade_metrics()
-```
-
-
 ## Example Usage Scripts
 
 More examples can be found in the [examples](https://github.com/0xOstium/ostium_python_sdk/tree/main/examples) folder.
@@ -572,6 +540,19 @@ 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).
 
+## [2.0.17] - 2025-06-03
+
+- Return target_funding_rate from getPendingAccFundingFees() 
+
+## [2.0.16] - 2025-05-31
+
+- query optional different address in sdk.get_open_trade_metrics()
+
+## [2.0.15] - 2025-05-28
+
+- Updated Readme with list of pairs
+- Add additional fields to get_open_trade_metrics: bid, mid, ask, status
+
 ## [2.0.12] - 2025-05-28
 
 - return isDayTradingClosed in sdk.get_formatted_pairs_details()

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/README.md

@@ -424,38 +424,6 @@ except Exception as e:
 
 <b>NOTE:</b> Similiarly you can create a Stop order, just use 'STOP' as the order_type and make sure at_price is set to an acceptable stop loss price.
 
-
-### Add Colateral
-
-Added in version 0.1.2
-
-### Add control of Slippage - Not only default 2%
-
-Added in version 0.1.25
-
-### Remove Colleteral - Add when Audit is done
-TBD
-
-### Tp / Sl - explain not specifying what means - 900 % for TP max and SL meaning
-TBD
-
-### Maybe take or Make sure we have the error mapping from code to string errro msgs.
-TBD
-
-
-### Get a certain Pair Net Rate % (Funding Fees, Rollover)
-
-```bash 
-### Use sdk.get_pair_net_rate_percent_per_hours()
-```
-
-### Open Trade Fees calculation - SDK to get breakdown of FF, RF, PnL, etc.
-
-```bash
-## Use sdk.get_open_trade_metrics()
-```
-
-
 ## Example Usage Scripts
 
 More examples can be found in the [examples](https://github.com/0xOstium/ostium_python_sdk/tree/main/examples) folder.

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/ostium_python_sdk/formulae.py

@@ -242,7 +242,7 @@ def GetFundingRate(
     sFactorDownScaleP: str,
     verbose: bool = False
 ):
-    acc_funding_long, acc_funding_short, latest_funding_rate = getPendingAccFundingFees(
+    acc_funding_long, acc_funding_short, latest_funding_rate, target_funding_rate = getPendingAccFundingFees(
         blockNumber=Decimal(latestBlock),
         lastUpdateBlock=Decimal(lastUpdateBlock),
         valueLong=Decimal(accPerOiLong) / PRECISION_18,
@@ -264,5 +264,5 @@ def GetFundingRate(
         'accFundingLong': acc_funding_long,
         'accFundingShort': acc_funding_short,
         'latestFundingRate': latest_funding_rate,
-        # 'targetFundingRate': target_fr
+        'targetFundingRate': target_funding_rate
     }

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/ostium_python_sdk/formulae_wrapper.py

@@ -144,7 +144,7 @@ def get_trade_metrics(trade_details, price_data, block_number, pair_max_leverage
     pnl = Decimal(pnl_raw)
     pnl_percent = Decimal(pnl_percent_raw)
     net_pnl = Decimal(total_profit_raw)
-    
+
     funding = Decimal(trade_funding_fee)
     rollover = Decimal(trade_rollover_fee)
     net_value = net_pnl + (Decimal(trade_details['collateral']) / PRECISION_6)

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/ostium_python_sdk/scscript/funding.py

@@ -78,7 +78,7 @@ def getPendingAccFundingFees(
             valueShort -= accFundingRate
             valueLong += (accFundingRate * openInterestUsdcShort / openInterestUsdcLong).quantize(quantization_18, rounding=ROUND_DOWN) if openInterestUsdcLong > 0 else 0
 
-    return (valueLong.quantize(quantization_18, rounding=ROUND_DOWN), valueShort.quantize(quantization_18, rounding=ROUND_DOWN), fr.quantize(quantization_18, rounding=ROUND_DOWN))
+    return (valueLong.quantize(quantization_18, rounding=ROUND_DOWN), valueShort.quantize(quantization_18, rounding=ROUND_DOWN), fr.quantize(quantization_18, rounding=ROUND_DOWN), targetFr.quantize(quantization_18, rounding=ROUND_DOWN))
 
 
 def exponentialApproximation(value):

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/ostium_python_sdk/sdk.py

@@ -107,8 +107,8 @@ class OstiumSDK:
     # such as: funding fee, roll over fee, Unrealized Pnl, Profit Percent, etc.
     #
     # Will thorw in case SDK instantiated with no private key
-    async def get_open_trade_metrics(self, pair_id, trade_index):
-        open_trades, trader_public_address = await self.get_open_trades()
+    async def get_open_trade_metrics(self, pair_id, trade_index, trader_address=None):
+        open_trades, trader_public_address = await self.get_open_trades(trader_address)
 
         liq_margin_threshold_p = await self.subgraph.get_liq_margin_threshold_p()
         self.log(

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ostium-python-sdk
-Version: 2.0.15
+Version: 2.0.17
 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
@@ -463,38 +463,6 @@ except Exception as e:
 
 <b>NOTE:</b> Similiarly you can create a Stop order, just use 'STOP' as the order_type and make sure at_price is set to an acceptable stop loss price.
 
-
-### Add Colateral
-
-Added in version 0.1.2
-
-### Add control of Slippage - Not only default 2%
-
-Added in version 0.1.25
-
-### Remove Colleteral - Add when Audit is done
-TBD
-
-### Tp / Sl - explain not specifying what means - 900 % for TP max and SL meaning
-TBD
-
-### Maybe take or Make sure we have the error mapping from code to string errro msgs.
-TBD
-
-
-### Get a certain Pair Net Rate % (Funding Fees, Rollover)
-
-```bash 
-### Use sdk.get_pair_net_rate_percent_per_hours()
-```
-
-### Open Trade Fees calculation - SDK to get breakdown of FF, RF, PnL, etc.
-
-```bash
-## Use sdk.get_open_trade_metrics()
-```
-
-
 ## Example Usage Scripts
 
 More examples can be found in the [examples](https://github.com/0xOstium/ostium_python_sdk/tree/main/examples) folder.
@@ -572,6 +540,19 @@ 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).
 
+## [2.0.17] - 2025-06-03
+
+- Return target_funding_rate from getPendingAccFundingFees() 
+
+## [2.0.16] - 2025-05-31
+
+- query optional different address in sdk.get_open_trade_metrics()
+
+## [2.0.15] - 2025-05-28
+
+- Updated Readme with list of pairs
+- Add additional fields to get_open_trade_metrics: bid, mid, ask, status
+
 ## [2.0.12] - 2025-05-28
 
 - return isDayTradingClosed in sdk.get_formatted_pairs_details()

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/setup.py

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

{ostium_python_sdk-2.0.15 → ostium_python_sdk-2.0.17}/tests/test_get_pending_acc_funding_fees.py

@@ -79,7 +79,7 @@ test_cases = [
 def test_get_pending_acc_funding_fees(test_case):
     """Test getPendingAccFundingFees function with various test cases"""
     # Call the function with test case parameters
-    acc_funding_long, acc_funding_short, latest_funding_rate = getPendingAccFundingFees(
+    acc_funding_long, acc_funding_short, latest_funding_rate, target_funding_rate = getPendingAccFundingFees(
         blockNumber=test_case['blockNumber'],
         lastUpdateBlock=test_case['lastUpdateBlock'],
         valueLong=test_case['valueLong'],
@@ -102,7 +102,7 @@ def test_get_pending_acc_funding_fees(test_case):
     print(f"acc_funding_long: {acc_funding_long}")
     print(f"acc_funding_short: {acc_funding_short}")
     print(f"latest_funding_rate: {latest_funding_rate}")
-
+    print(f"target_funding_rate: {target_funding_rate}")
     # Assertions
     assert acc_funding_long == pytest.approx(test_case['expected_acc_funding_long'], rel=Decimal('1e-12')), \
         f"acc_funding_long {acc_funding_long} != {test_case['expected_acc_funding_long']}"