indev

Author: hschickdevs

README.md

@@ -3,11 +3,14 @@
   <a href ="https://homora-v2.alphaventuredao.io/"><img src="img/ahv2.png" alt="Alpha Homora V2 Logo" height="200"></a>
   <br></br>
   <h2 align="center"><strong>Alpha-Homora-V2-Python</strong></h2>
+    <a href="https://homora-v2.alphaventuredao.io/"><img src="https://img.shields.io/website?down_color=red&down_message=Disconnected&label=Alpha%20Homora%20V2&up_color=blue&up_message=Online&url=https%3A%2F%2Fhomora-v2.alphaventuredao.io%2F"/></a>
+    <img src="https://img.shields.io/badge/Python-3.9%2B-yellow"/>
+    <a href="https://github.com/PathX-Projects/Alpha-Homora-V2-Python/issues"><img src="https://img.shields.io/github/issues/PathX-Projects/Alpha-Homora-V2-Python?color=red"/></a>
     <p align="center">
-        A Python3.9+ package that models open Alpha Homora V2 positions to simplify interaction with their smart contracts in your Python projects.
+        A Python3.9+ package that wraps Alpha Homora V2 positions to simplify interaction with their smart contracts in your Python projects.
     </p>
     <h3><strong>Current Features</strong></h3>
-    <i>Rewards Value | Position Value | Debt & Leverage Ratio | Pool Info | <del>Current APY</del></i><br>
+    <i>Rewards Value | Position Value | Debt & Leverage Ratio | Pool Info | Current APY</i><br>
     <i>Harvest Rewards | Close Position | Add & Remove Liquidity</i><br>
     <h3><strong>Current Supported Networks</strong></h3>
     <i>Avalanche</i><br>
@@ -54,7 +57,7 @@ How to use the package:
 
 1. Import the AvalanchePosition class into your Python script:
     ```python
-    from alpha_homora_v2.position import AvalanchePosition
+    from alpha_homora_v2 import AvalanchePosition
     ```
 
 2. **(Optional)** Instantiate your custom Web3 provider object to interact with the network:
@@ -105,10 +108,31 @@ How to use the package:
    # NOTE: Passing the private key is optional, but required if you want to use transactional methods on the returned AvalanchePosition object(s).
    ```
 5. Use your position instance(s) to interact with the Alpha Homora V2 position smart contracts on the network:
+   - Transactional Methods:
+     - Return a [TransactionReceipt](alpha_homora_v2/receipt.py) object upon success
+     - Private wallet key ***required*** for use to sign transactions
+     - See the documentation in the [AvalanchePosition](alpha_homora_v2/position.py) class for function parameters.
+     ```python
+     # Add liquidity to the LP
+     position.add(params)
+
+     # Remove liquidity from the LP
+     position.remove(params)
+
+     # Harvest available rewards:
+     position.harvest()
+
+     # Close the position:
+     position.close()
+     ```
    - Informational Methods
      - Return JSON data
      - Private wallet key ***not required*** for use
+     - See [`examples/position_info.ipynb`](examples\avalanche\position_info.ipynb) for output examples.
      ```python
+     # Get position value (equity, debt, and position value):
+     position.get_position_value()
+
      # Get value of harvestable rewards:
      position.get_rewards_value()
 
@@ -118,25 +142,23 @@ How to use the package:
      # Get the current leverage ratio:
      position.get_leverage_ratio()
 
-     # Get position value (equity, debt, and position value):
-     position.get_position_value()
-
-     # (WIP) Get current pool APY (Only returns trading and farmng APY)
+     # Get current pool APY
      position.get_current_apy()
 
+     # Get underlying tokens and LP for the pool:
+     position.get_pool_tokens()
+
+     # Get the debt of each token in the position (token, debt_uint256, debt_token, debt_usd):
+     position.get_tokens_debts()
+     # Alternatively, get the debt of a single token:
+     position.get_token_debts(token_address)
+
+     # Get all token borrow rates from CREAM:
+     position.get_cream_borrow_rates()
+
      # get LP pool info:
      position.pool
      ```
-   - Transactional Methods:
-     - Return a [TransactionReceipt](alpha_homora_v2/receipt.py) object upon success
-     - Private wallet key ***required*** for use to sign transactions
-     ```python
-     # Harvest available rewards:
-     position.harvest()
-
-     # Close the position:
-     position.close()
-     ```
 
 ## Uninstallation:
 

alpha_homora_v2/__init__.py

@@ -1,2 +1,4 @@
+from .position import AvalanchePosition
+
 __version__ = "2.0.0"
 

alpha_homora_v2/position.py

@@ -45,7 +45,8 @@ def __init__(self, position_id: int, owner_wallet_address: str, owner_private_ke
 
         self._oracle = AvalancheSafeOracle()
 
-    """ ------------------------------------------ PRIMARY ------------------------------------------ """
+    """ -------------------- TRANSACTIONAL METHODS: -------------------- """
+    
     def add(self,
             tokenA_data: tuple[ARC20Token, float, float] = None,
             tokenB_data: tuple[ARC20Token, float, float] = None,
@@ -61,6 +62,8 @@ def add(self,
                             (ARC20Token, supply_amount, borrow_amount)
         :param tokenLP_data: The LP token if supplying, supply amount, and borrow amount (optional)
                              (ARC20Token object, supply_amount, borrow_amount)
+                             
+        :return: TransactionReceipt object
         """
         self._has_private_key()
 
@@ -115,6 +118,8 @@ def remove(self, pct_position_size: float,
         :param tokenB_data: The second underlying (or native) token in the pool, and the percentage of this token debt to repay (e.g. 0.50 = 50% of USDC debt)
                             (ARC20Token, pct_amount_repay) (optional)
         :param amount_lp_withdraw: (Advanced) The amount of LP token to withdraw
+        
+        :return: TransactionReceipt object
         """
         self._has_private_key()
 
@@ -148,9 +153,7 @@ def close(self) -> TransactionReceipt:
         """
         Close the position if it is open
 
-        Returns:
-            - transaction hash
-            - transaction receipt
+        :return: TransactionReceipt object
         """
         self._has_private_key()
 
@@ -180,9 +183,9 @@ def harvest(self) -> Union[TransactionReceipt, None]:
 
         Returns:
             if there are rewards to harvest:
-                - transaction hash (str)
-                - transaction receipt (AttributeDict)
-            else None
+                - TransactionReceipt object
+            else:
+                - None
         """
         self._has_private_key()
 
@@ -195,6 +198,8 @@ def harvest(self) -> Union[TransactionReceipt, None]:
 
         return self._sign_and_send(encoded_bank_func)
 
+    """ -------------------- INFORMATIONAL METHODS: -------------------- """
+    
     def get_rewards_value(self) -> dict:  # tuple[float, float, str, str]
         """
         Get the amount of outstanding yield farming rewards in the position.
@@ -403,7 +408,7 @@ def get_token_debts(self) -> list[tuple[ARC20Token, int, float, float]]:
 
         return debt_output
 
-    """ ------------------------------------------ UTILITY ------------------------------------------ """
+    """ -------------------- UTILITY METHODS: -------------------- """
 
     def get_token_borrow_balance(self, token_address: str):
         return self._homora_bank.functions.borrowBalanceCurrent(self.pos_id, Web3.toChecksumAddress(token_address)).call()