indev

Author: hschickdevs

alpha_homora_v2/abi/TraderJoeLP_ABI.json

@@ -8,8 +8,8 @@
 
 def get_token_price(token_symbol: str):
     """Get the realtime USD price of a token"""
-    path = join(abspath((dirname(__file__))), "resources", "coingecko_token_id.csv")
+    path = join(abspath((dirname(__file__))), "resources", "token_metadata.csv")
     id_df = pd.read_csv(path, index_col=0)
-    token_id = id_df['id'].loc[token_symbol]
+    token_id = id_df['coingecko_id'].loc[token_symbol]
 
     return cg.get_price(ids=token_id, vs_currencies='usd')[token_id]['usd']

alpha_homora_v2/oracle.py

@@ -4,7 +4,7 @@
 from typing import Optional, Union
 
 from .resources.abi_reference import *
-from .util import ContractInstanceFunc, cov_from
+from .util import ContractInstanceFunc, cov_from, get_token_info_from_ref
 from .spell import SpellClient, PangolinV2Client, TraderJoeV1Client
 from .oracle import get_token_price
 
@@ -123,18 +123,17 @@ def get_rewards_value(self) -> tuple[float, float, str, str]:
         :return:
             - reward_amount (float) (in the native reward token)
             - reward_value (float) (in USD)
