Packages

final class RepairService extends NamedLogging with FlagCloseable with HasCloseContext

Implements the repair commands. Repair commands work only if the participant has disconnected from the affected synchronizers. Additionally for repair commands, which change the Ledger API events: all synchronizers needs to be disconnected, and the indexer is switched to repair mode. Every individual repair command is executed transactionally, i.e., either all its effects are applied or none. This is achieved by the repair-indexer only changing the Synchronizer Indexes for the affected synchronizers after all previous operations were successful, and the emitted Update events are all persisted. In case of an error during repair, or crash during repair: on node and synchronizer recovery all the changes will be purged. During a repair operation (as synchronizers are disconnected) no new events are visible on the Ledger API, neither the ones added by the ongoing repair. As the repair operation successfully finished new events (if any) will become visible on the Ledger API - Ledger End and synchronizer indexes change, open tailing streams start emitting the repair events if applicable.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RepairService
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. FlagCloseable
  5. PerformUnlessClosing
  6. HasSynchronizeWithReaders
  7. HasSynchronizeWithClosing
  8. OnShutdownRunner
  9. HasRunOnClosing
  10. HasUnlessClosing
  11. AutoCloseable
  12. NamedLogging
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RepairService(participantId: ParticipantId, syncCrypto: SyncCryptoApiParticipantProvider, packageDependencyResolver: PackageDependencyResolver, contractAuthenticator: ContractAuthenticator, contractStore: Eval[ContractStore], ledgerApiIndexer: Eval[LedgerApiIndexer], aliasManager: SynchronizerAliasManager, parameters: ParticipantNodeParameters, syncPersistentStateLookup: SyncPersistentStateLookup, connectedSynchronizersLookup: ConnectedSynchronizersLookup, executionQueue: SimpleExecutionQueue, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

    executionQueue

    Sequential execution queue on which repair actions must be run. This queue is shared with the CantonSyncService, which uses it for synchronizer connections. Sharing it ensures that we cannot connect to the synchronizer while a repair action is running and vice versa. It also ensure only one repair runs at a time. This ensures concurrent activity among repair operations does not corrupt state.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addContracts(synchronizerAlias: SynchronizerAlias, contracts: Seq[RepairContract], ignoreAlreadyAdded: Boolean, ignoreStakeholderCheck: Boolean, workflowIdPrefix: Option[String] = None)(implicit traceContext: TraceContext): Either[String, Unit]

    Participant repair utility for manually adding contracts to a synchronizer in an offline fashion.

    Participant repair utility for manually adding contracts to a synchronizer in an offline fashion.

    synchronizerAlias

    alias of synchronizer to add contracts to. The synchronizer needs to be configured, but disconnected to prevent race conditions.

    contracts

    contracts to add. Relevant pieces of each contract: create-arguments (LfThinContractInst), template-id (LfThinContractInst), 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 synchronizer. Setting this to true (at least on retries) enables writing idempotent repair scripts.

    ignoreStakeholderCheck

    do not check for stakeholder presence for the given parties

    workflowIdPrefix

    If present, each transaction generated for added contracts will have a workflow ID whose prefix is the one set and the suffix is a sequential number and the number of transactions generated as part of the addition (e.g. import-foo-1-2, import-foo-2-2)

  5. def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def awaitCleanSequencerTimestamp(synchronizerId: SynchronizerId, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    Allows to wait until clean sequencer index has progressed up to a certain timestamp

  8. def changeAssignation(contracts: NonEmpty[Seq[(LfContractId, Option[ReassignmentCounter])]], sourceSynchronizer: Source[SynchronizerId], targetSynchronizer: Target[SynchronizerId], skipInactive: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    Change the assignation of a contract from one synchronizer to another

    Change the assignation of a contract from one synchronizer to another

    This function here allows us to manually insert a unassignment/assignment into the respective journals in order to change the assignation of a contract from one synchronizer to another. The procedure will result in a consistent state if and only if all the counter parties run the same command. Failure to do so, will results in participants reporting errors and possibly break.

    contracts

    Contracts whose assignation should be changed. The reassignment counter is by default incremented by one. A non-empty reassignment counter allows to override the default behavior with the provided counter.

    skipInactive

    If true, then the migration will skip contracts in the contractId list that are inactive

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  11. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  12. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def ignoreEvents(synchronizerId: PhysicalSynchronizerId, fromInclusive: SequencerCounter, toInclusive: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
  19. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunnerHasUnlessClosing
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  22. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    RepairServiceNamedLogging
  24. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  25. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  26. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    RepairServicePerformUnlessClosing
  33. final def onFirstClose(): 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
    PerformUnlessClosingOnShutdownRunner
  34. def purgeContracts(synchronizerAlias: SynchronizerAlias, contractIds: NonEmpty[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.

    synchronizerAlias

    alias of synchronizer to purge contracts from. The synchronizer 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.

  35. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  36. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  37. def rollbackUnassignment(reassignmentId: ReassignmentId, source: Source[SynchronizerId], target: Target[SynchronizerId])(implicit context: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    Rollback the Unassignment.

    Rollback the Unassignment. The contract is re-assigned to the source synchronizer. The reassignment counter is increased by two. The contract is inserted into the contract store on the target synchronizer if it is not already there. Additionally, we publish the reassignment events.

  38. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  39. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  40. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  41. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  42. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  43. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  44. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  45. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  46. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  47. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    RepairServiceFlagCloseable
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. def unignoreEvents(synchronizerId: PhysicalSynchronizerId, fromInclusive: SequencerCounter, toInclusive: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
  52. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasCloseContext

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped