feat(debank): Add token_use

blockapi/test/v2/api/debank/test_debank_portfolio_parser.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from decimal import Decimal
 
-from blockapi.v2.models import AssetType
+from blockapi.v2.models import AssetType, TokenRole
 from blockapi.v2.api.debank import DebankModelPortfolioItem, DebankModelPoolItemDetail
 
 
@@ -37,6 +37,10 @@ def test_portfolio_stores_raw_item(portfolio_parser, portfolio_response):
 def test_parse_supply_token_list(portfolio_parser, portfolio_response):
     items = portfolio_parser.parse([portfolio_response])[0].items
     filtered = [item for item in items if item.asset_type == AssetType.LENDING]
+    for b in filtered:
+        assert b.token_role == TokenRole.SUPPLY
+        assert b.pool_id == '0xdc13687554205e5b89ac783db14bb5bba4a1edac'
+
     assert len(filtered) == 1
 
 
@@ -45,6 +49,10 @@ def test_parse_borrow_token_list(portfolio_parser, portfolio_response):
     filtered = [item for item in items if item.asset_type == AssetType.LENDING_BORROW]
     assert len(filtered) == 3
 
+    for b in filtered:
+        assert b.token_role == TokenRole.BORROW
+        assert b.pool_id == '0xdc13687554205e5b89ac783db14bb5bba4a1edac'
+
 
 def test_parse_portfolio(portfolio_parser, complex_portfolio_response):
     parsed_items = portfolio_parser.parse(complex_portfolio_response)

blockapi/v2/api/debank.py

@@ -22,6 +22,7 @@
     CoinInfo,
     Pool,
     Protocol,
+    TokenRole,
 )
 
 logger = logging.getLogger(__name__)
@@ -147,13 +148,17 @@ def parse(
         asset_type: AssetType = AssetType.AVAILABLE,
         is_wallet: bool = True,
         token_set: Optional[List[str]] = None,
+        token_role: Optional[TokenRole] = None,
+        pool_id: Optional[str] = None,
     ) -> List[BalanceItem]:
         items = []
         for item in response:
             balance_item = DebankModelBalanceItem(**item)
             balance_item.raw_value = item
 
-            balance = self.parse_item(balance_item, asset_type, is_wallet, token_set)
+            balance = self.parse_item(
+                balance_item, asset_type, is_wallet, token_set, token_role, pool_id
+            )
             if balance is not None:
                 items.append(balance)
 
@@ -165,6 +170,8 @@ def parse_item(
         asset_type: AssetType = AssetType.AVAILABLE,
         is_wallet: bool = True,
         token_set: Optional[List[str]] = None,
+        token_role: Optional[TokenRole] = None,
+        pool_id: Optional[str] = None,
     ) -> Optional[BalanceItem]:
         raw_amount = balance_item.raw_amount or 0
         amount = balance_item.amount or 0
@@ -196,6 +203,8 @@ def parse_item(
             protocol=self._protocols.get(balance_item.protocol_id),
             is_wallet=is_wallet,
             token_set=token_set,
+            token_role=token_role,
+            pool_id=pool_id,
         )
 
         return balance
@@ -308,10 +317,30 @@ def _parse_portfolio_item(
 
         items = []
 
-        tokens = self._update_items(items, detail.supply_token_list, asset_type)
-        self._update_items(items, detail.borrow_token_list, borrow_type, tokens)
-        self._update_items(items, detail.reward_token_list, reward_type, tokens)
-        self._update_items(items, detail.token_list, asset_type)
+        tokens = self._update_items(
+            items,
+            detail.supply_token_list,
+            asset_type,
+            token_role=TokenRole.SUPPLY,
+            pool_id=pool_id,
+        )
+        self._update_items(
+            items,
+            detail.borrow_token_list,
+            borrow_type,
+            tokens,
+            token_role=TokenRole.BORROW,
+            pool_id=pool_id,
+        )
+        self._update_items(
+            items,
+            detail.reward_token_list,
+            reward_type,
+            tokens,
+            token_role=TokenRole.REWARD,
+            pool_id=pool_id,
+        )
+        self._update_items(items, detail.token_list, asset_type, pool_id=pool_id)
 
         pool = pools.get(pool_id)
 
@@ -337,6 +366,8 @@ def _update_items(
         raw_balances: list[dict],
         asset_type: AssetType,
         tokens: Optional[List[str]] = None,
+        token_role: Optional[TokenRole] = None,
+        pool_id: Optional[str] = None,
     ):
         if not raw_balances:
             return
@@ -358,6 +389,8 @@ def _update_items(
             asset_type,
             False,
             token_set=tokens if len(raw_balances) > 1 else None,
+            token_role=token_role,
+            pool_id=pool_id,
         )
 
         items.extend(balances)

blockapi/v2/models.py

@@ -77,6 +77,13 @@ class AssetType(str, Enum):
     ASSET = 'asset'
 
 
+class TokenRole(str, Enum):
+    SUPPLY = 'supply'
+    REWARD = 'reward'
+    BORROW = 'borrow'
+    LIQUIDITY_POOL = 'liquidity_pool'
+
+
 @attr.s(auto_attribs=True, slots=True)
 class ApiOptions:
     blockchain: Blockchain
@@ -196,6 +203,8 @@ class BalanceItem:
     protocol: Optional[Protocol] = attr.ib(default=None)
     is_wallet: bool = True
     token_set: Optional[List[str]] = attr.ib(default=None)
+    token_role: Optional[TokenRole] = attr.ib(default=None)
+    pool_id: Optional[str] = attr.ib(default=None)
 
     @classmethod
     def from_api(
@@ -209,6 +218,8 @@ def from_api(
         protocol: Optional[Protocol] = None,
         is_wallet: bool = True,
         token_set: Optional[List[str]] = None,
+        token_role: Optional[TokenRole] = None,
+        pool_id: Optional[str] = None,
     ) -> 'BalanceItem':
         return cls(
             balance_raw=to_decimal(balance_raw),
@@ -220,6 +231,8 @@ def from_api(
             protocol=protocol,
             is_wallet=is_wallet,
             token_set=token_set,
+            token_role=token_role,
+            pool_id=pool_id,
         )
 
     def __add__(self, other: 'BalanceItem') -> 'BalanceItem':

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name='blockapi',
-    version='0.1.20',
+    version='0.1.21',
     author='Devmons s.r.o.',
     description='BlockAPI library',
     license='MIT',