ostium-python-sdk 2.0.3__tar.gz → 2.0.5__tar.gz

{ostium_python_sdk-2.0.3 → ostium_python_sdk-2.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ostium-python-sdk
-Version: 2.0.3
+Version: 2.0.5
 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
@@ -56,7 +56,8 @@ Basically you can perfrom any operation that is supported by the Ostium's web si
 
 - Get list of feeds and their details
 - Create a Trade/Order
-- Close a Trade, Set Take Profit, Set Stop Loss
+- Close a Trade, Partial Close a trade, Set Take Profit, Set Stop Loss
+- Add Colleteral, Remove Collateral
 - Cancel an Order, Set Take Profit, Set Stop Loss, Set Entry Price
 - Read Open Trades aka Positions
 - Read Open Orders (Limit, Stop)
@@ -151,10 +152,10 @@ if not rpc_url:
 
 # Initialize SDK (default: verbose=False for quiet operation)
 configTestnet = NetworkConfig.testnet()
-sdk = OstiumSDK(configTestnet, private_key)
+sdk = OstiumSDK(configTestnet, private_key, rpc_url)
 
 # For verbose mode with detailed logging:
-sdk = OstiumSDK(configTestnet, private_key, verbose=True)
+sdk = OstiumSDK(configTestnet, private_key, rpc_url, verbose=True)
 ```
 
 <b>NOTE:</b> create a .env file with PRIVATE_KEY and RPC_URL to use the SDK. An RPC URL is required to use the SDK. You can get one by signing up for a free account at https://www.alchemy.com/ and creating an app. 
@@ -178,7 +179,7 @@ As you can see above, we show use case on testnet. In order to use Ostium on tes
 ```python
 # Get current token amount from faucet
 # On testnet
-sdk = OstiumSDK(NetworkConfig.testnet(), private_key)
+sdk = OstiumSDK(NetworkConfig.testnet(), private_key, rpc_url)
 
 # Check if tokens can be requested
 if sdk.faucet.can_request_tokens(address):
@@ -261,20 +262,20 @@ if not rpc_url:
 
 # Initialize SDK
 config = NetworkConfig.testnet()
-sdk = OstiumSDK(config, private_key)
+sdk = OstiumSDK(config, private_key, rpc_url)
 
 # Or, initialize:
 #
 # (1) mainnet:
 #
 # config = NetworkConfig.mainnet()
-# sdk = OstiumSDK(config, private_key)
+# sdk = OstiumSDK(config, private_key, rpc_url)
 # 
 # (2) with explicit private key & rpc url, i.e: not read from env variables
 # sdk = OstiumSDK(
 #     network="arbitrum",
 #     private_key="your_private_key_here",
-#     rpc_url="https://arb1.arbitrum.io/rpc"
+#     rpc_url="https://arb1.arbitrum.io/rpc...."
 # )
 
 # Get all available pairs
@@ -390,7 +391,7 @@ if not rpc_url:
 
 # Initialize SDK
 config = NetworkConfig.testnet()
-sdk = OstiumSDK(config, private_key)
+sdk = OstiumSDK(config, private_key, rpc_url)
 
 # Define trade parameters
 order_params = {
@@ -421,6 +422,11 @@ try:
     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")
+        limit_type, _, _, _, _, _, _, pairIndex, index, _, _ = get_order_details(order_data)
+        print(f"You can cancel_limit_order / update_limit_order using pair_id: {pairIndex} and index: {index}\n")
+        receipt = sdk.ostium.cancel_limit_order(pairIndex, index)
+        print(
+        f"Limit Order cancelled! Transaction hash: {receipt['transactionHash'].hex()}")
 
     if len(open_orders) == 0:
         print(
@@ -544,6 +550,20 @@ 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.5] - 2025-05-26
+
+- Support new ABIs from smart-contracts v.1.2.3: PairInfo, PairStorage, Trading, TradingStorage, Vault.
+- Fix getTradeLiquidationPrice() exposed in sdk.get_open_trade_metrics()
+- Allow get_open_trades() with an optional parameter trader_address
+- Add sdk.get_rollover_rate_for_pair_id()
+
+## [2.0.4] - 2025-05-26
+
+### Added
+- `track_order_and_trade` that let's you track an order status until its processed.
+- Added support for delegation which allows an approved
+  address (delegate) to execute trades on behalf of another address (trader).
+
 ## [2.0.3] - 2025-03-06
 
 ### Added

{ostium_python_sdk-2.0.3 → ostium_python_sdk-2.0.5}/README.md

@@ -17,7 +17,8 @@ Basically you can perfrom any operation that is supported by the Ostium's web si
 
 - Get list of feeds and their details
 - Create a Trade/Order
-- Close a Trade, Set Take Profit, Set Stop Loss
+- Close a Trade, Partial Close a trade, Set Take Profit, Set Stop Loss
+- Add Colleteral, Remove Collateral
 - Cancel an Order, Set Take Profit, Set Stop Loss, Set Entry Price
 - Read Open Trades aka Positions
 - Read Open Orders (Limit, Stop)
@@ -112,10 +113,10 @@ if not rpc_url:
 
 # Initialize SDK (default: verbose=False for quiet operation)
 configTestnet = NetworkConfig.testnet()
-sdk = OstiumSDK(configTestnet, private_key)
+sdk = OstiumSDK(configTestnet, private_key, rpc_url)
 
 # For verbose mode with detailed logging:
-sdk = OstiumSDK(configTestnet, private_key, verbose=True)
+sdk = OstiumSDK(configTestnet, private_key, rpc_url, verbose=True)
 ```
 
 <b>NOTE:</b> create a .env file with PRIVATE_KEY and RPC_URL to use the SDK. An RPC URL is required to use the SDK. You can get one by signing up for a free account at https://www.alchemy.com/ and creating an app. 
@@ -139,7 +140,7 @@ As you can see above, we show use case on testnet. In order to use Ostium on tes
 ```python
 # Get current token amount from faucet
 # On testnet
-sdk = OstiumSDK(NetworkConfig.testnet(), private_key)
+sdk = OstiumSDK(NetworkConfig.testnet(), private_key, rpc_url)
 
 # Check if tokens can be requested
 if sdk.faucet.can_request_tokens(address):
@@ -222,20 +223,20 @@ if not rpc_url:
 
 # Initialize SDK
 config = NetworkConfig.testnet()
-sdk = OstiumSDK(config, private_key)
+sdk = OstiumSDK(config, private_key, rpc_url)
 
 # Or, initialize:
 #
 # (1) mainnet:
 #
 # config = NetworkConfig.mainnet()
-# sdk = OstiumSDK(config, private_key)
+# sdk = OstiumSDK(config, private_key, rpc_url)
 # 
 # (2) with explicit private key & rpc url, i.e: not read from env variables
 # sdk = OstiumSDK(
 #     network="arbitrum",
 #     private_key="your_private_key_here",
-#     rpc_url="https://arb1.arbitrum.io/rpc"
+#     rpc_url="https://arb1.arbitrum.io/rpc...."
 # )
 
 # Get all available pairs
@@ -351,7 +352,7 @@ if not rpc_url:
 
 # Initialize SDK
 config = NetworkConfig.testnet()
-sdk = OstiumSDK(config, private_key)
+sdk = OstiumSDK(config, private_key, rpc_url)
 
 # Define trade parameters
 order_params = {
@@ -382,6 +383,11 @@ try:
     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")
+        limit_type, _, _, _, _, _, _, pairIndex, index, _, _ = get_order_details(order_data)
+        print(f"You can cancel_limit_order / update_limit_order using pair_id: {pairIndex} and index: {index}\n")
+        receipt = sdk.ostium.cancel_limit_order(pairIndex, index)
+        print(
+        f"Limit Order cancelled! Transaction hash: {receipt['transactionHash'].hex()}")
 
     if len(open_orders) == 0:
         print(

ostium_python_sdk-2.0.5/ostium_python_sdk/abi/__init__.py

@@ -0,0 +1,7 @@
+from .usdc_abi import usdc_abi
+from .trading_abi import trading_abi
+from .trading_storage_abi import trading_storage_abi
+from .faucet_testnet_abi import faucet_abi
+
+__all__ = ['usdc_abi', 'trading_abi',
+           'trading_storage_abi', 'faucet_abi']