Better handling of configuration files with file, local, global

Author: tupui

src/soroban/invoke.py

@@ -15,11 +15,19 @@ def invoke(
     function_name: str,
     args: list[xdr.SCVal] | None = None,
     *,
-    source_account: stellar_sdk.Keypair | str | None = None,
-    network: soroban_models.NetworkConfig | None = None,
+    source_account: soroban_models.Identity | stellar_sdk.Keypair | str | None = None,
+    network: soroban_models.NetworkConfig | soroban_models.NetworkConfig | None = None,
 ):
-    identity = soroban_models.Identity.from_source_account(account=source_account)
-    network = soroban_models.NetworkConfig() if network is None else network
+    identity = (
+        source_account
+        if isinstance(source_account, soroban_models.Identity)
+        else soroban_models.Identity.from_source_account(account=source_account)
+    )
+    network = (
+        network
+        if isinstance(network, soroban_models.NetworkConfig)
+        else soroban_models.NetworkConfig.from_network(network=network)
+    )
 
     soroban_server = stellar_sdk.SorobanServer(network.rpc_url)
     source_account = soroban_server.load_account(identity.public_key)

src/soroban/models.py

@@ -1,4 +1,5 @@
 import pathlib
+from typing import Literal
 
 from pydantic import model_validator, HttpUrl
 from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -7,6 +8,21 @@
 __all__ = ["Identity", "NetworkConfig"]
 
 
+def _load_configuration(id: str | pathlib.Path, kind: Literal["identity", "network"]):
+    id = pathlib.Path(id)
+    global_config = pathlib.Path.home() / ".config" / "soroban" / kind / id / ".toml"
+    local_config = pathlib.Path(".soroban") / kind / id / ".toml"
+
+    id = pathlib.Path(id)
+
+    if id.is_file():
+        return id
+    elif local_config.is_file():
+        return local_config
+    elif global_config.is_file():
+        return global_config
+
+
 class Identity(BaseSettings):
     secret_key: str | None = None
     public_key: str | None = None
@@ -32,11 +48,7 @@ def from_source_account(
         if account is None:
             identity = Identity()
         elif isinstance(account, (str, pathlib.Path)):
-            fname = (
-                account
-                if pathlib.Path(account).is_file()
-                else pathlib.Path(".soroban/identity") / account / ".toml"
-            )
+            fname = _load_configuration(account, "identity")
             identity = Identity(_env_file=fname)
         else:
             identity = Identity(keypair=account)
@@ -49,3 +61,12 @@ class NetworkConfig(BaseSettings):
     base_fee: int = 100
 
     model_config = SettingsConfigDict(env_file="network.toml")
+
+    @classmethod
+    def from_network(cls, network: str | pathlib.Path | None = None) -> "NetworkConfig":
+        if network is None:
+            network = NetworkConfig()
+        elif isinstance(network, (str, pathlib.Path)):
+            fname = _load_configuration(network, "network")
+            network = NetworkConfig(_env_file=fname)
+        return network

tests/test_models.py

@@ -30,3 +30,10 @@ def test_raises(self):
         keypair = Keypair.random()
         with pytest.raises(ValueError, match="provide a secret key or a Keypair"):
             soroban.Identity(public_key=keypair.public_key)
+
+
+class TestNetworkConfig:
+
+    def test_from_network(self):
+        testnet = pathlib.Path(__file__).parent / "testnet.toml"
+        soroban.NetworkConfig.from_network(network=testnet)

tests/testnet.toml

@@ -0,0 +1,2 @@
+rpc_url = "https://soroban-testnet.stellar.org:443"
+network_passphrase = "Test SDF Network ; September 2015"