Type Members

1.  type ActiveContract[+CtTyId, +LfV] = fetchcontracts.ActiveContract[CtTyId, LfV]
2.  final case class AllocatePartyRequest(identifierHint: Option[Party]) extends Product with Serializable
3.  final case class ArchivedContract(contractId: ContractId, templateId: ContractTypeId.RequiredPkgId) extends Product with Serializable
4.  final case class AsyncWarningsWrapper(warnings: ServiceWarning) extends Product with Serializable
5.  type Base16 = @@[ByteString, Base16Tag]
6.  sealed trait Base16Tag extends AnyRef
7.  type Base64 = @@[ByteString, Base64Tag]
8.  sealed trait Base64Tag extends AnyRef
9.  final case class CanActAs(party: Party) extends UserRight with Product with Serializable
10.  final case class CanReadAs(party: Party) extends UserRight with Product with Serializable
11.  type Choice = @@[String, ChoiceTag]
12.  type CommandId = @@[String, ledger.api.refinements.ApiTypes.CommandIdTag]
13.  type CommandIdTag = ledger.api.refinements.ApiTypes.CommandIdTag
14.  final case class CommandMeta[+TmplId](commandId: Option[CommandId], actAs: Option[NonEmptyList[Party]], readAs: Option[List[Party]], submissionId: Option[SubmissionId], workflowId: Option[WorkflowId], deduplicationPeriod: Option[DeduplicationPeriod], disclosedContracts: Option[List[DisclosedContract[TmplId]]], synchronizerId: Option[SynchronizerId], packageIdSelectionPreference: Option[List[PackageId]]) extends Product with Serializable
    TmplId

    disclosed contracts' template ID

15.  class CommandService extends NamedLogging with NoTracing

    Annotations

    @nowarn()

16.  type CompletionOffset = @@[String, CompletionOffsetTag]
17.  sealed trait CompletionOffsetTag extends AnyRef
18.  final case class Contract[LfV](value: \/[ArchivedContract, ResolvedCtTyId[LfV]]) extends Product with Serializable
19.  type ContractId = @@[String, ContractIdTag]
20.  final case class ContractKeyStreamRequest[+Cid, +LfV](contractIdAtOffset: Cid, ekey: EnrichedContractKey[LfV]) extends Product with Serializable
21.  sealed abstract class ContractLocator[+LfV] extends Product with Serializable
22.  sealed abstract class ContractTypeId[+PkgId] extends Product3[PkgId, String, String] with Serializable with Ops[ContractTypeId, PkgId]

    A contract type ID that may be either a template or an interface ID.

    A contract type ID that may be either a template or an interface ID. A ContractTypeId.ResolvedPkg ID will always be either ContractTypeId.Template or ContractTypeId.Interface; an unresolved ID may be one of those, which indicates an expectation of what the resolved ID will be, or neither, which indicates that resolving what kind of ID this is will be part of the resolution.

    Built-in equality is solely determined by the triple of package ID, module name, entity name. This is because there are likely insidious expectations that this be true dating to before contract type IDs were distinguished at all, and we are only interested in distinguishing them statically, which these types do, and by pattern-matching, which does work.

    val selector: ContractTypeId[Unit] = Template((), "M", "E")
    selector match {
      case ContractTypeId.Unknown(p, m, e) => // this will not match
      case ContractTypeId.Interface(p, m, e) => // this will not match
      case ContractTypeId.Template(p, m, e) => // this will match
    }

23.  sealed abstract class ContractTypeIdLike[CtId[T] <: ContractTypeId[T]] extends AnyRef

    A contract type ID companion.

