Dynamic templates (#44)

Author: droserasprout

src/demo_registrydao/dipdup.yml

@@ -7,7 +7,7 @@ database:
 
 contracts:
   registry:
-    address: KT1QMdCTqzmY4QKHntV1nZEinLPU1GbxUFQu
+    address: KT1R8AZn5KG7mkbnJ5bzMuUw2isL8tMYkDVD
     typename: registry
 
 datasources:
@@ -39,5 +39,4 @@ templates:
 indexes:
   registry:
     template: registry_dao
-    values:
-      contract: registry
+    similar_to: registry

src/demo_registrydao/types/registry/parameter/propose.py

@@ -3,45 +3,11 @@
 
 from __future__ import annotations
 
-from typing import List, Optional, Union
+from typing import Dict
 
 from pydantic import BaseModel
 
 
-class DiffItem(BaseModel):
-    key: str
-    new_value: Optional[str]
-
-
-class ProposalType0(BaseModel):
-    agora_post_id: str
-    diff: List[DiffItem]
-
-
-class ProposalMetadatum(BaseModel):
-    proposal_type_0: ProposalType0
-
-
-class ProposalType1(BaseModel):
-    frozen_scale_value: Optional[str]
-    frozen_extra_value: Optional[str]
-    slash_scale_value: Optional[str]
-    slash_division_value: Optional[str]
-    max_proposal_size: Optional[str]
-
-
-class ProposalMetadatum1(BaseModel):
-    proposal_type_1: ProposalType1
-
-
-class ProposalMetadatum2(BaseModel):
-    receivers_0: List[str]
-
-
-class ProposalMetadatum3(BaseModel):
-    receivers_1: List[str]
-
-
 class ProposeParameter(BaseModel):
     frozen_token: str
-    proposal_metadata: Union[ProposalMetadatum, ProposalMetadatum1, ProposalMetadatum2, ProposalMetadatum3]
+    proposal_metadata: Dict[str, str]

src/demo_registrydao/types/registry/storage.py

@@ -3,25 +3,21 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List
 
 from pydantic import BaseModel
 
 
-class Registry(BaseModel):
-    affected_proposal_key: str
-    last_updated: str
-    value: Optional[str]
+class FreezeHistory(BaseModel):
+    current_period_num: str
+    current_unstaked: str
+    past_unstaked: str
+    staked: str
 
 
-class Extra(BaseModel):
-    frozen_extra_value: str
-    frozen_scale_value: str
-    max_proposal_size: str
-    proposal_receivers: List[str]
-    registry: Dict[str, Registry]
-    slash_division_value: str
-    slash_scale_value: str
+class LastPeriodChange(BaseModel):
+    changed_on: str
+    period_num: str
 
 
 class Key(BaseModel):
@@ -34,16 +30,14 @@ class LedgerItem(BaseModel):
     value: str
 
 
-class MigrationStatu(BaseModel):
-    notInMigration: Dict[str, Any]
+class MaxQuorumThreshold(BaseModel):
+    denominator: str
+    numerator: str
 
 
-class MigrationStatu1(BaseModel):
-    migratingTo: str
-
-
-class MigrationStatu2(BaseModel):
-    migratedTo: str
+class MinQuorumThreshold(BaseModel):
+    denominator: str
+    numerator: str
 
 
 class Key1(BaseModel):
@@ -61,67 +55,55 @@ class ProposalKeyListSortByDateItem(BaseModel):
     timestamp: str
 
 
-class DiffItem(BaseModel):
-    key: str
-    new_value: Optional[str]
-
-
-class ProposalType0(BaseModel):
-    agora_post_id: str
-    diff: List[DiffItem]
-
-
-class Metadatum(BaseModel):
-    proposal_type_0: ProposalType0
-
-
-class ProposalType1(BaseModel):
-    frozen_extra_value: Optional[str]
-    frozen_scale_value: Optional[str]
-    max_proposal_size: Optional[str]
-    slash_division_value: Optional[str]
-    slash_scale_value: Optional[str]
-
-
-class Metadatum1(BaseModel):
-    proposal_type_1: ProposalType1
-
-
-class Metadatum2(BaseModel):
-    receivers_0: List[str]
-
-
-class Metadatum3(BaseModel):
-    receivers_1: List[str]
-
-
 class Voter(BaseModel):
-    address: str
-    nat: str
+    vote_amount: str
+    vote_type: bool
+    voter_address: str
 
 
 class Proposals(BaseModel):
     downvotes: str
-    metadata: Union[Metadatum, Metadatum1, Metadatum2, Metadatum3]
+    metadata: Dict[str, str]
+    period_num: str
     proposer: str
+    proposer_fixed_fee_in_token: str
     proposer_frozen_token: str
     start_date: str
     upvotes: str
     voters: List[Voter]
 
 
+class QuorumThreshold(BaseModel):
+    denominator: str
+    numerator: str
+
+
 class RegistryStorage(BaseModel):
     admin: str
-    extra: Extra
+    custom_entrypoints: Dict[str, str]
+    decision_lambda: str
+    extra: Dict[str, str]
+    fixed_proposal_fee_in_token: str
+    freeze_history: Dict[str, FreezeHistory]
+    frozen_token_id: str
+    last_period_change: LastPeriodChange
     ledger: List[LedgerItem]
+    max_proposals: str
+    max_quorum_threshold: MaxQuorumThreshold
+    max_votes: str
+    max_voting_period: str
     metadata: Dict[str, str]
-    migration_status: Union[MigrationStatu, MigrationStatu1, MigrationStatu2]
+    min_quorum_threshold: MinQuorumThreshold
+    min_voting_period: str
     operators: List[Operator]
     pending_owner: str
     permits_counter: str
+    proposal_check: str
     proposal_key_list_sort_by_date: List[ProposalKeyListSortByDateItem]
     proposals: Dict[str, Proposals]
-    quorum_threshold: str
+    quorum_threshold: QuorumThreshold
+    rejected_proposal_return_value: str
     token_address: str
     total_supply: Dict[str, str]
+    unfrozen_token_id: str
     voting_period: str

src/dipdup/codegen.py

@@ -6,7 +6,7 @@
 from os import mkdir
 from os.path import basename, dirname, exists, join, splitext
 from shutil import rmtree
-from typing import Any, Dict
+from typing import Any, Dict, cast
 
 from jinja2 import Template
 
@@ -15,11 +15,12 @@
     BigMapIndexConfig,
     ContractConfig,
     DipDupConfig,
-    IndexTemplateConfig,
+    DynamicTemplateConfig,
     OperationHandlerConfig,
     OperationHandlerOriginationPatternConfig,
     OperationHandlerTransactionPatternConfig,
     OperationIndexConfig,
+    StaticTemplateConfig,
     TzktDatasourceConfig,
 )
 from dipdup.datasources.tzkt.datasource import TzktDatasource
