Update Quipuswap contracts in demo (#53)

droserasprout · web-flow · commit 051aee2f5dc8 · 2021-05-31T11:27:57.000Z
diff --git a/src/demo_quipuswap/dipdup.yml b/src/demo_quipuswap/dipdup.yml
@@ -7,19 +7,13 @@ database:
 
 contracts:
   kusd_dex_mainnet:
-    address: KT1CiSKXR68qYSxnbzjwvfeMCRburaSDonT2
-    typename: quipu_fa12
-  tzbtc_dex_mainnet:
-    address: KT1N1wwNPqT5jGhM91GQ2ae5uY8UzFaXHMJS
+    address: KT1K4EwTpbvYN9agJdjpyJm4ZZdhpUNKB3F6
     typename: quipu_fa12
   kusd_token_mainnet:
     address: KT1K9gCRgaLRFKTErYt1wVxA3Frb9FjasjTV
     typename: fa12_token
-  tzbtc_token_mainnet:
-    address: KT1PWx2mnDueood7fEmfbBDKx1D9BAnnXitn
-    typename: fa12_token
   hdao_dex_mainnet:
-    address: KT1V41fGzkdTJki4d11T1Rp9yPkCmDhB7jph
+    address: KT1QxLqukyfohPV5kPkw97Rs6cw1DDDvYgbB
     typename: quipu_fa2
   hdao_token_mainnet:
     address: KT1AFA2mwNUMNd4SsujE1YYp29vd8BZejyKW
@@ -36,7 +30,14 @@ templates:
     datasource: tzkt_staging_mainnet
     contracts:
       - <dex_contract>
+    types:
+      - transaction
+      - origination
     handlers:
+      - callback: on_fa12_origination
+        pattern:
+          - type: origination
+            originated_contract: <dex_contract>
       - callback: on_fa12_token_to_tez
         pattern:
           - type: transaction
@@ -61,6 +62,11 @@ templates:
           - type: transaction
             destination: <token_contract>
             entrypoint: transfer
+      - callback: on_fa12_transfer
+        pattern:
+          - type: transaction
+            destination: <dex_contract>
+            entrypoint: transfer
       - callback: on_fa12_divest_liquidity
         pattern:
           - type: transaction
@@ -83,7 +89,14 @@ templates:
     datasource: tzkt_staging_mainnet
     contracts:
       - <dex_contract>
+    types:
+      - transaction
+      - origination
     handlers:
+      - callback: on_fa2_origination
+        pattern:
+          - type: origination
+            originated_contract: <dex_contract>
       - callback: on_fa2_token_to_tez
         pattern:
           - type: transaction
@@ -100,23 +113,28 @@ templates:
           - type: transaction
             destination: <token_contract>
             entrypoint: transfer
-      - callback: on_fa20_invest_liquidity
+      - callback: on_fa2_invest_liquidity
         pattern:
           - type: transaction
             destination: <dex_contract>
             entrypoint: investLiquidity
           - type: transaction
             destination: <token_contract>
             entrypoint: transfer
-      - callback: on_fa20_divest_liquidity
+      - callback: on_fa2_transfer
+        pattern:
+          - type: transaction
+            destination: <dex_contract>
+            entrypoint: transfer
+      - callback: on_fa2_divest_liquidity
         pattern:
           - type: transaction
             destination: <dex_contract>
             entrypoint: divestLiquidity
           - type: transaction
             destination: <token_contract>
             entrypoint: transfer
-      - callback: on_fa20_withdraw_profit
+      - callback: on_fa2_withdraw_profit
         pattern:
           - type: transaction
             destination: <dex_contract>
@@ -134,14 +152,6 @@ indexes:
       symbol: kUSD
       decimals: 18
 
-  # tzbtc_mainnet:
-  #   template: quipuswap_fa12
-  #   values:
-  #     dex_contract: tzbtc_dex_mainnet
-  #     token_contract: tzbtc_token_mainnet
-  #     symbol: tzBTC
-  #     decimals: 8
-
   hdao_mainnet:
     template: quipuswap_fa2
     values:
diff --git a/src/demo_quipuswap/handlers/on_fa12_origination.py b/src/demo_quipuswap/handlers/on_fa12_origination.py
@@ -0,0 +1,19 @@
+from typing import Optional
+
+import demo_quipuswap.models as models
+from demo_quipuswap.types.quipu_fa12.storage import QuipuFa12Storage
+from dipdup.models import OperationData, OperationHandlerContext, OriginationContext, TransactionContext
+
+
+async def on_fa12_origination(
+    ctx: OperationHandlerContext,
+    quipu_fa12_origination: OriginationContext[QuipuFa12Storage],
+) -> None:
+    if ctx.template_values is None:
+        raise Exception('This index must be templated')
+
+    symbol = ctx.template_values['symbol']
+
+    for address, value in quipu_fa12_origination.storage.storage.ledger.items():
+        shares_qty = value.balance
+        await models.Position(trader=address, symbol=symbol, shares_qty=shares_qty).save()
diff --git a/src/demo_quipuswap/handlers/on_fa12_transfer.py b/src/demo_quipuswap/handlers/on_fa12_transfer.py
@@ -0,0 +1,29 @@
+from typing import Optional
+
+import demo_quipuswap.models as models
+from demo_quipuswap.types.quipu_fa12.parameter.transfer import TransferParameter
+from demo_quipuswap.types.quipu_fa12.storage import QuipuFa12Storage
+from dipdup.models import OperationData, OperationHandlerContext, OriginationContext, TransactionContext
+
+
+async def on_fa12_transfer(
+    ctx: OperationHandlerContext,
+    transfer: TransactionContext[TransferParameter, QuipuFa12Storage],
+) -> None:
+    if ctx.template_values is None:
+        raise Exception('This index must be templated')
+
+    symbol = ctx.template_values['symbol']
+    from_address = transfer.parameter.from_
+    to_address = transfer.parameter.to
+    value = int(transfer.parameter.value)
+
+    from_position, _ = await models.Position.get_or_create(trader=from_address, symbol=symbol)
+    from_position.shares_qty -= value  # type: ignore
+    assert from_position.shares_qty >= 0, transfer.data.hash
+    await from_position.save()
+
+    to_position, _ = await models.Position.get_or_create(trader=to_address, symbol=symbol)
+    to_position.shares_qty += value  # type: ignore
+    assert to_position.shares_qty >= 0, transfer.data.hash
+    await to_position.save()
diff --git a/src/demo_quipuswap/handlers/on_fa12_withdraw_profit.py b/src/demo_quipuswap/handlers/on_fa12_withdraw_profit.py
@@ -10,7 +10,7 @@
 async def on_fa12_withdraw_profit(
     ctx: OperationHandlerContext,
     withdraw_profit: TransactionContext[WithdrawProfitParameter, QuipuFa12Storage],
-    transaction_0: Optional[OperationData],
+    transaction_0: Optional[OperationData] = None,
 ) -> None:
     if ctx.template_values is None:
         raise Exception('This index must be templated')
diff --git a/src/demo_quipuswap/handlers/on_fa2_divest_liquidity.py b/src/demo_quipuswap/handlers/on_fa2_divest_liquidity.py
@@ -8,7 +8,7 @@
 from dipdup.models import OperationHandlerContext, TransactionContext
 
 
-async def on_fa20_divest_liquidity(
+async def on_fa2_divest_liquidity(
     ctx: OperationHandlerContext,
     divest_liquidity: TransactionContext[DivestLiquidityParameter, QuipuFa2Storage],
     transfer: TransactionContext[TransferParameter, Fa2TokenStorage],
diff --git a/src/demo_quipuswap/handlers/on_fa2_invest_liquidity.py b/src/demo_quipuswap/handlers/on_fa2_invest_liquidity.py
@@ -8,7 +8,7 @@
 from dipdup.models import OperationHandlerContext, TransactionContext
 
 
-async def on_fa20_invest_liquidity(
+async def on_fa2_invest_liquidity(
     ctx: OperationHandlerContext,
     invest_liquidity: TransactionContext[InvestLiquidityParameter, QuipuFa2Storage],
     transfer: TransactionContext[TransferParameter, Fa2TokenStorage],
diff --git a/src/demo_quipuswap/handlers/on_fa2_origination.py b/src/demo_quipuswap/handlers/on_fa2_origination.py
@@ -0,0 +1,19 @@
+from typing import Optional
+
+import demo_quipuswap.models as models
+from demo_quipuswap.types.quipu_fa2.storage import QuipuFa2Storage
+from dipdup.models import OperationData, OperationHandlerContext, OriginationContext, TransactionContext
+
+
+async def on_fa2_origination(
+    ctx: OperationHandlerContext,
+    quipu_fa2_origination: OriginationContext[QuipuFa2Storage],
+) -> None:
+    if ctx.template_values is None:
+        raise Exception('This index must be templated')
+
+    symbol = ctx.template_values['symbol']
+
+    for address, value in quipu_fa2_origination.storage.storage.ledger.items():
+        shares_qty = value.balance
+        await models.Position(trader=address, symbol=symbol, shares_qty=shares_qty).save()
diff --git a/src/demo_quipuswap/handlers/on_fa2_transfer.py b/src/demo_quipuswap/handlers/on_fa2_transfer.py
@@ -0,0 +1,34 @@
+from typing import Optional
+
+import demo_quipuswap.models as models
+from demo_quipuswap.types.quipu_fa2.parameter.transfer import TransferParameter
+from demo_quipuswap.types.quipu_fa2.storage import QuipuFa2Storage
+from dipdup.models import OperationData, OperationHandlerContext, OriginationContext, TransactionContext
+
+
+async def on_fa2_transfer(
+    ctx: OperationHandlerContext,
+    transfer: TransactionContext[TransferParameter, QuipuFa2Storage],
+) -> None:
+    if ctx.template_values is None:
+        raise Exception('This index must be templated')
+
+    transfer_parameter = transfer.parameter.__root__[0]
+
+    symbol = ctx.template_values['symbol']
+    from_address = transfer_parameter.from_
+    from_position, _ = await models.Position.get_or_create(trader=from_address, symbol=symbol)
+
+    for transfer_tx in transfer_parameter.txs:
+        to_address = transfer_tx.to_
+        value = int(transfer_tx.amount)
+
+        from_position.shares_qty -= value  # type: ignore
+        assert from_position.shares_qty >= 0, transfer.data.hash
+
+        to_position, _ = await models.Position.get_or_create(trader=to_address, symbol=symbol)
+        to_position.shares_qty += value  # type: ignore
+        assert to_position.shares_qty >= 0, transfer.data.hash
+        await to_position.save()
+
+    await from_position.save()
diff --git a/src/demo_quipuswap/handlers/on_fa2_withdraw_profit.py b/src/demo_quipuswap/handlers/on_fa2_withdraw_profit.py
@@ -7,10 +7,10 @@
 from dipdup.models import OperationData, OperationHandlerContext, OriginationContext, TransactionContext
 
 
-async def on_fa20_withdraw_profit(
+async def on_fa2_withdraw_profit(
     ctx: OperationHandlerContext,
     withdraw_profit: TransactionContext[WithdrawProfitParameter, QuipuFa2Storage],
-    transaction_0: Optional[OperationData],
+    transaction_0: Optional[OperationData] = None,
 ) -> None:
 
     if ctx.template_values is None:
diff --git a/src/demo_quipuswap/types/quipu_fa12/parameter/transfer.py b/src/demo_quipuswap/types/quipu_fa12/parameter/transfer.py
@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  transfer.json
+
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+
+class TransferParameter(BaseModel):
+    from_: str = Field(..., alias='from')
+    to: str
+    value: str
diff --git a/src/demo_quipuswap/types/quipu_fa12/storage.py b/src/demo_quipuswap/types/quipu_fa12/storage.py
@@ -27,9 +27,9 @@ class Voters(BaseModel):
 
 
 class Storage(BaseModel):
+    baker_validator: str
     current_candidate: Optional[str]
     current_delegated: Optional[str]
-    invariant: str
     last_update_time: str
     last_veto: str
     ledger: Dict[str, Ledger]
diff --git a/src/demo_quipuswap/types/quipu_fa2/parameter/transfer.py b/src/demo_quipuswap/types/quipu_fa2/parameter/transfer.py
@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  transfer.json
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import BaseModel
+
+
+class Tx(BaseModel):
+    to_: str
+    token_id: str
+    amount: str
+
+
+class TransferParameterItem(BaseModel):
+    from_: str
+    txs: List[Tx]
+
+
+class TransferParameter(BaseModel):
+    __root__: List[TransferParameterItem]
diff --git a/src/demo_quipuswap/types/quipu_fa2/storage.py b/src/demo_quipuswap/types/quipu_fa2/storage.py
@@ -27,9 +27,9 @@ class Voters(BaseModel):
 
 
 class Storage(BaseModel):
+    baker_validator: str
     current_candidate: Optional[str]
     current_delegated: Optional[str]
-    invariant: str
     last_update_time: str
     last_veto: str
     ledger: Dict[str, Ledger]
diff --git a/src/dipdup/config.py b/src/dipdup/config.py
@@ -119,7 +119,8 @@ def module_name(self) -> str:
 
     @validator('address')
     def valid_address(cls, v):
-        if not v.startswith('KT1') or len(v) != 36:
+        # NOTE: Wallet addresses are allowed for debugging purposes (source field). Do we need a separate section?
+        if not (v.startswith('KT1') or v.startswith('tz1')) or len(v) != 36:
             raise ConfigurationError(f'`{v}` is not a valid contract address')
         return v
 
@@ -235,11 +236,11 @@ def get_handler_argument(self) -> str:
             parameter_cls = f'{snake_to_camel(self.entrypoint)}Parameter'
             storage_cls = f'{snake_to_camel(module_name)}Storage'
             if self.optional:
-                return f'{entrypoint}: Optional[TransactionContext[{parameter_cls}, {storage_cls}]],'
+                return f'{entrypoint}: Optional[TransactionContext[{parameter_cls}, {storage_cls}]] = None,'
             return f'{entrypoint}: TransactionContext[{parameter_cls}, {storage_cls}],'
         else:
             if self.optional:
-                return f'transaction_{self._transaction_id}: Optional[OperationData],'
+                return f'transaction_{self._transaction_id}: Optional[OperationData] = None,'
             return f'transaction_{self._transaction_id}: OperationData,'
 
 
@@ -281,7 +282,7 @@ def get_handler_argument(self) -> str:
         module_name = self.contract_config.module_name
         storage_cls = f'{snake_to_camel(module_name)}Storage'
         if self.optional:
-            return f'{module_name}_origination: Optional[OriginationContext[{storage_cls}]],'
+            return f'{module_name}_origination: Optional[OriginationContext[{storage_cls}]] = None,'
         return f'{module_name}_origination: OriginationContext[{storage_cls}],'
 
 
diff --git a/src/dipdup/datasources/tzkt/cache.py b/src/dipdup/datasources/tzkt/cache.py
@@ -97,6 +97,8 @@ async def on_match(
                     pattern_idx = 0
                     matched_operations: List[Optional[OperationData]] = []
 
+                    # TODO: Ensure complex cases work, for ex. required argument after optional one
+                    # TODO: Add None to matched_operations where applicable
                     while operation_idx < len(operations):
                         pattern_config = handler_config.pattern[pattern_idx]
                         matched = self.match_operation(pattern_config, operations[operation_idx])
diff --git a/src/dipdup/models.py b/src/dipdup/models.py
@@ -8,6 +8,8 @@
 from pydantic.dataclasses import dataclass
 from tortoise import Model, fields
 
+from dipdup.exceptions import ConfigurationError
+
 ParameterType = TypeVar('ParameterType', bound=BaseModel)
 StorageType = TypeVar('StorageType', bound=BaseModel)
 KeyType = TypeVar('KeyType', bound=BaseModel)
@@ -87,8 +89,14 @@ def _process_storage(self, storage_type: Type[StorageType], storage: Dict, prefi
 
             # NOTE: TzKT could return bigmaps as object or as array of key-value objects. We need to guess this from storage.
             # TODO: This code should be a part of datasource module.
-            if field.type_ not in (int, bool) and isinstance(storage[key], int):
-                _logger.debug(field.type_)
+            try:
+                value = storage[key]
+            except KeyError as e:
+                if not field.required:
+                    continue
+                raise ConfigurationError(f'Type `{storage_type.__name__}` is invalid: `{key}` field does not exists') from e
+
+            if field.type_ not in (int, bool) and isinstance(value, int):
                 if hasattr(field.type_, '__fields__') and 'key' in field.type_.__fields__ and 'value' in field.type_.__fields__:
                     storage[key] = []
                     if self.diffs:
diff --git a/tests/integration_tests/quipuswap.yml b/tests/integration_tests/quipuswap.yml
diff --git a/tests/integration_tests/test_demos.py b/tests/integration_tests/test_demos.py
