Renamed Validator ScanClient trustedSvs to svNames (#3620)

Fixes #3496

[ci]

Signed-off-by: Pasindu Tennage <[email protected]>

Author: pasindutennage-da

apps/app/src/test/scala/org/lfdecentralizedtrust/splice/integration/tests/ConfigurationProvidedBftScanConnectionIntegrationTest.scala

@@ -35,8 +35,7 @@ class ConfigurationProvidedBftScanConnectionIntegrationTest
                 Uri("http://127.0.0.1:5012"),
                 Uri("http://127.0.0.1:5112"),
               ),
-              trustedSvs =
-                NonEmptyList.of(s"${getSvName(1)}", s"${getSvName(2)}", s"${getSvName(3)}"),
+              svNames = NonEmptyList.of(s"${getSvName(1)}", s"${getSvName(2)}", s"${getSvName(3)}"),
               threshold = Some(2),
               scansRefreshInterval = NonNegativeFiniteDuration.ofSeconds(5),
             )

apps/scan/src/main/scala/org/lfdecentralizedtrust/splice/scan/admin/api/client/BftScanConnection.scala

@@ -1092,7 +1092,7 @@ object BftScanConnection {
   }
 
   class ConfigurationProvidedScansBft(
-      trustedSvs: NonEmptyList[String],
+      svNames: NonEmptyList[String],
       threshold: Option[Int],
       override val initialScanConnections: Seq[SingleScanConnection],
       override val initialFailedConnections: Map[Uri, Throwable],
@@ -1105,12 +1105,12 @@ object BftScanConnection {
   )(implicit override val ec: ExecutionContext, tc: TraceContext)
       extends Bft {
 
-    private val trustedSvsSet = trustedSvs.toList.toSet
+    private val svNamesSet = svNames.toList.toSet
 
     override protected def filterScans(allScans: Seq[DsoScan]): Seq[DsoScan] = {
-      val targetScans = allScans.filter(scan => trustedSvsSet.contains(scan.svName))
+      val targetScans = allScans.filter(scan => svNamesSet.contains(scan.svName))
       val foundSvs = targetScans.map(_.svName).toSet
-      val missingSvs = trustedSvsSet -- foundSvs
+      val missingSvs = svNamesSet -- foundSvs
 
       logger.trace(s"Discovered the following trusted scans from the network: ${targetScans
           .map(s => s"Name=${s.svName}, URL=${s.publicUrl}")
@@ -1126,13 +1126,13 @@ object BftScanConnection {
     }
 
     override protected def getRequiredConnections(state: BftState): Int = {
-      threshold.getOrElse(Thresholds.requiredNumScanThreshold(trustedSvs.size).value)
+      threshold.getOrElse(Thresholds.requiredNumScanThreshold(svNames.size).value)
     }
 
     override def scanConnections: ScanConnections = {
       val connections = currentConnectionsState
       connections.copy(
-        targetTotalNumber = Some(trustedSvs.size),
+        targetTotalNumber = Some(svNames.size),
         threshold = threshold,
       )
     }
@@ -1316,7 +1316,7 @@ object BftScanConnection {
           // Use the temporary connection to get a consensus on the full list of scans
           allScans <- Bft.getScansInDsoRules(tempBftConnection)
 
-          trustedScans = allScans.filter(scan => ts.trustedSvs.toList.contains(scan.svName))
+          trustedScans = allScans.filter(scan => ts.svNames.toList.contains(scan.svName))
 
           trustedScanDetails = trustedScans
             .map(s => s"  - Name: ${s.svName}, URL: ${s.publicUrl}")
@@ -1346,7 +1346,7 @@ object BftScanConnection {
           )
 
           scanList = new ConfigurationProvidedScansBft(
-            ts.trustedSvs,
+            ts.svNames,
             ts.threshold,
             connections,
             failed.toMap,
@@ -1554,7 +1554,7 @@ object BftScanConnection {
     case class BftCustom(
         seedUrls: NonEmptyList[Uri], // by default only one seed_url is provided
         threshold: Option[Int] = None, // default to len(seedUrls)/3+1
-        trustedSvs: NonEmptyList[String], // should be at least 1
+        svNames: NonEmptyList[String], // should be at least 1
         amuletRulesCacheTimeToLive: NonNegativeFiniteDuration =
           ScanAppClientConfig.DefaultAmuletRulesCacheTimeToLive,
         scansRefreshInterval: NonNegativeFiniteDuration =

cluster/deployment/mock/config.yaml

@@ -309,7 +309,7 @@ validators:
         scanType: "bft-custom"
         seedUrls: [ "https://scan.sv-2-eng.test.network.canton.global","https://scan.sv-3-eng.test.network.canton.global" ]
         threshold: 2
-        trustedSvs: [ "Digital-Asset-Eng-2","Digital-Asset-Eng-3" ]
+        svNames: [ "Digital-Asset-Eng-2","Digital-Asset-Eng-3" ]
       additionalEnvVars:
         - name: ADDITIONAL_ENV_VAR_VALIDATOR_NAME
           value: ADDITIONAL_ENV_VAR_VALIDATOR_NAME

cluster/expected/validator-runbook/expected.json

@@ -730,11 +730,11 @@
             "https://scan.sv-2-eng.test.network.canton.global",
             "https://scan.sv-3-eng.test.network.canton.global"
           ],
-          "threshold": 2,
-          "trustedSvs": [
+          "svNames": [
             "Digital-Asset-Eng-2",
             "Digital-Asset-Eng-3"
-          ]
+          ],
+          "threshold": 2
         },
         "spliceInstanceNames": {
           "amuletName": "Amulet",

cluster/helm/splice-validator/templates/validator.yaml

@@ -118,7 +118,7 @@ spec:
               {{- else if eq .Values.scanClient.scanType "bft-custom"}}
             canton.validator-apps.validator_backend.scan-client.type = "bft-custom"
             canton.validator-apps.validator_backend.scan-client.seed-urls = {{ .Values.scanClient.seedUrls | toJson }}
-            canton.validator-apps.validator_backend.scan-client.trusted-svs = {{ .Values.scanClient.trustedSvs | toJson }}
+            canton.validator-apps.validator_backend.scan-client.sv-names = {{ .Values.scanClient.svNames | toJson }}
             canton.validator-apps.validator_backend.scan-client.threshold = {{ .Values.scanClient.threshold }}
               {{- else }}
             canton.validator-apps.validator_backend.scan-client.type = "bft"

cluster/helm/splice-validator/tests/validator_test.yaml

@@ -158,12 +158,12 @@ tests:
           path: spec.template.spec.containers[?(@.name=='validator-app')].env[?(@.name=='ADDITIONAL_CONFIG_BFT_SCAN')].value
           pattern: 'canton.validator-apps.validator_backend.scan-client.seed-urls = \["https://bft-node-1.url:5003","https://bft-node-2.url:5003"\]'
 
-  - it: "configures scan-client for bft-custom mode, including trustedSvs and threshold"
+  - it: "configures scan-client for bft-custom mode, including svNames and threshold"
     set:
       scanClient:
         scanType: "bft-custom"
         seedUrls: [ "https://custom-node-A.com", "https://custom-node-B.com" ]
-        trustedSvs: [ "custom-sv-1", "custom-sv-2", "custom-sv-3" ]
+        svNames: [ "custom-sv-1", "custom-sv-2", "custom-sv-3" ]
         threshold: 2
     documentSelector:
       path: kind
@@ -177,7 +177,7 @@ tests:
           pattern: 'canton.validator-apps.validator_backend.scan-client.seed-urls = \["https://custom-node-A.com","https://custom-node-B.com"\]'
       - matchRegex:
           path: spec.template.spec.containers[?(@.name=='validator-app')].env[?(@.name=='ADDITIONAL_CONFIG_BFT_SCAN')].value
-          pattern: 'canton.validator-apps.validator_backend.scan-client.trusted-svs = \["custom-sv-1","custom-sv-2","custom-sv-3"\]'
+          pattern: 'canton.validator-apps.validator_backend.scan-client.sv-names = \["custom-sv-1","custom-sv-2","custom-sv-3"\]'
       - matchRegex:
           path: spec.template.spec.containers[?(@.name=='validator-app')].env[?(@.name=='ADDITIONAL_CONFIG_BFT_SCAN')].value
           pattern: "canton.validator-apps.validator_backend.scan-client.threshold = 2"

cluster/helm/splice-validator/values.schema.json

@@ -62,7 +62,7 @@
           "minimum": 0,
           "description": "bft-custom threshold. Optional unless scan-type is bft-custom."
         },
-        "trustedSvs": {
+        "svNames": {
           "type": "array",
           "items": {
             "type": "string"
@@ -134,7 +134,7 @@
       "then": {
         "properties": {
           "scanClient": {
-            "required": ["threshold", "trustedSvs"]
+            "required": ["threshold", "svNames"]
           }
         }
       }

cluster/pulumi/common-validator/src/config.ts

@@ -42,23 +42,23 @@ export const ScanClientConfigSchema = z
     scanType: z.enum(['trust-single', 'bft', 'bft-custom']),
     scanAddress: z.string().optional(),
     threshold: z.number().default(0),
-    trustedSvs: z.array(z.string()).default([]),
+    svNames: z.array(z.string()).default([]),
     seedUrls: z.array(z.string()).min(1, 'seedUrls must contain at least one element.').optional(),
   })
   .refine(
     data => {
       if (data.scanType === 'bft-custom') {
         const threshold = data.threshold;
-        const trustedSvsSize = data.trustedSvs.length;
+        const svNamesSize = data.svNames.length;
         const seedUrlsSize = data.seedUrls ? data.seedUrls.length : 0;
-        return trustedSvsSize >= threshold && seedUrlsSize >= threshold;
+        return svNamesSize >= threshold && seedUrlsSize >= threshold;
       } else {
         return true;
       }
     },
     {
       message:
-        "For 'bft-custom' scanType, both 'trustedSvs' and 'seedUrls' must have a length greater than or equal to 'threshold'.",
+        "For 'bft-custom' scanType, both 'svNames' and 'seedUrls' must have a length greater than or equal to 'threshold'.",
       path: ['scanType'],
     }
   );