fix: align ledger config schema with API response (openwallet-foundation#3615)

* fix: align ledger config schema with API response

- Replace ledger_config_list with production/non_production_ledgers
- Add missing fields to LedgerConfigInstanceSchema
- Update OpenAPI documentation

Resolves openwallet-foundation#123

Signed-off-by: Yuki I <omoge.real@gmail.com>

* test: add coverage for ledger config schemas

- Validate schema structure and required fields
- Test UUID generation in LedgerConfigInstanceSchema
- Verify production/non-production ledger grouping

Signed-off-by: Yuki I <omoge.real@gmail.com>

* fix: final schema and test adjustments

Signed-off-by: Yuki I <omoge.real@gmail.com>

---------

Signed-off-by: Yuki I <omoge.real@gmail.com>
Co-authored-by: Yuki I <omoge.real@gmail.com>

Author: MonolithicMonk

acapy_agent/ledger/multiple_ledger/ledger_config_schema.py

@@ -21,17 +21,25 @@ def __init__(
         self,
         *,
         id: Optional[str] = None,
-        is_production: str = True,
-        genesis_transactions: Optional[str] = None,
-        genesis_file: Optional[str] = None,
-        genesis_url: Optional[str] = None,
+        is_production: bool = True,
+        is_write: bool = False,
+        keepalive: int = 5,
+        read_only: bool = False,
+        socks_proxy: Optional[str] = None,
+        pool_name: Optional[str] = None,
+        endorser_alias: Optional[str] = None,
+        endorser_did: Optional[str] = None,
     ):
         """Initialize LedgerConfigInstance."""
-        self.id = id
+        self.id = id or str(uuid4())
         self.is_production = is_production
-        self.genesis_transactions = genesis_transactions
-        self.genesis_file = genesis_file
-        self.genesis_url = genesis_url
+        self.is_write = is_write
+        self.keepalive = keepalive
+        self.read_only = read_only
+        self.socks_proxy = socks_proxy
+        self.pool_name = pool_name or self.id
+        self.endorser_alias = endorser_alias
+        self.endorser_did = endorser_did
 
 
 class LedgerConfigInstanceSchema(BaseModelSchema):
@@ -43,13 +51,46 @@ class Meta:
         model_class = LedgerConfigInstance
         unknown = EXCLUDE
 
-    id = fields.Str(required=False, metadata={"description": "ledger_id"})
-    is_production = fields.Bool(required=False, metadata={"description": "is_production"})
-    genesis_transactions = fields.Str(
-        required=False, metadata={"description": "genesis_transactions"}
+    id = fields.Str(
+        required=True,
+        metadata={
+            "description": "Ledger identifier. Auto-generated UUID4 if not provided",
+            "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+        },
+    )
+    is_production = fields.Bool(
+        required=True, metadata={"description": "Production-grade ledger (true/false)"}
+    )
+    is_write = fields.Bool(
+        required=False,
+        metadata={"description": "Write capability enabled (default: False)"},
+    )
+    keepalive = fields.Int(
+        required=False,
+        metadata={
+            "description": "Keep-alive timeout in seconds for idle connections",
+            "default": 5,
+        },
+    )
+    read_only = fields.Bool(
+        required=False, metadata={"description": "Read-only access (default: False)"}
+    )
+    socks_proxy = fields.Str(
+        required=False, metadata={"description": "SOCKS proxy URL (optional)"}
+    )
+    pool_name = fields.Str(
+        required=False,
+        metadata={
+            "description": "Ledger pool name (defaults to ledger ID if not specified)",
+            "example": "bcovrin-test-pool",
+        },
+    )
+    endorser_alias = fields.Str(
+        required=False, metadata={"description": "Endorser service alias (optional)"}
+    )
+    endorser_did = fields.Str(
+        required=False, metadata={"description": "Endorser DID (optional)"}
     )
-    genesis_file = fields.Str(required=False, metadata={"description": "genesis_file"})
-    genesis_url = fields.Str(required=False, metadata={"description": "genesis_url"})
 
     @pre_load
     def validate_id(self, data, **kwargs):
@@ -58,12 +99,27 @@ def validate_id(self, data, **kwargs):
             data["id"] = str(uuid4())
         return data
 
+    @pre_load
+    def set_defaults(self, data, **kwargs):
+        """Set default values for optional fields."""
+        data.setdefault("is_write", False)
+        data.setdefault("keepalive", 5)
+        data.setdefault("read_only", False)
+        return data
+
 
 class LedgerConfigListSchema(OpenAPISchema):
     """Schema for Ledger Config List."""
 
-    ledger_config_list = fields.List(
-        fields.Nested(LedgerConfigInstanceSchema(), required=True), required=True
+    production_ledgers = fields.List(  # Changed from ledger_config_list
+        fields.Nested(LedgerConfigInstanceSchema(), required=True),
+        required=True,
+        metadata={"description": "Production ledgers (may be empty)"},
+    )
+    non_production_ledgers = fields.List(  # Added new field
+        fields.Nested(LedgerConfigInstanceSchema(), required=True),
+        required=True,
+        metadata={"description": "Non-production ledgers (may be empty)"},
     )
 
 

acapy_agent/ledger/tests/test_routes.py

@@ -1,6 +1,10 @@
 import json
+import pytest
+import uuid
+from marshmallow import ValidationError
 from typing import Optional
 from unittest import IsolatedAsyncioTestCase
+from uuid_utils import uuid4
 
 from ...connections.models.conn_record import ConnRecord
 from ...ledger.base import BaseLedger
@@ -9,7 +13,11 @@
 from ...ledger.multiple_ledger.ledger_requests_executor import (
     IndyLedgerRequestsExecutor,
 )
-from ...ledger.multiple_ledger.ledger_config_schema import ConfigurableWriteLedgersSchema
+from ...ledger.multiple_ledger.ledger_config_schema import (
+    ConfigurableWriteLedgersSchema,
+    LedgerConfigInstanceSchema,
+    LedgerConfigListSchema,
+)
 
 from ...multitenant.base import BaseMultitenantManager
 from ...multitenant.manager import MultitenantManager
@@ -869,6 +877,110 @@ async def test_get_ledger_config_x(self):
         with self.assertRaises(test_module.web.HTTPForbidden):
             await test_module.get_ledger_config(self.request)
 
+    async def test_get_ledger_config_structure(self):
+        """Test the structure of the ledger config response."""
+        mock_manager = mock.MagicMock(BaseMultipleLedgerManager, autospec=True)
+        mock_manager.get_prod_ledgers = mock.CoroutineMock(return_value={"test_1": None})
+        mock_manager.get_nonprod_ledgers = mock.CoroutineMock(
+            return_value={"test_2": None}
+        )
+        self.profile.context.injector.bind_instance(
+            BaseMultipleLedgerManager, mock_manager
+        )
+
+        self.context.settings["ledger.ledger_config_list"] = [
+            {
+                "id": "test_1",
+                "is_production": True,
+                "is_write": True,
+                "keepalive": 5,
+                "read_only": False,
+                "pool_name": "test_pool",
+                "socks_proxy": None,
+            },
+            {
+                "id": "test_2",
+                "is_production": False,
+                "is_write": False,
+                "keepalive": 10,
+                "read_only": True,
+                "pool_name": "non_prod_pool",
+                "socks_proxy": None,
+            },
+        ]
+
+        with mock.patch.object(
+            test_module.web, "json_response", mock.Mock()
+        ) as json_response:
+            await test_module.get_ledger_config(self.request)
+
+            response_data = json_response.call_args[0][0]
+            assert "production_ledgers" in response_data
+            assert "non_production_ledgers" in response_data
+
+            prod_ledger = response_data["production_ledgers"][0]
+            assert prod_ledger == {
+                "id": "test_1",
+                "is_production": True,
+                "is_write": True,
+                "keepalive": 5,
+                "read_only": False,
+                "pool_name": "test_pool",
+                "socks_proxy": None,
+            }
+
+            non_prod_ledger = response_data["non_production_ledgers"][0]
+            assert non_prod_ledger == {
+                "id": "test_2",
+                "is_production": False,
+                "is_write": False,
+                "keepalive": 10,
+                "read_only": True,
+                "pool_name": "non_prod_pool",
+                "socks_proxy": None,
+            }
+
+    async def test_ledger_config_schema_validation(self):
+        """Test schema validation for required fields."""
+        schema = LedgerConfigInstanceSchema()
+
+        minimal_data = {
+            "is_production": True,
+            "is_write": False,
+            "keepalive": 5,
+            "read_only": False,
+        }
+        loaded = schema.load(minimal_data)
+        assert loaded.pool_name == loaded.id
+        assert loaded.is_write is False
+
+        with pytest.raises(ValidationError) as exc:
+            schema.load({"is_production": "not_bool"})
+        assert "is_production" in exc.value.messages
+
+    async def test_ledger_config_id_generation(self):
+        """Test automatic ID generation when missing."""
+        schema = LedgerConfigInstanceSchema()
+
+        data = {
+            "is_production": True,
+            "is_write": False,  # Add required fields
+            "keepalive": 5,
+            "read_only": False,
+        }
+        loaded = schema.load(data)
+        assert uuid.UUID(loaded.id, version=4)
+
+        explicit_id = str(uuid4())
+        loaded = schema.load({"id": explicit_id, "is_production": True})
+        assert loaded.id == explicit_id
+
+    async def test_empty_ledger_lists(self):
+        schema = LedgerConfigListSchema()
+        empty_data = {"production_ledgers": [], "non_production_ledgers": []}
+        loaded = schema.load(empty_data)
+        assert loaded == empty_data
+
     # Multiple Ledgers Configured
     async def test_get_write_ledgers_multiple(self):
         # Mock the multiple ledger manager

conftest.py

@@ -147,7 +147,7 @@ def stub_ursa_bbs_signatures() -> Stub:
 def pytest_sessionstart(session):
     global STUBS, POSTGRES_URL, ENABLE_PTVSD
     args = sys.argv
-    
+
     # copied from __main__.py:init_debug
     ENABLE_PTVSD = os.getenv("ENABLE_PTVSD", "").lower()
     ENABLE_PTVSD = ENABLE_PTVSD and ENABLE_PTVSD not in ("false", "0")

demo/runners/acme.py

@@ -14,7 +14,6 @@
     check_requires,
     log_msg,
     log_status,
-    log_timer,
     prompt,
     prompt_loop,
 )

demo/runners/alice.py

@@ -158,7 +158,7 @@ async def main(args):
         log_status("#9 Input faber.py invitation details")
         await input_invitation(alice_agent)
 
-        options = "    (3) Send Message\n" "    (4) Input New Invitation\n"
+        options = "    (3) Send Message\n    (4) Input New Invitation\n"
         if alice_agent.endorser_role and alice_agent.endorser_role == "author":
             options += "    (D) Set Endorser's DID\n"
         if alice_agent.multitenant:

demo/runners/performance.py

@@ -457,7 +457,7 @@ def done_send(fut: asyncio.Task):
         def test_cred(index: int) -> dict:
             return {
                 "name": "Alice Smith",
-                "date": f"{2020+index}-05-28",
+                "date": f"{2020 + index}-05-28",
                 "degree": "Maths",
                 "age": "24",
             }
@@ -579,7 +579,7 @@ async def check_received_pings(agent, issue_count, pb):
         avg = recv_timer.duration / issue_count
         item_short = "ping" if action == "ping" else "cred"
         item_long = "ping exchange" if action == "ping" else "credential"
-        faber.log(f"Average time per {item_long}: {avg:.2f}s ({1/avg:.2f}/s)")
+        faber.log(f"Average time per {item_long}: {avg:.2f}s ({1 / avg:.2f}/s)")
 
         if alice.postgres:
             await alice.collect_postgres_stats(f"{issue_count} {item_short}s")

demo/runners/support/agent.py

@@ -1783,7 +1783,7 @@ async def connect_wallet_to_endorser(agent, endorser_agent):
     # setup endorser meta-data on our connection
     log_msg("Setup author agent meta-data ...")
     await agent.admin_POST(
-        f"/transactions/{agent.endorser_connection_id }/set-endorser-role",
+        f"/transactions/{agent.endorser_connection_id}/set-endorser-role",
         params={"transaction_my_job": "TRANSACTION_AUTHOR"},
     )
     endorser_did = endorser_agent.endorser_public_did

scenarios/examples/json_ld/example.py

@@ -278,7 +278,7 @@ async def main():
                                     {
                                         "path": ["$.issuer"],
                                         "purpose": "The claim must be from one of the specified issuers",  # noqa: E501
-                                        "filter": {"const": p256_alice_did}
+                                        "filter": {"const": p256_alice_did},
                                     },
                                     {
                                         "path": ["$.credentialSubject.givenName"],
@@ -289,9 +289,7 @@ async def main():
                         }
                     ],
                     "id": str(uuid4()),
-                    "format": {
-                        "ldp_vp": {"proof_type": ["EcdsaSecp256r1Signature2019"]}
-                        },
+                    "format": {"ldp_vp": {"proof_type": ["EcdsaSecp256r1Signature2019"]}},
                 },
                 domain="test-degree",
             )

scenarios/examples/multitenancy/example.py

@@ -42,11 +42,14 @@ async def main():
             response=CreateWalletResponse,
         )
 
-    async with Controller(
-        base_url=AGENCY, wallet_id=alice.wallet_id, subwallet_token=alice.token
-    ) as alice, Controller(
-        base_url=AGENCY, wallet_id=bob.wallet_id, subwallet_token=bob.token
-    ) as bob:
+    async with (
+        Controller(
+            base_url=AGENCY, wallet_id=alice.wallet_id, subwallet_token=alice.token
+        ) as alice,
+        Controller(
+            base_url=AGENCY, wallet_id=bob.wallet_id, subwallet_token=bob.token
+        ) as bob,
+    ):
         # Issuance prep
         config = (await alice.get("/status/config"))["config"]
         genesis_url = config.get("ledger.genesis_url")