@@ -80,15 +81,27 @@ async def create_package(config: DipDupConfig):
             file.write(models_code)
 
 
-async def fetch_schemas(config: DipDupConfig):
+async def resolve_dynamic_templates(config: DipDupConfig) -> None:
+    for index_name, index_config in config.indexes.items():
+        if isinstance(index_config, DynamicTemplateConfig):
+            config.indexes[index_name] = StaticTemplateConfig(
+                template=index_config.template,
+                values=dict(contract=cast(str, index_config.similar_to)),
+            )
+            config.pre_initialize()
+            index_config = config.indexes[index_name]
+
+
+async def fetch_schemas(config: DipDupConfig) -> None:
     _logger.info('Creating `schemas` package')
     schemas_path = join(config.package_path, 'schemas')
     with suppress(FileExistsError):
         mkdir(schemas_path)
 
     schemas_cache = SchemasCache()
 
-    for index_name, index_config in config.indexes.items():
+    for index_config in config.indexes.values():
+
         if isinstance(index_config, OperationIndexConfig):
             for operation_handler_config in index_config.handlers:
                 for operation_pattern_config in operation_handler_config.pattern:
@@ -160,7 +173,12 @@ async def fetch_schemas(config: DipDupConfig):
                     with suppress(FileExistsError):
                         mkdir(big_map_schemas_path)
 
-                    big_map_schema = next(ep for ep in contract_schemas['bigMaps'] if ep['path'] == big_map_pattern_config.path)
+                    try:
+                        big_map_schema = next(ep for ep in contract_schemas['bigMaps'] if ep['path'] == big_map_pattern_config.path)
+                    except StopIteration as e:
+                        raise ConfigurationError(
+                            f'Contract `{contract_config.address}` has no big map path `{big_map_pattern_config.path}`'
+                        ) from e
                     big_map_key_schema = big_map_schema['keySchema']
                     big_map_key_schema_path = join(big_map_schemas_path, f'{big_map_pattern_config.path}.key.json')
 
@@ -175,7 +193,7 @@ async def fetch_schemas(config: DipDupConfig):
                         with open(big_map_value_schema_path, 'w') as file:
                             file.write(json.dumps(big_map_value_schema, indent=4))
 
-        elif isinstance(index_config, IndexTemplateConfig):
+        elif isinstance(index_config, StaticTemplateConfig):
             raise RuntimeError('Config is not initialized')
 
         else: