Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesSynchronizerConnectivityServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.admin.participant.v30ServicesSynchronizerConnectivityService

ConnectSynchronizer

Participant Administration›Protobuf›com.digitalasset.canton.admin.participant.v30›ConnectSynchronizer

com.digitalasset.canton.admin.participant.v30

​
ConnectSynchronizer

gRPCSince 3.4.0Changed 3.5.1
RPC/com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer

​
Protocol Details

​
Inputs

​
ConnectSynchronizerRequest

configSynchronizerConnectionConfig
sequencer_connection_validationSequencerConnectionValidation

​
Outputs

​
ConnectSynchronizerResponse

connected_successfullybool

​
Lifecycle Changes

3.4.0introduced
3.5.1file

com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerRequest

configSynchronizerConnectionConfig
sequencer_connection_validationSequencerConnectionValidation

com.digitalasset.canton.admin.participant.v30.SynchronizerConnectionConfig

synchronizer_aliasstring
sequencer_connectionsSequencerConnections
manual_connectbool
physical_synchronizer_idstring
priorityint32
initial_retry_delayDuration
max_retry_delayDuration
time_trackerSynchronizerTimeTrackerConfig
initialize_from_trusted_synchronizerbool

com.digitalasset.canton.admin.sequencer.v30.SequencerConnections

sequencer_connectionsrepeated SequencerConnection
sequencer_trust_thresholduint32
submission_request_amplificationSubmissionRequestAmplification
sequencer_liveness_marginuint32
sequencer_connection_pool_delaysSequencerConnectionPoolDelays

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection

grpcGrpc
aliasstring
sequencer_idstring

com.digitalasset.canton.admin.sequencer.v30.SequencerConnection.Grpc

connectionsrepeated string
transport_securitybool
custom_trust_certificatesbytes

com.digitalasset.canton.admin.sequencer.v30.SubmissionRequestAmplification

factoruint32
patienceDuration
confirmation_response_factoruint32
confirmation_response_patienceDuration

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionPoolDelays

min_restart_delayDuration
max_restart_delayDuration
subscription_request_delayDuration
warn_validation_delayDuration

com.digitalasset.canton.admin.time.v30.SynchronizerTimeTrackerConfig

observation_latencyDuration
patience_durationDuration
min_observation_durationDuration
time_proof_requestTimeProofRequestConfig

com.digitalasset.canton.admin.time.v30.TimeProofRequestConfig

initial_retry_delayDuration
max_retry_delayDuration
max_sequencing_delayDuration

com.digitalasset.canton.admin.sequencer.v30.SequencerConnectionValidation

  • SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED
  • SEQUENCER_CONNECTION_VALIDATION_DISABLED
  • SEQUENCER_CONNECTION_VALIDATION_ACTIVE
  • SEQUENCER_CONNECTION_VALIDATION_ALL
  • SEQUENCER_CONNECTION_VALIDATION_THRESHOLD_ACTIVE

com.digitalasset.canton.admin.participant.v30.ConnectSynchronizerResponse

connected_successfullybool
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.admin.participant.v30.SynchronizerConnectivityService/ConnectSynchronizer <<'EOF'
{
  "config": {
    "synchronizerAlias": "string",
    "sequencerConnections": {
      "sequencerConnections": [
        {
          "grpc": {},
          "alias": "string",
          "sequencerId": "string"
        }
      ],
      "sequencerTrustThreshold": 0,
      "submissionRequestAmplification": {
        "factor": 0,
        "patience": "string",
        "confirmationResponseFactor": 0,
        "confirmationResponsePatience": "string"
      },
      "sequencerLivenessMargin": 0,
      "sequencerConnectionPoolDelays": {
        "minRestartDelay": "string",
        "maxRestartDelay": "string",
        "subscriptionRequestDelay": "string",
        "warnValidationDelay": "string"
      }
    },
    "manualConnect": true,
    "physicalSynchronizerId": "string",
    "priority": 0,
    "initialRetryDelay": "string",
    "maxRetryDelay": "string",
    "timeTracker": {
      "observationLatency": "string",
      "patienceDuration": "string",
      "minObservationDuration": "string",
      "timeProofRequest": {
        "initialRetryDelay": "string",
        "maxRetryDelay": "string",
        "maxSequencingDelay": "string"
      }
    }
  },
  "sequencerConnectionValidation": "SEQUENCER_CONNECTION_VALIDATION_UNSPECIFIED"
}
EOF
OKapplication/json
OK
{
  "connectedSuccessfully": true
}