feat: adding default algorand network configs to use when no .env.{network} found (#533)

* feat: adding default algorand network configs to use when no .env.{network} found

* chore: addressing pr comments

* docs: expanding docs

* chore: pip audit

* docs: tweaking path to copier-answers

* chore: minor tweak to account for answers being inside .algokit folder

Author: aorumbayev

docs/features/init.md

@@ -101,7 +101,7 @@ If you want to create a community template, you can use the [AlgoKit guidelines
 
 Answers to specific template prompts can be provided with the `--answer {key} {value}` option, which can be used multiple times for each prompt. Quotes can be used for values with spaces e.g. `--answer author_name "Algorand Foundation"`.
 
-To find out the key for a specific answer you can either look at `.copier-answers.yml` in the root folder of a project created via `algokit init` or in the `copier.yaml` file of a template repo e.g. for the [beaker template](https://github.com/algorandfoundation/algokit-beaker-default-template/blob/main/copier.yaml).
+To find out the key for a specific answer you can either look at `.algokit/.copier-answers.yml` in the root folder of a project created via `algokit init` or in the `copier.yaml` file of a template repo e.g. for the [beaker template](https://github.com/algorandfoundation/algokit-beaker-default-template/blob/main/copier.yaml).
 
 ## Non-interactive project initialization
 

docs/features/project/deploy.md

@@ -48,6 +48,32 @@ The logic for loading environment variables is as follows:
 - If a `.env` file exists, the environment variables contained in it are loaded first.
 - If a `.env.[network_name]` file exists, the environment variables in it are loaded, overriding any previously loaded values from the `.env` file for the same variables.
 
+### Default Network Configurations
+
+The `deploy` command assumes default configurations for `mainnet`, `localnet`, and `testnet` environments. If you're deploying to one of these networks and haven't provided specific environment variables, AlgoKit will use these default values:
+
+- **Localnet**:
+
+  - `ALGOD_TOKEN`: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+  - `ALGOD_SERVER`: "http://localhost"
+  - `ALGOD_PORT`: "4001"
+  - `INDEXER_TOKEN`: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+  - `INDEXER_SERVER`: "http://localhost"
+  - `INDEXER_PORT`: "8980"
+
+- **Mainnet**:
+
+  - `ALGOD_SERVER`: "https://mainnet-api.algonode.cloud"
+  - `INDEXER_SERVER`: "https://mainnet-idx.algonode.cloud"
+
+- **Testnet**:
+  - `ALGOD_SERVER`: "https://testnet-api.algonode.cloud"
+  - `INDEXER_SERVER`: "https://testnet-idx.algonode.cloud"
+
+These default values are used when no specific `.env.[network_name]` file is present and the corresponding environment variables are not set. This feature simplifies the deployment process for these common networks, reducing the need for manual configuration in many cases.
+
+If you need to override these defaults or add additional configuration for these networks, you can still do so by creating the appropriate `.env.[network_name]` file or setting the environment variables explicitly or via generic `.env` file.
+
 ## AlgoKit Configuration File
 
 AlgoKit uses a configuration file called `.algokit.toml` in the root of your project. The configuration file can be created using the `algokit init` command. This file will define the deployment commands for the various network environments that you want to target.

poetry.lock

@@ -361,9 +361,11 @@ def init_command(  # noqa: PLR0913, C901, PLR0915
 
     from algokit.core.init import populate_default_answers
 
+    answers_file = project_path / ".algokit" / ".copier-answers.yml"
     with Worker(
         src_path=template.url,
         dst_path=project_path,
+        answers_file=answers_file if answers_file.exists() else None,
         data=answers_dict,
         quiet=True,
         vcs_ref=template.branch or template.commit,

src/algokit/cli/init.py

@@ -100,7 +100,7 @@ def _execute_deploy_command(  # noqa: PLR0913
         else:
             msg = (
                 f"Deploy command for '{environment_name}' is not specified in '{ALGOKIT_CONFIG}' file, "
-                "and no generic command."
+                "and no generic command available."
             )
         raise click.ClickException(msg)
     resolved_command = resolve_command_path(config.command)

src/algokit/cli/project/deploy.py

@@ -4,13 +4,55 @@
 
 import click
 import dotenv
+from algokit_utils import get_algonode_config
 
 from algokit.core.conf import ALGOKIT_CONFIG, get_algokit_config
+from algokit.core.sandbox import (
+    DEFAULT_ALGOD_PORT,
+    DEFAULT_ALGOD_SERVER,
+    DEFAULT_ALGOD_TOKEN,
+    DEFAULT_INDEXER_PORT,
+    DEFAULT_INDEXER_SERVER,
+    DEFAULT_INDEXER_TOKEN,
+)
 from algokit.core.utils import load_env_file, split_command_string
 
 logger = logging.getLogger(__name__)
 
 
+class _KnownEnvironments:
+    LOCALNET = "localnet"
+    MAINNET = "mainnet"
+    TESTNET = "testnet"
+
+
+DEFAULT_MAINNET_ALGOD_SERVER = get_algonode_config("mainnet", config="algod", token="").server
+DEFAULT_TESTNET_ALGOD_SERVER = get_algonode_config("testnet", config="algod", token="").server
+DEFAULT_MAINNET_INDEXER_SERVER = get_algonode_config("mainnet", config="indexer", token="").server
+DEFAULT_TESTNET_INDEXER_SERVER = get_algonode_config("testnet", config="indexer", token="").server
+
+
+_ENVIRONMENT_CONFIG: dict[str, dict[str, str | None]] = {
+    _KnownEnvironments.LOCALNET: {
+        # this file should contain environment variables specific to algokit localnet
+        "ALGOD_TOKEN": str(DEFAULT_ALGOD_TOKEN),
+        "ALGOD_SERVER": str(DEFAULT_ALGOD_SERVER),
+        "ALGOD_PORT": str(DEFAULT_ALGOD_PORT),
+        "INDEXER_TOKEN": str(DEFAULT_INDEXER_TOKEN),
+        "INDEXER_SERVER": str(DEFAULT_INDEXER_SERVER),
+        "INDEXER_PORT": str(DEFAULT_INDEXER_PORT),
+    },
+    _KnownEnvironments.MAINNET: {
+        "ALGOD_SERVER": DEFAULT_MAINNET_ALGOD_SERVER,
+        "INDEXER_SERVER": DEFAULT_MAINNET_INDEXER_SERVER,
+    },
+    _KnownEnvironments.TESTNET: {
+        "ALGOD_SERVER": DEFAULT_TESTNET_ALGOD_SERVER,
+        "INDEXER_SERVER": DEFAULT_TESTNET_INDEXER_SERVER,
+    },
+}
+
+
 def load_deploy_env_files(name: str | None, project_dir: Path) -> dict[str, str | None]:
     """
     Load the deploy configuration for the given network.
@@ -20,9 +62,14 @@ def load_deploy_env_files(name: str | None, project_dir: Path) -> dict[str, str
     result = load_env_file(project_dir)
     if name is not None:
         specific_env_path = project_dir / f".env.{name}"
-        if not specific_env_path.exists():
+        if specific_env_path.exists():
+            result |= dotenv.dotenv_values(specific_env_path, verbose=True)
+
+        if name in _ENVIRONMENT_CONFIG:
+            logger.debug(f"Using default environment config for algod and indexer for network {name}")
+            result |= _ENVIRONMENT_CONFIG[name]
+        elif not specific_env_path.exists():
             raise click.ClickException(f"No such file: {specific_env_path}")
-        result |= dotenv.dotenv_values(specific_env_path, verbose=True)
     return result
 
 

src/algokit/core/project/deploy.py

@@ -276,7 +276,9 @@ def check_docker_compose_for_new_image_versions(self) -> None:
 
 
 DEFAULT_ALGOD_SERVER = "http://localhost"
+DEFAULT_INDEXER_SERVER = "http://localhost"
 DEFAULT_ALGOD_TOKEN = "a" * 64
+DEFAULT_INDEXER_TOKEN = "a" * 64
 DEFAULT_ALGOD_PORT = 4001
 DEFAULT_INDEXER_PORT = 8980
 DEFAULT_WAIT_FOR_ALGOD = 60

src/algokit/core/sandbox.py

@@ -182,15 +182,15 @@ def test_command_bad_exit_code(proc_mock: ProcMock, tmp_path: Path, which_mock:
 
 def test_algokit_env_name_missing(tmp_path_factory: TempPathFactory, which_mock: WhichMock) -> None:
     config_with_override = """
-[project.deploy.localnet]
+[project.deploy.customnet]
 command = "command_a"
     """.strip()
     cwd = tmp_path_factory.mktemp("cwd")
     (cwd / ALGOKIT_CONFIG).write_text(config_with_override, encoding="utf-8")
     (cwd / ".env").touch()
 
     which_mock.add("command_a")
-    result = invoke(["project", "deploy", "localnet"], cwd=cwd)
+    result = invoke(["project", "deploy", "customnet"], cwd=cwd)
 
     assert result.exit_code == 1
     verify(result.output)

tests/project/deploy/test_deploy.py

@@ -4,6 +4,7 @@ DEBUG: Loading deploy command from project config
 DEBUG: Attempting to load project config from {current_working_directory}/.algokit.toml
 Using deploy command: /bin/command_a
 Loading deployment environment variables...
+DEBUG: Using default environment config for algod and indexer for network localnet
 Deploying smart contracts from AlgoKit compliant repository 🚀
 DEBUG: Running '/bin/command_a' in '{current_working_directory}'
 /bin/command_a: picked localnet

tests/project/deploy/test_deploy.test_algokit_config_name_no_base.approved.txt

@@ -4,6 +4,7 @@ DEBUG: Loading deploy command from project config
 DEBUG: Attempting to load project config from {current_working_directory}/.algokit.toml
 Using deploy command: /bin/command_c
 Loading deployment environment variables...
+DEBUG: Using default environment config for algod and indexer for network testnet
 Deploying smart contracts from AlgoKit compliant repository 🚀
 DEBUG: Running '/bin/command_c' in '{current_working_directory}'
 /bin/command_c: picked testnet

tests/project/deploy/test_deploy.test_algokit_config_name_overrides.approved.txt

@@ -4,6 +4,7 @@ DEBUG: Loading deploy command from project config
 DEBUG: Attempting to load project config from {current_working_directory}/.algokit.toml
 Using deploy command: /bin/command_b
 Loading deployment environment variables...
+DEBUG: Using default environment config for algod and indexer for network localnet
 Deploying smart contracts from AlgoKit compliant repository 🚀
 DEBUG: Running '/bin/command_b' in '{current_working_directory}'
 /bin/command_b: picked localnet

tests/project/deploy/test_deploy.test_algokit_env_and_name_correct_set.approved.txt

@@ -4,4 +4,4 @@ DEBUG: Loading deploy command from project config
 DEBUG: Attempting to load project config from {current_working_directory}/.algokit.toml
 Using deploy command: /bin/command_a
 Loading deployment environment variables...
-Error: No such file: {current_working_directory}/.env.localnet
+Error: No such file: {current_working_directory}/.env.customnet

tests/project/deploy/test_deploy.test_algokit_env_name_missing.approved.txt

@@ -5,6 +5,7 @@ DEBUG: Loading deploy command from project config
 DEBUG: Attempting to load project config from {current_working_directory}/custom_folder/.algokit.toml
 Using deploy command: /bin/command_a
 Loading deployment environment variables...
+DEBUG: Using default environment config for algod and indexer for network testnet
 Deploying smart contracts from AlgoKit compliant repository 🚀
 DEBUG: Running '/bin/command_a' in '{current_working_directory}/custom_folder'
 /bin/command_a: picked base deploy command