ostium-python-sdk 0.1.22__tar.gz → 0.1.24__tar.gz

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.22
+Version: 0.1.24
 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
@@ -12,6 +12,14 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: web3>=6.0.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Ostium Python SDK
 
@@ -174,6 +182,9 @@ trade_params = {
 }
 
 try:
+  sdk.ostium.set_slippage_percentage(1)
+  print(f"Slippage percentage set to: {sdk.ostium.get_slippage_percentage()}%")
+
   # Get latest price for BTC
   latest_price, _ = await sdk.price.get_price("BTC", "USD")
   print(f"Latest price: {latest_price}")
@@ -224,7 +235,7 @@ except Exception as e:
 
 ### Create a Short ETH Limit Order
 
-This example shows how to create a short ETH limit order, 10% below the current ETHUSD price. 
+This example shows how to create a short ETH limit order, 10% above the current ETHUSD price. So if price goes up 10% we order a Short ETH trade.
 
 ```python
 # Get private key from environment variable
@@ -253,19 +264,19 @@ try:
     # Get latest price for ETH
     latest_price, _ = await sdk.price.get_price("ETH", "USD")
     print(f"Latest price: {latest_price}")
-    # Execute trade at current market price
+    # Execute LIMIT trade order at 10% above the current price
     receipt = sdk.ostium.perform_trade(order_params, at_price=latest_price * 1.1)
     print(
         f"Order successful! Transaction hash: {receipt['transactionHash'].hex()}")
 
-    # Wait for the transaction to be confirmed
+    # Wait for the order to be confirmed
     await asyncio.sleep(10)
 
     # Get public address from private key
     account = Account.from_key(private_key)
     trader_public_address = account.address
 
-    # Get the trade details
+    # Get the order details
     open_orders = await sdk.subgraph.get_orders(trader_public_address)
     for order_index, order_data in enumerate(open_orders):
         print(f"Order {order_index + 1}: {order_data}\n")
@@ -281,8 +292,24 @@ except Exception as e:
     print(f"Order failed: {str(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 the stop loss price.
+<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
+TBD
+
+### Add control of Slippage (also in the SDK) - Not only default
+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
+
 
+### Funding rate calculation - SDK to get breakdown of FF, RF, PnL, etc.
+TBD
 
 
 ## Example Usage Scripts

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/README.md

@@ -159,6 +159,9 @@ trade_params = {
 }
 
 try:
+  sdk.ostium.set_slippage_percentage(1)
+  print(f"Slippage percentage set to: {sdk.ostium.get_slippage_percentage()}%")
+
   # Get latest price for BTC
   latest_price, _ = await sdk.price.get_price("BTC", "USD")
   print(f"Latest price: {latest_price}")
@@ -209,7 +212,7 @@ except Exception as e:
 
 ### Create a Short ETH Limit Order
 
-This example shows how to create a short ETH limit order, 10% below the current ETHUSD price. 
+This example shows how to create a short ETH limit order, 10% above the current ETHUSD price. So if price goes up 10% we order a Short ETH trade.
 
 ```python
 # Get private key from environment variable
@@ -238,19 +241,19 @@ try:
     # Get latest price for ETH
     latest_price, _ = await sdk.price.get_price("ETH", "USD")
     print(f"Latest price: {latest_price}")
-    # Execute trade at current market price
+    # Execute LIMIT trade order at 10% above the current price
     receipt = sdk.ostium.perform_trade(order_params, at_price=latest_price * 1.1)
     print(
         f"Order successful! Transaction hash: {receipt['transactionHash'].hex()}")
 
-    # Wait for the transaction to be confirmed
+    # Wait for the order to be confirmed
     await asyncio.sleep(10)
 
     # Get public address from private key
     account = Account.from_key(private_key)
     trader_public_address = account.address
 
-    # Get the trade details
+    # Get the order details
     open_orders = await sdk.subgraph.get_orders(trader_public_address)
     for order_index, order_data in enumerate(open_orders):
         print(f"Order {order_index + 1}: {order_data}\n")
