class CantonSyncService extends WriteService with WriteParticipantPruningService with ReadService with FlagCloseable with Spanning with NamedLogging
The Canton-based synchronization service.
A single Canton sync service can connect to multiple domains.
- Alphabetic
- By Inheritance
- CantonSyncService
- NamedLogging
- Spanning
- FlagCloseable
- AutoCloseable
- ReadService
- WriteService
- ReportsHealth
- WriteParticipantPruningService
- WriteConfigService
- WritePartyService
- WritePackagesService
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CantonSyncService(participantId: ParticipantId, domainRegistry: DomainRegistry, domainConnectionConfigStore: DomainConnectionConfigStore, aliasManager: DomainAliasManager, participantNodePersistentState: ParticipantNodePersistentState, participantNodeEphemeralState: ParticipantNodeEphemeralState, syncDomainPersistentStateManager: SyncDomainPersistentStateManager, syncDomainPersistentStateFactory: SyncDomainPersistentStateFactory, packageService: PackageService, topologyStoreFactory: TopologyStoreFactory, domainCausalityStore: MultiDomainCausalityStore, topologyManager: ParticipantTopologyManager, identityPusher: ParticipantTopologyDispatcher, partyNotifier: LedgerServerPartyNotifier, syncCrypto: SyncCryptoApiProvider, pruningProcessor: PruningProcessor, ledgerId: LedgerId, engine: Engine, syncDomainStateFactory: SyncDomainEphemeralStateFactory, clock: Clock, resourceManagementService: ResourceManagementService, parameters: ParticipantNodeParameters, syncDomainFactory: Factory[SyncDomain], indexedStringStore: IndexedStringStore, metrics: ParticipantMetrics, isActive: () => Boolean, futureSupervisor: FutureSupervisor, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext, mat: Materializer, tracer: Tracer)
- participantId
The participant node id hosting this sync service.
- domainRegistry
Domain registry for connecting to domains.
- domainConnectionConfigStore
Storage for domain connection configs
- packageService
Underlying package management service.
- syncCrypto
Synchronisation crypto utility combining IPS and Crypto operations.
- isActive
Returns true of the node is the active replica
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addContractsRepair(domain: DomainAlias, contractsToAdd: Seq[SerializableContractWithWitnesses], ignoreAlreadyAdded: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually adding contracts to a domain in an offline fashion.
Participant repair utility for manually adding contracts to a domain in an offline fashion.
- domain
alias of domain to add contracts to. The domain needs to be configured, but disconnected to prevent race conditions.
- contractsToAdd
contracts to add. Relevant pieces of each contract: create-arguments (LfContractInst), template-id (LfContractInst), contractId, ledgerCreateTime, salt (to be added to SerializableContract), and witnesses, SerializableContract.metadata is only validated, but otherwise ignored as stakeholder and signatories can be recomputed from contracts.
- ignoreAlreadyAdded
whether to ignore and skip over contracts already added/present in the domain. Setting this to true (at least on retries) enables writing idempotent repair scripts.
- def addDomain(config: DomainConnectionConfig)(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Unit]
Adds a new domain to the sync service's configuration.
Adds a new domain to the sync service's configuration.
NOTE: Does not automatically connect the sync service to the new domain.
- config
The domain configuration.
- returns
Error or unit.
- def allocateParty(hint: Option[LfPartyId], displayName: Option[String], rawSubmissionId: LedgerSubmissionId)(implicit _loggingContext: LoggingContext, telemetryContext: TelemetryContext): CompletionStage[SubmissionResult]
- Definition Classes
- CantonSyncService → WritePartyService
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def changeDomainRepair(contractIds: Seq[LfContractId], sourceDomain: DomainAlias, targetDomain: DomainAlias, skipInactive: Boolean)(implicit tranceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.
Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.
- contractIds
ids of contracts to move that reside in the sourceDomain (or for idempotency already in the targetDomain)
- sourceDomain
alias of source domain from which to move contracts
- targetDomain
alias of target domain to which to move contracts
- skipInactive
whether to only move contracts that are active in the source domain
- def checkOverloaded(telemetryContext: TelemetryContext): Option[SubmissionResult]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → AutoCloseable
- Annotations
- @SuppressWarnings()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def computeTotalLoad: Int
- def configuredDomains: Seq[DomainConnectionConfig]
Returns the domains this sync service is configured with.
- def connectDomain(domainAlias: DomainAlias, keepRetrying: Boolean)(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Boolean]
Connect the sync service to the given domain.
Connect the sync service to the given domain. This method makes sure there can only be one connection in progress at a time.
- def currentHealth(): HealthStatus
- Definition Classes
- CantonSyncService → ReportsHealth
- def currentWriteHealth(): HealthStatus
- def disconnectDomain(domain: DomainAlias)(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Unit]
Disconnect the given domain from the sync service.
- def disconnectDomains()(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Unit]
Disconnect from all connected domains.
- def domainConnectionConfigByAlias(domainAlias: DomainAlias): EitherT[Future, MissingConfigForAlias, DomainConnectionConfig]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ignoreEventsRepair(domain: DomainId, from: SequencerCounter, to: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
- def initializeState()(implicit traceContext: TraceContext): Unit
- def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val isActive: () => Boolean
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.
- Definition Classes
- FlagCloseable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfOpenFutures: Boolean
track running futures on shutdown
track running futures on shutdown
set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def ledgerInitialConditions(): Source[LedgerInitialConditions, NotUsed]
- Definition Classes
- CantonSyncService → ReadService
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- CantonSyncService → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def lookupDomainTimeTracker(domainId: DomainId): Option[DomainTimeTracker]
Lookup a time tracker for the given
domainId.Lookup a time tracker for the given
domainId. A time tracker will only be returned if the domain is registered and connected. - val maxDeduplicationDuration: NonNegativeFiniteDuration
- def modifyDomain(config: DomainConnectionConfig)(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Unit]
Modifies the settings of the sync-service's configuration
Modifies the settings of the sync-service's configuration
NOTE: This does not automatically reconnect the sync service.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onClosed(): Unit
- Definition Classes
- CantonSyncService → FlagCloseable
- val participantId: ParticipantId
- def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherT[E, R](onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.- f
The task to perform
- returns
The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.
- Definition Classes
- FlagCloseable
- def prune(pruneUpToInclusive: LedgerSyncOffset, submissionId: LedgerSubmissionId, _pruneAllDivulgedContracts: Boolean): CompletionStage[PruningResult]
- Definition Classes
- CantonSyncService → WriteParticipantPruningService
- def pruneInternally(pruneUpToInclusive: LedgerSyncOffset)(implicit traceContext: TraceContext): EitherT[Future, CantonError, Unit]
- def pureCryptoApi: CryptoPureApi
Returns the pure crypto operations used for the sync protocol
- def purgeContractsRepair(domain: DomainAlias, contractIds: Seq[LfContractId], ignoreAlreadyPurged: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually purging (archiving) contracts in an offline fashion.
Participant repair utility for manually purging (archiving) contracts in an offline fashion.
- domain
alias of domain to purge contracts from. The domain needs to be configured, but disconnected to prevent race conditions.
- contractIds
lf contract ids of contracts to purge
- ignoreAlreadyPurged
whether to ignore already purged contracts.
- def purgeDomain(domain: DomainAlias): Either[SyncServiceError, Unit]
Removes a configured and disconnected domain.
Removes a configured and disconnected domain.
This is an unsafe operation as it changes the ledger offsets.
- def readyDomains: Map[DomainAlias, (DomainId, Boolean)]
Returns the ready domains this sync service is connected to.
- def reconnectDomains(ignoreFailures: Boolean)(implicit traceContext: TraceContext): EitherT[Future, SyncServiceError, Seq[DomainAlias]]
Reconnect to all configured domains that have autoStart = true
- def recoveringDomains: Map[DomainAlias, DomainId]
Returns the recovering domains this sync service is connected to.
Returns the recovering domains this sync service is connected to. "Recovering" means connected, but not yet ready to use.
- def refreshCaches()(implicit traceContext: TraceContext): Future[Unit]
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- lazy val stateInspection: SyncStateInspection
- def stateUpdates(beginAfterOffset: Option[LedgerSyncOffset])(implicit loggingContext: LoggingContext): Source[(LedgerSyncOffset, LedgerSyncEvent), NotUsed]
Build source for subscription (for ledger api server indexer).
Build source for subscription (for ledger api server indexer).
- beginAfterOffset
offset after which to emit events
- Definition Classes
- CantonSyncService → ReadService
- def submitConfiguration(_maxRecordTimeToBeRemovedUpstream: LedgerSyncRecordTime, submissionId: LedgerSubmissionId, config: Configuration)(implicit _loggingContext: LoggingContext, telemetryContext: TelemetryContext): CompletionStage[SubmissionResult]
- Definition Classes
- CantonSyncService → WriteConfigService
- def submitTransaction(submitterInfo: SubmitterInfo, transactionMeta: TransactionMeta, transaction: LfSubmittedTransaction, estimatedInterpretationCost: Long)(implicit _loggingContext: LoggingContext, telemetryContext: TelemetryContext): CompletionStage[SubmissionResult]
- Definition Classes
- CantonSyncService → WriteService
- val syncCrypto: SyncCryptoApiProvider
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- CantonSyncService → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit val tracer: Tracer
- val transferService: TransferService
- def unignoreEventsRepair(domain: DomainId, from: SequencerCounter, to: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
- def uploadPackages(submissionId: LedgerSubmissionId, archives: List[Archive], sourceDescription: Option[String])(implicit _loggingContext: LoggingContext, telemetryContext: TelemetryContext): CompletionStage[SubmissionResult]
- Definition Classes
- CantonSyncService → WritePackagesService
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withNewTrace[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning
- def withSpan[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit traceContext: TraceContext, tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning
- def withSpanFromGrpcContext[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
- Attributes
- protected
- Definition Classes
- Spanning