fix: Contract name underscoring

Author: MissingNO57

poetry.lock

@@ -24,6 +24,7 @@ jsonschema = "^4.15.0"
 graphlib-backport = "^1.0.3"
 jwskate = ">=0.4.1,<0.6.0"
 makefun = "^1.15.0"
+urllib3 = "==1.26.16"
 
 [tool.poetry.dev-dependencies]
 coverage = "^7.0.3"

pyproject.toml

@@ -26,7 +26,6 @@ def run(args: argparse.Namespace):
 
     selected_contract = parse_contract(project_root , args.contract)
 
-
     for (profile_name, profile) in cfg.profiles.items():
         network_name = profile.network.name
         for deployment in args.deployments:

src/jenesis/cmd/add/deployment.py

@@ -12,6 +12,7 @@
 from jenesis.contracts.schema import generate_schemas, load_contract_schema
 from jenesis.tasks.image import image_exists, pull_image
 
+
 def _compute_init_checksum(path, contract_name):
     schema_path = os.path.join(path, "contracts", contract_name)
     schema = load_contract_schema(schema_path)
@@ -44,7 +45,7 @@ def run(args: argparse.Namespace):
         print(term.red("Unable to detect any contracts"))
         return 1
 
-    init_checksums = {contract.name: _compute_init_checksum(project_path, contract.name) for contract in contracts}
+    init_checksums = {contract.name: _compute_init_checksum(project_path, contract.variable_name) for contract in contracts}
 
     if is_workspace(project_path):
         if not image_exists(WORKSPACE_BUILD_IMAGE):
@@ -65,7 +66,7 @@ def run(args: argparse.Namespace):
 
     cfg = Config.load(os.getcwd())
     for contract in contracts:
-        if _compute_init_checksum(project_path, contract.name) != init_checksums[contract.name]:
+        if _compute_init_checksum(project_path, contract.variable_name) != init_checksums[contract.name]:
             # update project file
             for (profile_name, profile) in cfg.profiles.items():
                 network_name = profile.network.name

src/jenesis/cmd/compile.py

@@ -38,7 +38,7 @@ def load_shell_globals(cfg: Config, selected_profile: Profile) -> dict:
     shell_globals = {}
     contract_instances = {}
 
-    contracts = {contract.name: contract for contract in detect_contracts(PROJECT_PATH)}
+    contracts = {contract.variable_name: contract for contract in detect_contracts(PROJECT_PATH)}
 
     deployments = selected_profile.deployments
 

src/jenesis/cmd/shell.py

@@ -27,7 +27,7 @@
 
 @dataclass
 class Deployment:
-    name: str # internal: the name for the deployment
+    name: str  # internal: the name for the deployment
     contract: str  # internal: the name of the contract to deploy
     network: str  # internal: the name of the network to deploy to
     deployer_key: str  # config: the name of the key to use for deployment
@@ -402,7 +402,7 @@ def add_profile(profile: str, network_name: str):
             toml.dump(data, toml_file)
 
     @staticmethod
-    def add_contract(project_root: str, template: str, name: str, branch: str) -> Contract:
+    def add_contract(project_root: str, template: str, name: str, branch: Optional[str]) -> Optional[Contract]:
 
         contract_path = os.path.join(project_root, 'contracts', name)
 
@@ -425,9 +425,11 @@ def add_contract(project_root: str, template: str, name: str, branch: str) -> Co
         contract_template_path = os.path.join(temp_clone_path, "contracts", template)
         if not os.path.isdir(contract_template_path):
             print(f"Unknown template {template}: expecting one of {set(available_templates)}")
-            return
+            return None
         print("Downloading template...complete")
 
+        name_underscored = name.replace("-", "_")
+
         # process all the files as part of the template
         print("Rendering template...")
         for root, _, files in os.walk(contract_template_path):
@@ -440,12 +442,11 @@ def add_contract(project_root: str, template: str, name: str, branch: str) -> Co
                 with open(file_path, "r", encoding="utf8") as input_file:
                     with open(output_filepath, "w", encoding="utf8") as output_file:
                         contents = input_file.read()