@@ -266,8 +269,24 @@ except Exception as e:
     print(f"Order failed: {str(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 the stop loss price.
+<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
+TBD
+
+### Add control of Slippage (also in the SDK) - Not only default
+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
+
 
+### Funding rate calculation - SDK to get breakdown of FF, RF, PnL, etc.
+TBD
 
 
 ## Example Usage Scripts

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/ostium_python_sdk/ostium.py

@@ -1,6 +1,7 @@
 import os
 import traceback
 from enum import Enum
+from ostium_python_sdk.constants import PRECISION_2
 from web3 import Web3
 from .abi import usdc_abi, ostium_trading_abi, ostium_trading_storage_abi
 from .utils import convert_to_scaled_integer, fromErrorCodeToMessage, get_tp_sl_prices, to_base_units
@@ -33,6 +34,14 @@ class Ostium:
         self.ostium_trading_contract = self.web3.eth.contract(
             address=self.ostium_trading_address, abi=ostium_trading_abi)
 
+        self.slippage_percentage = 9 * PRECISION_2
+
+    def set_slippage_percentage(self, slippage_percentage):
+        self.slippage_percentage = slippage_percentage * PRECISION_2
+
+    def get_slippage_percentage(self):
+        return self.slippage_percentage / PRECISION_2
+
     def _get_account(self) -> Account:
         """Get account from stored private key"""
         return self.web3.eth.account.from_key(self.private_key)

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/ostium_python_sdk/sdk.py

@@ -54,6 +54,5 @@ class OstiumSDK:
         # 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()  
-    
+        self.balance = Balance(self.w3, self.network_config.contracts["usdc"])
+        self.price = Price()

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/ostium_python_sdk/subgraph.py

@@ -185,3 +185,53 @@ class SubgraphClient:
         result = await self.client.execute_async(query, variable_values={"trader": trader})
 
         return result['limits']
+
+    async def get_recent_history(self, trader, last_n_orders=10):
+        query = gql(
+            """
+        query ListOrdersHistory($trader: Bytes, $last_n_orders: Int) {
+          orders(
+            where: { trader: $trader, isPending: false}
+            first: $last_n_orders
+            orderBy: executedAt
+            orderDirection: desc
+          ) {
+            id
+            isBuy
+            trader
+            notional
+            tradeNotional
+            collateral
+            leverage
+            orderType
+            orderAction
+            price
+            initiatedAt
+            executedAt
+            executedTx
+            isCancelled
+            cancelReason
+            profitPercent
+            totalProfitPercent
+            isPending
+            amountSentToTrader
+            rolloverFee
+            fundingFee
+            pair {
+              id
+              from
+              to
+              feed
+              longOI
+              shortOI
+              group {
+                  name
+              }
+            }
+          }
+        }
+        """
+        )
+        result = await self.client.execute_async(query, variable_values={"trader": trader, "last_n_orders": last_n_orders})
+
+        return list(reversed(result['orders']))  # Reverse the final list

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/ostium_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: ostium-python-sdk
-Version: 0.1.22
+Version: 0.1.24
 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
@@ -12,6 +12,14 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: web3>=6.0.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Ostium Python SDK
 
@@ -174,6 +182,9 @@ trade_params = {
 }
 
 try:
+  sdk.ostium.set_slippage_percentage(1)
+  print(f"Slippage percentage set to: {sdk.ostium.get_slippage_percentage()}%")
+
   # Get latest price for BTC
   latest_price, _ = await sdk.price.get_price("BTC", "USD")
   print(f"Latest price: {latest_price}")
@@ -224,7 +235,7 @@ except Exception as e:
 
 ### Create a Short ETH Limit Order
 
-This example shows how to create a short ETH limit order, 10% below the current ETHUSD price. 
+This example shows how to create a short ETH limit order, 10% above the current ETHUSD price. So if price goes up 10% we order a Short ETH trade.
 
 ```python
 # Get private key from environment variable
@@ -253,19 +264,19 @@ try:
     # Get latest price for ETH
     latest_price, _ = await sdk.price.get_price("ETH", "USD")
     print(f"Latest price: {latest_price}")
-    # Execute trade at current market price
+    # Execute LIMIT trade order at 10% above the current price
     receipt = sdk.ostium.perform_trade(order_params, at_price=latest_price * 1.1)
     print(
         f"Order successful! Transaction hash: {receipt['transactionHash'].hex()}")
 
-    # Wait for the transaction to be confirmed
+    # Wait for the order to be confirmed
     await asyncio.sleep(10)
 
     # Get public address from private key
     account = Account.from_key(private_key)
     trader_public_address = account.address
 
-    # Get the trade details
+    # Get the order details
     open_orders = await sdk.subgraph.get_orders(trader_public_address)
     for order_index, order_data in enumerate(open_orders):
         print(f"Order {order_index + 1}: {order_data}\n")
@@ -281,8 +292,24 @@ except Exception as e:
     print(f"Order failed: {str(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 the stop loss price.
+<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
+TBD
+
+### Add control of Slippage (also in the SDK) - Not only default
+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
+
 
+### Funding rate calculation - SDK to get breakdown of FF, RF, PnL, etc.
+TBD
 
 
 ## Example Usage Scripts

{ostium_python_sdk-0.1.22 → ostium_python_sdk-0.1.24}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="ostium-python-sdk",
-    version="0.1.22",
+    version="0.1.24",
     packages=find_packages(),
     install_requires=[
         "web3>=6.0.0",