-            - reward_token_address (address str)
+            - reward_token_address (str)
             - reward_token_symbol (str)
         """
+        if self.dex != "Pangolin V2":
+            raise NotImplementedError("This feature is currently only available for positions on the Pangolin V2 DEX")
+        
         owner, coll_token, coll_id, collateral_size = self.get_position_info()
-        print("Untouched Collateral Size:", collateral_size)
 
         pool_info = self.platform.get_pool_info(coll_id)
-        if self.dex == "Pangolin V2":
-            entryRewardPerShare = pool_info['entryRewardPerShare'] / 1e18
-            accRewardPerShare = pool_info['accRewardPerShare'] / 1e18
-        else:
-            raise NotImplementedError("Currently this feature is only available for positions on the Pangolin V2 DEX")
+        entryRewardPerShare = pool_info['entryRewardPerShare'] / 1e18
+        accRewardPerShare = pool_info['accRewardPerShare'] / 1e18
 
         if accRewardPerShare >= entryRewardPerShare:
             reward_amount = collateral_size * (accRewardPerShare - entryRewardPerShare) / 1e12
@@ -155,10 +154,130 @@ def get_debt_ratio(self) -> float:
 
         return borrow_credit / collateral_credit
 
-    def get_position_value(self) -> tuple:
-        """Returns the value of the position in USD and AVAX"""
-        raise NotImplementedError
-
+    def get_position_value(self):
+        """
+        Get equity, debt, and total position value in AVAX and USD.
+
+        :return: (dict)
+            - equity_avax (float)
+            - equity_usd (float)
+            - debt_avax (float)
+            - debt_usd (float)
+            - position_avax (float)
+            - position_usd (float)
+        """
+        # Get pool info & underlying token metadata
+        pool_info = self.get_pool_info()
+        underlying_token_data = [get_token_info_from_ref(token) for token in self.get_pool_info()['tokens']]
+
+        # Get AVAX price once since operation is heavily reliant on this value
+        avax_price = get_token_price("AVAX")
+
+        # Get token pair liquidity pool data:
+        pool_instance = self.platform.get_lp_contract(pool_info['lpTokenAddress'])
+        collateral_size = self.get_position_info()[-1]
+        r0, r1, last_block_time = pool_instance.functions.getReserves().call()
+        supply = pool_instance.functions.totalSupply().call()
+
+        # Process values by token to get full totals:
+        debt_value_usd = 0
+        debt_value_avax = 0
+        position_value_usd = 0
+        position_value_avax = 0
+        for i, token_reserve_amt in enumerate([r0, r1]):
+            token_price_usd = get_token_price(underlying_token_data[i]["symbol"])
+            precision = int(underlying_token_data[i]['precision'])
+
+            owned_reserve_amt = (token_reserve_amt * collateral_size // supply) / 10 ** precision
+            owned_reserve_amt_usd = owned_reserve_amt * token_price_usd
+            # print(f"{underlying_token_data[i]['symbol']} owned_reserve_amt_usd:", owned_reserve_amt_usd)
+
+            # Get & calculate token debt for underlying token:
+            borrow_bal = self.homora_bank.functions.\
+                borrowBalanceCurrent(self.pos_id, Web3.toChecksumAddress(underlying_token_data[i]['address'])).call()
+            token_debt = borrow_bal / 10 ** precision
+            token_debt_usd = token_debt * token_price_usd
+            token_debt_avax = token_debt_usd / avax_price
+
+            # Add debt values to total debt valye count
+            debt_value_usd += token_debt_usd
+            debt_value_avax += token_debt_avax
+
+            # Add owned reserve values to total position value count
+            position_value_usd += owned_reserve_amt_usd
+            position_value_avax += owned_reserve_amt_usd * (1 / avax_price)
+
+        # Derive equity values from position and debt:
+        total_equity_avax = position_value_avax - debt_value_avax
+        total_equity_usd = position_value_usd - debt_value_usd
+
+        return {"equity_avax": total_equity_avax, "equity_usd": total_equity_usd,
+                "debt_avax": debt_value_avax, "debt_usd": debt_value_usd,
+                "position_avax": position_value_avax, "position_usd": position_value_usd}
+
+    # Deprecated but left temporarily for backup and reference:
+    # def get_position_value(self):
+    #     """
+    #     Get equity value, debt value, and total position value in AVAX and USD.
+    #
+    #     :return: (dict)
+    #         - equity_avax (float)
+    #         - equity_usd (float)
+    #         - debt_avax (float)
+    #         - debt_usd (float)
+    #         - position_avax (float)
+    #         - position_usd (float)
+    #     """
+    #     pool_info = self.get_pool_info()
+    #     underlying_token_data = [get_token_info_from_ref(token) for token in self.get_pool_info()['tokens']]
+    #     lp_address = pool_info['lpTokenAddress']
+    #     avax_price = get_token_price("AVAX")
+    #
+    #     pool_instance = self.platform.get_lp_contract(lp_address)
+    #
+    #     collateral_size = self.get_position_info()[-1]
+    #
+    #     r0, r1, last_block_time = pool_instance.functions.getReserves().call()
+    #     supply = pool_instance.functions.totalSupply().call()
+    #
+    #     token0_amount = (r0 * collateral_size / supply) / 10 ** int(underlying_token_data[0]['precision'])
+    #     token1_amount = (r1 * collateral_size / supply) / 10 ** int(underlying_token_data[1]['precision'])
+
+    #     position_value_usd = token0_amount + (token1_amount * avax_price)
+    #     position_value_avax = position_value_usd * (1 / avax_price)
+    #
+    #     print("Position Value:", position_value_usd)
+    #
+    #     # Get debts for underlying tokens:
+    #     total_debt_usd = 0.0
+    #     total_debt_avax = 0.0
+    #     for i, token in enumerate(pool_info['tokens']):
+    #         borrow_bal = self.homora_bank.functions.borrowBalanceCurrent(self.pos_id,
+    #                                                                      Web3.toChecksumAddress(token)).call()
+    #         mtd = get_token_info_from_ref(token)
+    #         if mtd is None:
+    #             raise ValueError(f"Could not locate token metadata for {token}")
+    #
+    #         token_price_usd = get_token_price(mtd['symbol'])
+    #
+    #         bbal_in_token = borrow_bal / 10 ** int(mtd['precision'])
+    #         bbal_in_usd = bbal_in_token * token_price_usd
+    #         bbal_in_avax = bbal_in_token / get_token_price('AVAX')
+    #
+    #         total_debt_usd += bbal_in_usd
+    #         total_debt_avax += bbal_in_avax
+    #
+    #         print(f"{mtd['symbol']} | "
+    #               f"token{i}_amount: {[token0_amount, token1_amount][i]} | "
+    #               f"r{i}: {[r0, r1][i]}")
+    #
+    #     equity_avax = position_value_avax - total_debt_avax
+    #     equity_usd = position_value_usd - total_debt_usd
+    #
+    #     return {"equity_avax": equity_avax, "equity_usd": equity_usd,
+    #             "debt_avax": total_debt_avax, "debt_usd": total_debt_usd,
+    #             "position_avax": position_value_avax, "position_usd": position_value_usd}
+        
     """ ------------------------------------------ UTILITY ------------------------------------------ """
     def get_platform(self, identifier: str) -> SpellClient:
         """Determine what dex the position is on (i.e. Trader Joe, Pangolin V2, Sushiswap, etc)"""