-
                         # replace the templating parameters here
                         if file_path.endswith(".toml"):
                             contents = contents.replace("<<NAME>>", name)
                         else:
-                            contents = contents.replace("<<NAME>>", name.replace("-", "_"))
+                            contents = contents.replace("<<NAME>>", name_underscored)
 
                         output_file.write(contents)
         print("Rendering template...complete")

src/jenesis/config/__init__.py

@@ -1,26 +1,32 @@
 import os.path
-from dataclasses import dataclass
-from typing import Optional
+from dataclasses import dataclass, field
+from typing import Optional, Dict, Any
 
 from cosmpy.aerial.contract import _compute_digest
 
 
+SchemaType = Dict[str, Any]
+
+
 @dataclass
 class Contract:
     name: str
+    variable_name: str = field(init=False)
     source_path: str
     binary_path: str
     cargo_root: str
-    schema: dict
+    schema: SchemaType
+    instantiate_schema: Optional[SchemaType] = field(default=None, init=False)
+    query_schema: Optional[SchemaType] = field(default=None, init=False)
+    execute_schema: Optional[SchemaType] = field(default=None, init=False)
 
     def __post_init__(self):
+        self.variable_name = self.to_variable_name(self.name)
         self.instantiate_schema = {}
         self.query_schema = {}
         self.execute_schema = {}
-
         self.update_schema()
 
-
     def update_schema(self):
         # check for workspace-style schemas
         if self.name in self.schema:
@@ -54,6 +60,10 @@ def init_args(self) -> dict:
     def __repr__(self):
         return self.name
 
+    @classmethod
+    def to_variable_name(cls, contract_name: str) -> str:
+        return contract_name.replace("-", "_")
+
 
 def _extract_msgs(schema: dict) -> dict:
     msgs = {}
@@ -69,6 +79,7 @@ def _extract_msgs(schema: dict) -> dict:
         msgs[msg] = args
     return msgs
 
+
 def _get_msg_args(msg_schema):
     msg_args = {}
     args = msg_schema.get('properties', {}).keys()

src/jenesis/contracts/__init__.py

@@ -37,6 +37,10 @@ def __init__(self, contract: Contract, optimize: bool, rebuild: bool, log: bool)
     def name(self) -> str:
         return self.contract.name
 
+    @property
+    def variable_name(self) -> str:
+        return self.contract.variable_name
+
     def _is_out_of_date(self) -> bool:
         #  pylint: disable=duplicate-code
         if self._rebuild:
@@ -56,7 +60,7 @@ def _is_out_of_date(self) -> bool:
 
     def _schedule_container(self) -> Container:
         mounts = [
-            Mount('/code/target', f'contract_{self.contract.name}_cache'),
+            Mount('/code/target', f'contract_{self.contract.variable_name}_cache'),
             Mount('/usr/local/cargo/registry', 'registry_cache'),
             Mount('/code', os.path.abspath(self.contract.cargo_root), type='bind'),
         ]

src/jenesis/contracts/build.py

@@ -30,15 +30,15 @@ def parse_contract(path: str, name: str) -> Contract:
         cargo_contents = toml.load(cargo_file)
 
     # extract the contract name and replace hyphens with underscores
-    contract_name = cargo_contents['package']['name'].replace("-", "_")
+    contract_name = cargo_contents['package']['name']
 
     source_path = os.path.abspath(os.path.join(contracts_folder, name))
     if is_workspace(path):
         cargo_root = path
     else:
         cargo_root = os.path.join(contracts_folder, name)
     artifacts_path = os.path.join(cargo_root, 'artifacts')
-    binary_path = os.path.abspath(os.path.join(artifacts_path, f'{contract_name}.wasm'))
+    binary_path = os.path.abspath(os.path.join(artifacts_path, f'{Contract.to_variable_name(contract_name)}.wasm'))
 
     schema = load_contract_schema(source_path)