Fixed scan comments

[ci]

Signed-off-by: Pasindu Tennage <pasindu.tennage@digitalasset.com>

Author: pasindutennage-da

apps/app/src/pack/examples/sv-helm/validator-values.yaml

@@ -1,36 +1,38 @@
 # SCAN_CLIENT_CONFIGURATION_START
 scanClient:
   scanType: "bft"
-  seedUrls: ["TRUSTED_SCAN_URL"] # replace with actual scan seed url
+  seedUrls: ["TRUSTED_SCAN_URL"] # replace with scan seed url. Supports multiple urls, separated by comma.
 
 # scanClient denotes how the validator makes connections to scan service and supports three modes of operation.
+
 # Mode 1: bft (Byzantine Fault Tolerance)
 # Connects to all available scans in the network. It validates responses by ensuring
 # at least f+1 matching responses are received.
 
 # scanClient:
 #   scanType: "bft"
-#   seedUrls: ["TRUSTED_SCAN_URL"] # replace with actual seed scan url(s).
+#   seedUrls: ["TRUSTED_SCAN_URL"] # replace with scan seed url(s).  Supports multiple urls, separated by comma.
 
 # Mode 2: bft-custom
-# A specialized version of BFT where you specify a subset of trusted SVs.
+# A specialized version of bft where you specify a subset of trusted SVs.
 # The validator connects only to the scans of the SVs listed in 'svNames'.
 # 'threshold' defines how many identical responses are required to consider the scan responses valid.
 
 # scanClient:
 #   scanType: "bft-custom"
-#   svNames: ["TRUSTED_SV_1", "TRUSTED_SV_2"] # replace with actual SV names
-#   seedUrls: ["TRUSTED_SCAN_URL_1", "TRUSTED_SCAN_URL_2"] # replace with actual seed scan urls
-#   threshold: 2
+#   svNames: ["TRUSTED_SV"] # replace with trusted SV names(s)
+#   seedUrls: ["TRUSTED_SCAN_URL"] # replace with actual scan seed urls(s)
+#   threshold: <TRUST_THRESHOLD> # replace with the integer number of matching responses required for validation
 
 # Mode 3: trust-single
 # Connects to a single trusted scan address.
-# This means that you depend on that single SV and if it is broken or
-#  malicious you will be unable to use the network so usually you want to default to not enabling this
+# This means that you depend on that single SV and if it is broken or #  malicious you will be unable to use the network.
+# Hence, usually you want to default to not enabling this
 
 # scanClient:
 #   scanType: "trust-single"
-#   scanAddress: "TRUSTED_SCAN_URL" # replace with the actual trusted scan url
+#   scanAddress: "TRUSTED_SCAN_URL" # replace with the trusted scan url
+
 # SCAN_CLIENT_CONFIGURATION_END
 
 # SYNCHRONIZER_CONFIGURATION_START

docs/src/validator_operator/validator_helm.rst

@@ -379,19 +379,19 @@ Additionally, please modify the file ``splice-node/examples/sv-helm/standalone-p
 
 To configure the validator app, please modify the file ``splice-node/examples/sv-helm/validator-values.yaml`` as follows:
 
+You need to configure how your validator connects to the network's scan services by defining a ``scanClient`` block in your ``validator-values.yaml``.
+There are three modes of ``scanClient``:
+
+- ``bft``: (default type) connects to all scans and validates via $f+1$ agreement.
+- ``bft-custom``: connects to a specific list of trusted SVs and validates against a custom threshold. Replace ``TRUSTED_SV`` with the super validator name(s) you trust. Replace ``TRUST_THRESHOLD`` with an integer representing the number of scan responses that need to agree for a response to be considered valid.
+- ``trust-single``: connects to one specific trusted scan.
+
+- For each scanClient type, replace ``TRUSTED_SCAN_URL`` with a URL of a Scan you host or trust that is reachable by your Validator. For example, the GSF scan URL, |gsf_scan_url|. For ``bft-custom`` and ``bft`` modes of ``scanClient``, you can specify more than one scan seed URL by separating them with commas.
 - If you want to configure the audience for the Validator app backend API, replace ``OIDC_AUTHORITY_VALIDATOR_AUDIENCE`` in the `auth.audience` entry with audience for the Validator app backend API. e.g. ``https://validator.example.com/api``.
 - If you want to configure the audience for the Ledger API, set the ``audience`` field in the `splice-app-validator-ledger-api-auth` k8s secret with the audience for the Ledger API. e.g. ``https://ledger_api.example.com``.
 - Replace ``OPERATOR_WALLET_USER_ID`` with the user ID in your IAM that you want to use to log into the wallet as the validator operator party. Note that this should be the full user id, e.g., ``auth0|43b68e1e4978b000cefba352``, *not* only the suffix ``43b68e1e4978b000cefba352``
 - Replace ``YOUR_CONTACT_POINT`` by a slack user name or email address that can be used by node operators to contact you in case there are issues with your node. Note that this contact information will be publicly visible. If you do not want to share contact information, you can put an empty string.
 - Update the `auth.jwksUrl` entry to point to your auth provider's JWK set document by replacing ``OIDC_AUTHORITY_URL`` with your auth provider's OIDC URL, as explained above.
-
-You can configure how your validator connects to the network's scan services by defining a ``scanClient`` block in your ``validator-values.yaml``.
-There are three modes available:
-
-- ``bft``: connects to all scans and validates via $f+1$ agreement.
-- ``bft-custom``: connects to a specific list of trusted SVs and validates against a custom threshold.
-- ``trust-single``: connects to one specific trusted scan.
-
 Detailed configuration examples and instructions for each mode are provided directly within the comments of the ``validator-values.yaml`` file.
 
 .. literalinclude:: ../../../apps/app/src/pack/examples/sv-helm/validator-values.yaml