alpha_homora_v2/position.py

@@ -1,5 +1,7 @@
 """
-Config file contains ABI filename and contract address pairs for each ABI
+Config file contains tuples:
+    (ABI filename, contract address)
+For each required ABI.
 
 These pairs can be passed into the ContractInstanceFunc class using unpacking e.g. ContractInstanceFunc(*HomoraBank_ABI)
 """
@@ -12,14 +14,8 @@
 WMasterchefJoeV2_ABI = "WMasterchefJoeV2_ABI.json",'0xB41DE9c1f50697cC3Fd63F24EdE2B40f6269CBcb'
 MasterChefJoeV2_ABI = "MasterChefJoeV2_ABI.json", "0xd6a4F121CA35509aF06A0Be99093d08462f53052"
 WMiniChefPNG_ABI = 'WMiniChefPNG.json', '0xa67CF61b0b9BC39c6df04095A118e53BFb9303c7'
-PangolinLiquidity_ABI = 'PangolinLiquidityABI.json','0xbd918Ed441767fe7924e99F6a0E0B568ac1970D9'
 USDCe_ABI = 'USDC.e_ABI.json', '0xA7D7079b0FEaD91F3e65f86E8915Cb59c1a4C664'
 MiniChefV2_ABI = 'Minichef_v2ABI.json', '0x1f806f7C8dED893fd3caE279191ad7Aa3798E928'
 SushiswapSpellV1_ABI = "SushiswapSpellV1.json", "0xc4a59cfed3fe06bdb5c21de75a70b20db280d8fe"
-
-# Chainlink Price Feeds
-
-
-# OTHER:
-PNG_DECIMALS = 18
-JOE_DECIMALS = 18
+PangolinLiquidity_ABI = 'PangolinLiquidityABI.json', None
+TraderJoeLP_ABI = 'TraderJoeLP_ABI.json', None

alpha_homora_v2/resources/abi_reference.py

@@ -0,0 +1,16 @@
+symbol,coingecko_id,precision,address
+AVAX,avalanche-2,18,fvweahmxkfeig8snevq42hc6whryy3efyavebmqdndgcgxn5z
+PNG,pangolin,18,0x60781c2586d68229fde47564546784ab3faca982
+ETH,ethereum,18,0xf20d962a6c8f70c731bd838a3a388d7d48fa6e15
+JOE,joe,18,0x6e84a6216ea6dacc71ee8e6b0a5b7322eebc0fdd
+USDC,usd,6,0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e
+USDC.e,usd,6,0xa7d7079b0fead91f3e65f86e8915cb59c1a4c664
+WETH.e,ethereum,18,0x49d5c2bdffac6ce2bfdb6640f4f80f226bc10bab
+WAVAX,avalanche-2,18,0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7
+DAI.e,dai,18,0xd586e7f844cea2f87f50152665bcbc2c279d8d70
+WBTC.e,bitcoin,8,0x50b7545627a5162f82a992c33b87adc75187b218
+USDT.e,usd,6,0xc7198437980c041c805a1edcba50c1ce5db95118
+LINK.e,link,18,0x5947bb275c521040051d82396192181b413227a3
+ALPHA.e,aavegotchi-alpha,18,0x2147efff675e4a4ee1c2f918d181cdbd7a8e208f
+MIM,mim,18,0x130966628846bfd36ff31a822705796e8cb8c18d
+UST.axl,usd,6,0x260bbf5698121eb85e7a74f2e45e16ce762ebe11

alpha_homora_v2/resources/coingecko_token_id.csv

@@ -2,6 +2,7 @@
 from os.path import join, abspath, dirname
 from os import getcwd, pardir
 
+import web3.eth
 from web3 import Web3
 from web3.middleware import geth_poa_middleware
 from web3.contract import ContractFunction
@@ -18,6 +19,7 @@ class SpellClient:
     def __init__(self, web3_provider: Web3, abi_filename: str, contract_address: str,
                  coll_contract_abi_filename: str, coll_contract_address: str,
                  staking_contract_abi_filename: str, staking_contract_address: str):
+        self.w3_provider = web3_provider
         self.spell_contract = ContractInstanceFunc(web3_provider,
                                              abi_filename, contract_address)
         self.address = Web3.toChecksumAddress(contract_address)