24.  sealed abstract class ContractTypeRef[+CtTyId[T] <: ContractTypeId[T]] extends AnyRef
25.  class ContractsService extends NamedLogging with NoTracing
26.  final case class CreateAndExerciseCommand[+Payload, +Arg, +TmplId, +IfceId](templateId: TmplId, payload: Payload, choice: Choice, argument: Arg, choiceInterfaceId: Option[IfceId], meta: Option[CommandMeta[TmplId]]) extends Product with Serializable
27.  final case class CreateCommand[+LfV, +TmplId](templateId: TmplId, payload: LfV, meta: Option[NoDisclosed]) extends Product with Serializable
28.  final case class CreateCommandResponse[+LfV](contractId: ContractId, templateId: ContractTypeId.Template.RequiredPkgId, key: Option[LfV], payload: LfV, signatories: Seq[Party], observers: Seq[Party], completionOffset: CompletionOffset) extends Product with Serializable
29.  final case class CreateUserRequest(userId: String, primaryParty: Option[String], rights: Option[List[UserRight]]) extends Product with Serializable
30.  sealed abstract class DeduplicationPeriod extends Product with Serializable
31.  final case class DeleteUserRequest(userId: String) extends Product with Serializable
32.  final case class DisclosedContract[+TmplId](contractId: ContractId, templateId: TmplId, createdEventBlob: Base64) extends Product with Serializable
33.  class Endpoints extends NamedLogging with NoTracing
34.  final case class EnrichedContractId(templateId: Option[ContractTypeId.RequiredPkg], contractId: ContractId) extends ContractLocator[Nothing] with Product with Serializable
35.  final case class EnrichedContractKey[+LfV](templateId: ContractTypeId.Template.RequiredPkg, key: LfV) extends ContractLocator[LfV] with Product with Serializable
36.  type Error = fetchcontracts.Error
37.  sealed trait ErrorDetail extends Product with Serializable
38.  final case class ErrorInfoDetail(errorCodeId: String, metadata: Map[String, String]) extends ErrorDetail with Product with Serializable
39.  final case class ErrorResponse(errors: List[String], warnings: Option[ServiceWarning], status: StatusCode, ledgerApiError: Option[LedgerApiError] = None) extends SyncResponse[Nothing] with Product with Serializable
40.  final case class ExerciseCommand[+PkgId, +LfV, +Ref](reference: Ref, choice: Choice, argument: LfV, choiceInterfaceId: Option[ContractTypeId[PkgId]], meta: Option[CommandMeta[Template[PkgId]]]) extends Product with Serializable
41.  final case class ExerciseResponse[LfV](exerciseResult: LfV, events: List[Contract[LfV]], completionOffset: CompletionOffset) extends Product with Serializable
42.  final case class FetchRequest[+LfV](locator: ContractLocator[LfV], readAs: Option[NonEmptyList[Party]]) extends Product with Serializable
43.  final case class GetActiveContractsRequest(templateIds: NonEmpty[Set[ContractTypeId.RequiredPkg]], readAs: Option[NonEmptyList[Party]]) extends Product with Serializable
44.  final case class GetUserRequest(userId: String) extends Product with Serializable
45.  final case class GrantUserRightsRequest(userId: String, rights: List[UserRight]) extends Product with Serializable
46.  trait HasTemplateId[-F[_]] extends AnyRef
47.  final class HealthService extends AnyRef
48.  final case class HttpServerConfig(address: String = HttpServerConfig.defaultAddress, port: Option[Int] = None, portFile: Option[Path] = None, pathPrefix: Option[String] = None, requestTimeout: FiniteDuration = HttpServerConfig.defaultRequestTimeout) extends Product with Serializable

    JSON API HTTP server configuration.

    JSON API HTTP server configuration.

    address

    The address to bind the HTTP server to. Defaults to the loopback address.

    port

    The port to bind the HTTP server to. If not specified, the port will be dynamically assigned.

    portFile

    Optional file to write the port number to after the server starts. This is useful for other processes to discover the port on which the server is running.

    pathPrefix

    The path prefix for the HTTP server. If specified, all routes will be prefixed with this path.

    requestTimeout

    The timeout for HTTP requests. Defaults to 20 seconds. Increase this value if you expect to handle long-running requests. As the backing server is implemented by Pekko HTTP, this configuration overrides the provided Pekko configuration (pekko.http.server.request-timeout).

