Deploying by a contract name [1/2] — refactor feature dependencies

protostar/commands/build/build_command.py

@@ -1,9 +1,8 @@
 from logging import Logger
 from typing import List, Optional
 
-from protostar.cli import ActivityIndicator
-from protostar.cli.command import Command
-from protostar.commands.build.project_compiler import ProjectCompiler
+from protostar.cli import ActivityIndicator, Command
+from protostar.compiler import ProjectCompiler, ProjectCompilerConfig
 from protostar.utils import log_color_provider
 
 
@@ -53,10 +52,12 @@ async def run(self, args):
             log_color_provider.colorize("GRAY", "Building projects' contracts")
         ):
             try:
-                self._project_compiler.compile(
+                self._project_compiler.compile_project(
                     output_dir=args.output,
-                    relative_cairo_path=args.cairo_path,
-                    disable_hint_validation=args.disable_hint_validation,
+                    config=ProjectCompilerConfig(
+                        hint_validation_disabled=args.disable_hint_validation,
+                        relative_cairo_path=args.cairo_path,
+                    ),
                 )
             except BaseException as exc:
                 self._logger.error("Build failed")

protostar/commands/init/project_creator/_project_creator.py

@@ -32,7 +32,7 @@ def save_protostar_toml(self, project_root: Path, libs_path: Path) -> None:
         self.protostar_toml_writer.save(
             path=project_root / "protostar.toml",
             protostar_config=ProtostarConfigSection.get_default(self.version_manager),
-            protostar_project=ProtostarProjectSection(libs_path=libs_path),
+            protostar_project=ProtostarProjectSection(libs_relative_path=libs_path),
             protostar_contracts=ProtostarContractsSection.get_default(),
         )
 

protostar/commands/install/install_command.py

@@ -80,7 +80,8 @@ def install(
         alias: Optional[str] = None,
     ) -> None:
         project_section = self._project_section_loader.load()
-        libs_path = self._project_root_path / project_section.libs_path
+        libs_path = self._project_root_path / project_section.libs_relative_path
+
         if package_name:
             package_info = extract_info_from_repo_id(package_name)
 

protostar/commands/remove/remove_command.py

@@ -68,7 +68,7 @@ def remove(self, internal_dependency_reference: str):
         package_name = retrieve_real_package_name(
             internal_dependency_reference,
             self._project_root_path,
-            project_section.libs_path,
+            project_section.libs_relative_path,
         )
 
         self._logger.info(

protostar/commands/test/expected_event.py

@@ -1,8 +1,6 @@
-import os
 from collections import deque
 from dataclasses import dataclass
 from enum import Enum
-from pathlib import Path
 from typing import List, Optional, Tuple, Union
 
 from starkware.starknet.business_logic.execution.objects import Event
@@ -12,12 +10,6 @@
 from protostar.commands.test.test_suite import TestSuite
 
 
-def collect_immediate_subdirectories(root_dir: Path) -> List[str]:
-    assert root_dir.is_dir(), f"{root_dir} is supposed to be a directory!"
-    (root, dirs, _) = next(os.walk(str(root_dir.resolve())))
-    return [str(Path(root, directory).resolve()) for directory in dirs]
-
-
 @dataclass
 class ExpectedEvent:
     name: str

protostar/commands/test/test_command.py

@@ -1,6 +1,6 @@
 from logging import getLogger
 from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional
+from typing import List, Optional
 
 from protostar.cli.activity_indicator import ActivityIndicator
 from protostar.cli.command import Command
@@ -13,6 +13,7 @@
 from protostar.commands.test.testing_live_logger import TestingLiveLogger
 from protostar.commands.test.testing_seed import TestingSeed
 from protostar.commands.test.testing_summary import TestingSummary
+from protostar.compiler import ProjectCairoPathBuilder
 from protostar.utils.compiler.pass_managers import (
     StarknetPassManagerFactory,
     TestCollectorPassManagerFactory,
@@ -21,21 +22,18 @@
 from protostar.utils.protostar_directory import ProtostarDirectory
 from protostar.utils.starknet_compilation import CompilerConfig, StarknetCompiler
 
-if TYPE_CHECKING:
-    from protostar.commands.build.project_compiler import ProjectCompiler
-
 
 class TestCommand(Command):
     def __init__(
         self,
         project_root_path: Path,
         protostar_directory: ProtostarDirectory,
-        project_compiler: "ProjectCompiler",
+        project_cairo_path_builder: ProjectCairoPathBuilder,
     ) -> None:
         super().__init__()
         self._project_root_path = project_root_path
         self._protostar_directory = protostar_directory
-        self._project_compiler = project_compiler
+        self._project_cairo_path_builder = project_cairo_path_builder
 
     @property
     def name(self) -> str:
@@ -164,7 +162,9 @@ async def test(
             str(path)
             for path in [
                 self._protostar_directory.protostar_test_only_cairo_packages_path,
-                *self._project_compiler.build_cairo_path(cairo_path or []),
+                *self._project_cairo_path_builder.build_project_cairo_path_list(
+                    cairo_path or []
+                ),
             ]
         ]
         factory = (

protostar/commands/update/update_command.py

@@ -71,19 +71,21 @@ def update(self, package: Optional[str]) -> None:
 
         if package:
             package = retrieve_real_package_name(
-                package, self._project_root_path, project_section.libs_path
+                package, self._project_root_path, project_section.libs_relative_path
             )
             try:
                 update_package(
-                    package, self._project_root_path, project_section.libs_path
+                    package, self._project_root_path, project_section.libs_relative_path
                 )
             except PackageAlreadyUpToDateException as err:
                 self._logger.info(err.message)
         else:
-            for package_name in listdir(project_section.libs_path):
+            for package_name in listdir(project_section.libs_relative_path):
                 try:
                     update_package(
-                        package_name, self._project_root_path, project_section.libs_path
+                        package_name,
+                        self._project_root_path,
+                        project_section.libs_relative_path,
                     )
                 except PackageAlreadyUpToDateException:
                     continue

protostar/compiler/__init__.py

@@ -0,0 +1,7 @@
+from .project_compiler import (
+    CompilationException,
+    ProjectCairoPathBuilder,
+    ProjectCompiler,
+    ProjectCompilerConfig,
+    SourceFileNotFoundException,
+)

protostar/compiler/compiled_contract_writer.py

@@ -0,0 +1,40 @@
+import json
+from pathlib import Path
+from typing import Any
+
+from starkware.starknet.services.api.contract_class import ContractClass
+
+
+class CompiledContractWriter:
+    def __init__(self, contract: ContractClass, contract_name: str) -> None:
+        self._contract = contract
+        self._contract_name = contract_name
+
+    def save(self, output_dir: Path) -> None:
+        self.save_compiled_contract(output_dir)
+        self.save_compiled_contract_abi(output_dir)
+
+    def save_compiled_contract(self, output_dir: Path) -> None:
+        self._create_output_dir(output_dir)
+        serialized_contract = self._contract.Schema().dump(self._contract)
+        self._save_as_json(data=serialized_contract, path=output_dir)
+
+    def save_compiled_contract_abi(self, output_dir: Path) -> None:
+        if not self._contract.abi:
+            return
+        self._create_output_dir(output_dir)
+        self._save_as_json(data=self._contract.abi, path=output_dir)
+
+    @staticmethod
+    def _create_output_dir(output_dir: Path):
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+    @staticmethod
+    def _save_as_json(data: Any, path: Path):
+        with open(
+            path,
+            mode="w",
+            encoding="utf-8",
+        ) as output_abi_file:
+            json.dump(data, output_abi_file, indent=4, sort_keys=True)
+            output_abi_file.write("\n")

protostar/compiler/project_cairo_path_builder.py

@@ -0,0 +1,44 @@
+import os
+from pathlib import Path
+from typing import List, Optional
+
+from protostar.protostar_toml.protostar_project_section import ProtostarProjectSection
+
+
+class ProjectCairoPathBuilder:
+    def __init__(
+        self,
+        project_root_path: Path,
+        project_section_loader: ProtostarProjectSection.Loader,
+    ) -> None:
+        self._project_root_path = project_root_path
+        self._project_section_loader = project_section_loader
+
+    def build_project_cairo_path_list(
+        self, relative_cairo_path_list: List[Path]
+    ) -> List[Path]:
+        """NOTE: This function uses `list` suffix to mitigate confusion and
+        remain consistency with StarkNet's `cairo_path`."""
+
+        return [
+            *relative_cairo_path_list,
+            self._project_root_path,
+            *self._build_libs_cairo_path_list(),
+        ]
+
+    def _build_libs_cairo_path_list(self) -> List[Path]:
+        libs_path = self._get_libs_path()
+        if libs_path is None:
+            return []
+        return [libs_path, *self._build_packages_cairo_path_list()]
+
+    def _build_packages_cairo_path_list(self) -> List[Path]:
+        libs_path = self._get_libs_path()
+        if libs_path is None:
+            return []
+        (root, dirs, _) = next(os.walk(str(libs_path.resolve())))
+        return [Path(root, directory).resolve() for directory in dirs]
+
+    def _get_libs_path(self) -> Optional[Path]:
+        project_section = self._project_section_loader.load()
+        return project_section.get_libs_path(self._project_root_path)