@@ -60,6 +62,17 @@ def get_pool_info(self, coll_id) -> dict:
 
         Returns a dict with key value pairs since the output is variable depending on the platform.
         """
+        pass
+
+    def get_lp_contract(self, lp_token_address: str) -> web3.eth.Contract:
+        """
+        Returns a contract instance for the liquidity pool matching the given address.
+        This address can be found using the get_pool_info() class method in the positions.AlphaHomoraV2Position.
+
+        :param lp_token_address: The contract address for the liquidity pool token on the Spell's network.
+        :return: Contract instance for using the LP pool methods.
+        """
+        pass
 
 
 class SushiswapSpellsV1Client(SpellClient):
@@ -125,6 +138,9 @@ def get_pool_info(self, coll_id) -> dict:
                 "allocPoint": pool_info[1], "lastRewardTimestamp": pool_info[2], "accRewardPerShare": pool_info[3],
                 "rewarderAddress": pool_info[4]}
 
+    def get_lp_contract(self, lp_token_address: str) -> web3.eth.Contract:
+        return ContractInstanceFunc(self.w3_provider, TraderJoeLP_ABI[0], lp_token_address)
+
 
 class PangolinV2Client(SpellClient):
     def __init__(self, web3_provider: Web3):
@@ -180,3 +196,6 @@ def get_pool_info(self, coll_id) -> dict:
         # return pid, entryRewardPerShare, *pool_info
         return {"pid": pid, "entryRewardPerShare": entryRewardPerShare, "accRewardPerShare": pool_info[0],
                 "lastRewardTimestamp": pool_info[1], "allocPoint": pool_info[2]}
+
+    def get_lp_contract(self, lp_token_address: str) -> web3.eth.Contract:
+        return ContractInstanceFunc(self.w3_provider, PangolinLiquidity_ABI[0], lp_token_address)

alpha_homora_v2/resources/token_metadata.csv

@@ -1,11 +1,13 @@
 from os.path import join, abspath, dirname
 from os import getcwd, pardir
 import json
+from typing import Union
+import csv
 
 import requests
 from web3 import Web3
-from web3.eth import Contract
 from web3.middleware import geth_poa_middleware
+import web3.eth
 
 
 def cov_from(amount):
@@ -21,7 +23,7 @@ def get_web3_provider(network_rpc_url: str) -> Web3:
     return provider
 
 
-def ContractInstanceFunc(web3_provider: Web3, json_abi_file, contract_address):
+def ContractInstanceFunc(web3_provider: Web3, json_abi_file, contract_address) -> web3.eth.Contract:
     """
     Set up the contract instance with the provided ABI and address
 
@@ -50,6 +52,27 @@ def store_abi(abi_url: str, abi_filename: str, abi_path: str = None) -> None:
     """
     contract_abi = requests.get(abi_url).json()
 
-    path = join(abspath(join(dirname(__file__), pardir)), "abi", abi_filename) if abi_path is None else abi_path
+    path = join(join(dirname(__file__)), "abi", abi_filename) if abi_path is None else abi_path
     with open(path, "w") as json_file:
         json_file.write(json.dumps(contract_abi, indent=2))
+
+def get_token_info_from_ref(identifier: str) -> Union[dict, None]:
+    """
+    Get the token info row (dict) from the reference file (resources/token_metadata.csv)
+    
+    :param identifier: Either the token symbol or the token address
+    :return: The token info as a dict:
+        {'symbol (str)', 'coingecko_id (str)', 'precision (str need to convert to int)', 'address (str)'}
+    """
+    path = join(abspath((dirname(__file__))), "resources", "token_metadata.csv")
+    with open(path) as csv_file:
+        reader = csv.DictReader(csv_file)
+        for row in reader:
+            if row["symbol"].upper() == identifier.upper() or row['address'] == identifier.lower():
+                return row
+    return None
+
+def get_all_pool_underlying_token_addresses() -> dict:
+    """Did not use exchange identifier because this was used to aggregate all supported tokens for the reference in resources"""
+    r = requests.get("https://homora-api.alphafinance.io/v2/43114/pools").json()
+    return {pool['name']: [(pool['name'].split('/')[i], token) for i, token in enumerate(pool['tokens'])] for pool in r}