49.  class HttpService extends ResourceOwner[ServerBinding] with NamedLogging with NoTracing
50.  type InputContractRef[LfV] = \/[(http.ContractTypeId.Template.RequiredPkg, LfV), (Option[http.ContractTypeId.RequiredPkg], ContractId)]
51.  final case class JsonApiConfig(server: HttpServerConfig, websocketConfig: Option[WebsocketConfig] = None, debugLoggingOfHttpBodies: Boolean = false, damlDefinitionsServiceEnabled: Boolean = false, userManagementWithoutAuthorization: Boolean = false) extends StartSettings with Product with Serializable
52.  sealed abstract case class JwtPayload extends JwtPayloadG with Product with Serializable
53.  trait JwtPayloadG extends AnyRef
54.  trait JwtPayloadTag extends AnyRef
55.  final case class JwtWritePayload(userId: UserId, submitter: NonEmptyList[Party], readAs: List[Party]) extends JwtPayloadG with Product with Serializable
56.  final case class LedgerApiError(code: Int, message: String, details: Seq[ErrorDetail]) extends Product with Serializable
57.  final case class LedgerClientJwt(loggerFactory: NamedLoggerFactory) extends NamedLogging with Product with Serializable
58.  type LfType = Type
59.  type LfValue = Value
60.  final case class ListUserRightsRequest(userId: String) extends Product with Serializable
61.  type Offset = @@[String, OffsetTag]
62.  final case class OkResponse[+R](result: R, warnings: Option[ServiceWarning] = None, status: StatusCode = StatusCodes.OK) extends SyncResponse[R] with Product with Serializable
63.  class PackageManagementService extends AnyRef
64.  class PackageService extends NamedLogging with NoTracing
65.  class PartiesService extends AnyRef
66.  type Party = @@[String, PartyTag]
67.  final case class PartyDetails(identifier: Party, isLocal: Boolean) extends Product with Serializable
68.  type PartySet = NonEmpty[Set[fetchcontracts.Party]]
69.  final case class RequestInfoDetail(correlationId: String) extends ErrorDetail with Product with Serializable
70.  type ResolvedContractRef[LfV] = \/[(http.ContractTypeId.Template.RequiredPkg, LfV), (http.ContractTypeId.RequiredPkg, ContractId)]
71.  sealed abstract class ResolvedQuery extends Product with Serializable
72.  final case class ResourceInfoDetail(name: String, typ: String) extends ErrorDetail with Product with Serializable
73.  final case class RetryInfoDetail(duration: RetryInfoDetailDuration) extends ErrorDetail with Product with Serializable
74.  type RetryInfoDetailDuration = @@[Duration, RetryInfoDetailDurationTag]
75.  sealed trait RetryInfoDetailDurationTag extends AnyRef
76.  final case class RevokeUserRightsRequest(userId: String, rights: List[UserRight]) extends Product with Serializable
77.  final case class SearchForeverQuery(templateIds: NonEmpty[Set[ContractTypeId.RequiredPkg]], offset: Option[Offset]) extends Product with Serializable
78.  final case class SearchForeverRequest(queriesWithPos: NonEmptyList[(SearchForeverQuery, Int)]) extends Product with Serializable
79.  sealed abstract class ServiceWarning extends Serializable with Product
80.  trait StartSettings extends AnyRef
81.  final case class StartingOffset(offset: Offset) extends Product with Serializable
82.  type SubmissionId = @@[String, SubmissionIdTag]
83.  sealed trait SubmissionIdTag extends AnyRef
84.  sealed abstract class SyncResponse[+R] extends Product with Serializable
85.  final case class UnknownParties(unknownParties: List[Party]) extends ServiceWarning with Product with Serializable
86.  final case class UnknownTemplateIds(unknownTemplateIds: List[ContractTypeId.RequiredPkg]) extends ServiceWarning with Product with Serializable
87.  final case class UserDetails(userId: String, primaryParty: Option[String]) extends Product with Serializable
88.  type UserId = @@[String, ledger.api.refinements.ApiTypes.UserIdTag]
89.  type UserIdTag = ledger.api.refinements.ApiTypes.UserIdTag
90.  sealed abstract class UserRight extends Product with Serializable
91.  class WebSocketService extends NamedLogging with NoTracing
92.  final case class WebsocketConfig(maxDuration: FiniteDuration = WSC.DefaultMaxDuration, throttleElem: Int = WSC.DefaultThrottleElem, throttlePer: FiniteDuration = WSC.DefaultThrottlePer, maxBurst: Int = WSC.DefaultMaxBurst, mode: ThrottleMode = WSC.DefaultThrottleMode, heartbeatPeriod: FiniteDuration = WSC.DefaultHeartbeatPeriod, httpListMaxElementsLimit: Long = WSC.DefaultHttpListMaxElementsLimit, httpListWaitTime: FiniteDuration = WSC.DefaultHttpListWaitTime) extends Product with Serializable
93.  class WebsocketEndpoints extends NamedLogging with NoTracing
94.  type WorkflowId = @@[String, WorkflowIdTag]
95.  type WorkflowIdTag = ledger.api.refinements.ApiTypes.WorkflowIdTag