Packages

c

com.digitalasset.canton.crypto

DomainSyncCryptoClient

class DomainSyncCryptoClient extends SyncCryptoClient with NamedLogging

Crypto operations on a particular domain

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DomainSyncCryptoClient
  2. NamedLogging
  3. SyncCryptoClient
  4. TopologyClientApi
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DomainSyncCryptoClient(owner: KeyOwner, domainId: DomainId, ips: DomainTopologyClient, crypto: Crypto, cacheConfigs: CachingConfigs, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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 approximateTimestamp: CantonTimestamp

    The approximate timestamp

    The approximate timestamp

    This is either the last observed sequencer timestamp OR the effective timestamp after we observed the time difference of (effective - sequencer = epsilon) to elapse

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def awaitIpsSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]

    Returns a snapshot of the current member topology for the given domain

    Returns a snapshot of the current member topology for the given domain

    The future will wait for the data if the data is not there yet.

    Definition Classes
    DomainSyncCryptoClientSyncCryptoClient
  7. def awaitSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[DomainSnapshotSyncCryptoApi]

    Waits until a snapshot is available

    Waits until a snapshot is available

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  8. def awaitSnapshotUS(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[SyncCryptoApi]

    Shutdown safe version of await snapshot

    Shutdown safe version of await snapshot

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  9. def awaitTimestamp(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[Future[Unit]]

    Returns an optional future which will complete when the timestamp has been observed

    Returns an optional future which will complete when the timestamp has been observed

    If the timestamp is already observed, we return None.

    Note that this function allows to wait for effective time (true) and sequenced time (false). If we wait for effective time, we wait until the topology snapshot for that given point in time is known. As we future date topology transactions (to avoid bottlenecks), this might be before we actually observed a sequencing timestamp.

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  10. def awaitTimestampUS(timestamp: CantonTimestamp, waitForEffectiveTime: Boolean)(implicit traceContext: TraceContext): Option[FutureUnlessShutdown[Unit]]
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. val crypto: Crypto
  13. def currentSnapshotApproximation(implicit traceContext: TraceContext): DomainSnapshotSyncCryptoApi

    Our current snapshot approximation

    Our current snapshot approximation

    As topology transactions are future dated (to prevent sequential bottlenecks), we do have to "guess" the current state, as time is defined by the sequencer after we've sent the transaction. Therefore, this function will return the best snapshot approximation known.

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  14. val domainId: DomainId

    The domain this client applies to

    The domain this client applies to

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def headSnapshot(implicit traceContext: TraceContext): DomainSnapshotSyncCryptoApi

    Possibly future dated head snapshot

    Possibly future dated head snapshot

    As we future date topology transactions, the head snapshot is our latest knowledge of the topology state, but as it can be still future dated, we need to be careful when actually using it: the state might not yet be active, as the topology transactions are future dated. Therefore, do not act towards the sequencer using this snapshot, but use the currentSnapshotApproximation instead.

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  20. val ips: DomainTopologyClient
  21. def ipsSnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[TopologySnapshot]

    Returns a snapshot of the current member topology for the given domain.

    Returns a snapshot of the current member topology for the given domain. The future will log a warning and await the snapshot if the data is not there yet.

    Definition Classes
    DomainSyncCryptoClientSyncCryptoClient
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. val loggerFactory: NamedLoggerFactory
    Definition Classes
    DomainSyncCryptoClientNamedLogging
  25. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. val owner: KeyOwner
  31. def pureCrypto: CryptoPureApi
  32. def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[DomainSnapshotSyncCryptoApi]

    Returns the topology information at a certain point in time

    Returns the topology information at a certain point in time

    Use this method if you are sure to be synchronized with the topology state updates. The method will block & wait for an update, but emit a warning if it is not available

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  33. def snapshotAvailable(timestamp: CantonTimestamp): Boolean

    Returns true if the topology information at the passed timestamp is already known

    Returns true if the topology information at the passed timestamp is already known

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def topologyKnownUntilTimestamp: CantonTimestamp

    The most recently observed effective timestamp

    The most recently observed effective timestamp

    The effective timestamp is sequencer_time + epsilon(sequencer_time), where epsilon is given by the topology change delay time, defined using the domain parameters.

    This is the highest timestamp for which we can serve snapshots

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  37. def trySnapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): DomainSnapshotSyncCryptoApi

    Returns the topology information at a certain point in time

    Returns the topology information at a certain point in time

    Fails with an exception if the state is not yet known.

    Definition Classes
    DomainSyncCryptoClientTopologyClientApi
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from NamedLogging

Inherited from SyncCryptoClient

Inherited from AnyRef

Inherited from Any

Ungrouped