Type Members

1.  final case class AddTransactionsRequest(transactions: Seq[SignedTopologyTransaction], forceChanges: Seq[ForceFlag], store: Option[StoreId], waitToBecomeEffective: Option[Duration]) extends GeneratedMessage with Updatable[AddTransactionsRequest] with Product with Serializable
   transactions

   * The transactions that should be added to the target store as indicated by the parameter store.

   forceChanges

   * Force specific changes even if dangerous

   store

   * The store that is used as the underlying source for executing this request. If store is a synchronizers store, the resulting topology transaction will only be available on the respective synchronizers. If store is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.

   waitToBecomeEffective

   * Optional timeout to wait for the transaction to become effective in the store.

   Annotations

   @SerialVersionUID()

2.  final case class AddTransactionsResponse() extends GeneratedMessage with Updatable[AddTransactionsResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

3.  final case class AuthorizeRequest(type: Type, mustFullyAuthorize: Boolean, forceChanges: Seq[ForceFlag], signedBy: Seq[String], store: Option[StoreId], waitToBecomeEffective: Option[Duration]) extends GeneratedMessage with Updatable[AuthorizeRequest] with Product with Serializable
   mustFullyAuthorize

   * If true: the transaction is only signed if the new signatures will result in the transaction being fully authorized. Otherwise returns as an error. If false: the transaction is signed and the signature distributed. The transaction may still not be fully authorized and remain as a proposal.

   forceChanges

   * Force specific changes even if dangerous

   signedBy

   * Fingerprint of the keys signing the authorization The signing key is used to identify a particular NamespaceDelegation certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.

   store

   * The store that is used as the underlying source for executing this request. If store is a synchronizer store, the resulting topology transaction will only be available on the respective synchronizer. If store is the authorized store, the resulting topology transaction may or may not be synchronized automatically to all synchronizers that the node is currently connected to or will be connected to in the future. Selecting a specific synchronizers store might be necessary, if the transaction to authorize by hash or the previous generation of the submitted proposal is only available on the synchronizers store and not in the authorized store.

   waitToBecomeEffective

   * Optional timeout to wait for the transaction to become effective in the store.

   Annotations

   @SerialVersionUID()

4.  final case class AuthorizeResponse(transaction: Option[SignedTopologyTransaction]) extends GeneratedMessage with Updatable[AuthorizeResponse] with Product with Serializable
   transaction

   * the generated signed topology transaction

   Annotations

   @SerialVersionUID()

5.  final case class BaseQuery(store: Option[StoreId], proposals: Boolean, operation: TopologyChangeOp, timeQuery: TimeQuery, filterSignedKey: String, protocolVersion: Option[Int]) extends GeneratedMessage with Updatable[BaseQuery] with Product with Serializable
   proposals

   whether to query only for proposals instead of approved topology mappings

   Annotations

   @SerialVersionUID()

6.  final case class BaseResult(store: Option[StoreId], sequenced: Option[Timestamp], validFrom: Option[Timestamp], validUntil: Option[Timestamp], operation: TopologyChangeOp, transactionHash: ByteString, serial: Int, signedByFingerprints: Seq[String]) extends GeneratedMessage with Updatable[BaseResult] with Product with Serializable

   Annotations

   @SerialVersionUID()

7.  final case class CreateTemporaryTopologyStoreRequest(name: String, protocolVersion: Int) extends GeneratedMessage with Updatable[CreateTemporaryTopologyStoreRequest] with Product with Serializable
   name

   * The name of the topology store

   protocolVersion

   * The protocol version that should be used by the store

   Annotations

   @SerialVersionUID()

8.  final case class CreateTemporaryTopologyStoreResponse(storeId: Option[Temporary]) extends GeneratedMessage with Updatable[CreateTemporaryTopologyStoreResponse] with Product with Serializable
   storeId

   * The identifier of the topology store that should be used as a store filter string

   Annotations

   @SerialVersionUID()

9.  final case class CurrentTimeRequest() extends GeneratedMessage with Updatable[CurrentTimeRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

10.  final case class CurrentTimeResponse(currentTime: Long) extends GeneratedMessage with Updatable[CurrentTimeResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

11.  final case class DropTemporaryTopologyStoreRequest(storeId: Option[Temporary]) extends GeneratedMessage with Updatable[DropTemporaryTopologyStoreRequest] with Product with Serializable
    storeId

    * The identifier of the topology store that should be dropped

    Annotations

    @SerialVersionUID()

12.  final case class DropTemporaryTopologyStoreResponse() extends GeneratedMessage with Updatable[DropTemporaryTopologyStoreResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

13.  final case class ExportTopologySnapshotRequest(baseQuery: Option[BaseQuery], excludeMappings: Seq[String], filterNamespace: String) extends GeneratedMessage with Updatable[ExportTopologySnapshotRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

14.  final case class ExportTopologySnapshotResponse(chunk: ByteString) extends GeneratedMessage with Updatable[ExportTopologySnapshotResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

15.  sealed abstract class ForceFlag extends GeneratedEnum
16.  final case class GenerateTransactionsRequest(proposals: Seq[Proposal]) extends GeneratedMessage with Updatable[GenerateTransactionsRequest] with Product with Serializable
    proposals

    transaction proposals for which to generate topology transactions

    Annotations

    @SerialVersionUID()

17.  final case class GenerateTransactionsResponse(generatedTransactions: Seq[GeneratedTransaction]) extends GeneratedMessage with Updatable[GenerateTransactionsResponse] with Product with Serializable
    generatedTransactions

    Generated transactions, in the same order as the mappings provided in the request

    Annotations

    @SerialVersionUID()

18.  final case class GenesisStateRequest(synchronizerStore: Option[StoreId], timestamp: Option[Timestamp]) extends GeneratedMessage with Updatable[GenesisStateRequest] with Product with Serializable
    synchronizerStore

    Must be specified if the genesis state is requested from a participant node.

    timestamp

    Optional - the effective time used to fetch the topology transactions. If not provided the effective time of the last topology transaction is used.

    Annotations

    @SerialVersionUID()

19.  final case class GenesisStateResponse(chunk: ByteString) extends GeneratedMessage with Updatable[GenesisStateResponse] with Product with Serializable
    chunk

    versioned stored topology transactions

    Annotations

    @SerialVersionUID()

20.  final case class GetIdRequest() extends GeneratedMessage with Updatable[GetIdRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

21.  final case class GetIdResponse(initialized: Boolean, uniqueIdentifier: String) extends GeneratedMessage with Updatable[GetIdResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

22.  final case class GetOnboardingTransactionsRequest() extends GeneratedMessage with Updatable[GetOnboardingTransactionsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

23.  final case class GetOnboardingTransactionsResponse(transactions: Option[TopologyTransactions]) extends GeneratedMessage with Updatable[GetOnboardingTransactionsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

24.  final case class ImportTopologySnapshotRequest(topologySnapshot: ByteString, store: Option[StoreId], waitToBecomeEffective: Option[Duration]) extends GeneratedMessage with Updatable[ImportTopologySnapshotRequest] with Product with Serializable

    * Same message as AddTransactionsRequest, except that transactions are encoded in a byte string

    * Same message as AddTransactionsRequest, except that transactions are encoded in a byte string

    waitToBecomeEffective

    * Optional timeout to wait for the transaction to become effective in the store.

    Annotations

    @SerialVersionUID()

25.  final case class ImportTopologySnapshotResponse() extends GeneratedMessage with Updatable[ImportTopologySnapshotResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

26.  final case class InitIdRequest(identifier: String, namespace: String, namespaceDelegations: Seq[SignedTopologyTransaction]) extends GeneratedMessage with Updatable[InitIdRequest] with Product with Serializable
    identifier

    The identifier of this node

    namespace

    The namespace of this node If empty, then we use the namespace of the first certificate. If both are set, then we assert that the namespace matches the namespace of the first certificate.

    namespaceDelegations

    Optional set of namespace_delegations for this node (in case we are using external root keys)

    Annotations

    @SerialVersionUID()

27.  final case class InitIdResponse() extends GeneratedMessage with Updatable[InitIdResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

28.  final case class ListAllRequest(baseQuery: Option[BaseQuery], excludeMappings: Seq[String], filterNamespace: String) extends GeneratedMessage with Updatable[ListAllRequest] with Product with Serializable
    excludeMappings

    * The list of topology mappings to exclude from the result.

    Annotations

    @SerialVersionUID()

29.  final case class ListAllResponse(result: Option[TopologyTransactions]) extends GeneratedMessage with Updatable[ListAllResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

30.  final case class ListAvailableStoresRequest() extends GeneratedMessage with Updatable[ListAvailableStoresRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

31.  final case class ListAvailableStoresResponse(storeIds: Seq[StoreId]) extends GeneratedMessage with Updatable[ListAvailableStoresResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

32.  final case class ListDecentralizedNamespaceDefinitionRequest(baseQuery: Option[BaseQuery], filterNamespace: String) extends GeneratedMessage with Updatable[ListDecentralizedNamespaceDefinitionRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

33.  final case class ListDecentralizedNamespaceDefinitionResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListDecentralizedNamespaceDefinitionResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

34.  final case class ListKeyOwnersRequest(asOf: Option[Timestamp], limit: Int, synchronizerIds: Seq[String], filterKeyOwnerType: String, filterKeyOwnerUid: String) extends GeneratedMessage with Updatable[ListKeyOwnersRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

35.  final case class ListKeyOwnersResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListKeyOwnersResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

36.  final case class ListMediatorSynchronizerStateRequest(baseQuery: Option[BaseQuery], filterSynchronizerId: String) extends GeneratedMessage with Updatable[ListMediatorSynchronizerStateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

37.  final case class ListMediatorSynchronizerStateResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListMediatorSynchronizerStateResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

38.  final case class ListNamespaceDelegationRequest(baseQuery: Option[BaseQuery], filterNamespace: String, filterTargetKeyFingerprint: String) extends GeneratedMessage with Updatable[ListNamespaceDelegationRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

39.  final case class ListNamespaceDelegationResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListNamespaceDelegationResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

40.  final case class ListOwnerToKeyMappingRequest(baseQuery: Option[BaseQuery], filterKeyOwnerType: String, filterKeyOwnerUid: String) extends GeneratedMessage with Updatable[ListOwnerToKeyMappingRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

41.  final case class ListOwnerToKeyMappingResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListOwnerToKeyMappingResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

42.  final case class ListParticipantSynchronizerPermissionRequest(baseQuery: Option[BaseQuery], filterUid: String) extends GeneratedMessage with Updatable[ListParticipantSynchronizerPermissionRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

43.  final case class ListParticipantSynchronizerPermissionResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListParticipantSynchronizerPermissionResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

44.  final case class ListPartiesRequest(asOf: Option[Timestamp], limit: Int, synchronizerIds: Seq[String], filterParty: String, filterParticipant: String) extends GeneratedMessage with Updatable[ListPartiesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

45.  final case class ListPartiesResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartiesResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

46.  final case class ListPartyHostingLimitsRequest(baseQuery: Option[BaseQuery], filterUid: String) extends GeneratedMessage with Updatable[ListPartyHostingLimitsRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

47.  final case class ListPartyHostingLimitsResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartyHostingLimitsResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

48.  final case class ListPartyToKeyMappingRequest(baseQuery: Option[BaseQuery], filterParty: String) extends GeneratedMessage with Updatable[ListPartyToKeyMappingRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

49.  final case class ListPartyToKeyMappingResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartyToKeyMappingResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

50.  final case class ListPartyToParticipantRequest(baseQuery: Option[BaseQuery], filterParty: String, filterParticipant: String) extends GeneratedMessage with Updatable[ListPartyToParticipantRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

51.  final case class ListPartyToParticipantResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPartyToParticipantResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

52.  final case class ListPurgeTopologyTransactionRequest(baseQuery: Option[BaseQuery], filterSynchronizerId: String) extends GeneratedMessage with Updatable[ListPurgeTopologyTransactionRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

53.  final case class ListPurgeTopologyTransactionResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListPurgeTopologyTransactionResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

54.  final case class ListSequencerSynchronizerStateRequest(baseQuery: Option[BaseQuery], filterSynchronizerId: String) extends GeneratedMessage with Updatable[ListSequencerSynchronizerStateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

55.  final case class ListSequencerSynchronizerStateResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListSequencerSynchronizerStateResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

56.  final case class ListSynchronizerParametersStateRequest(baseQuery: Option[BaseQuery], filterSynchronizerId: String) extends GeneratedMessage with Updatable[ListSynchronizerParametersStateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

57.  final case class ListSynchronizerParametersStateResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListSynchronizerParametersStateResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

58.  final case class ListSynchronizerTrustCertificateRequest(baseQuery: Option[BaseQuery], filterUid: String) extends GeneratedMessage with Updatable[ListSynchronizerTrustCertificateRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

59.  final case class ListSynchronizerTrustCertificateResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListSynchronizerTrustCertificateResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

60.  final case class ListVettedPackagesRequest(baseQuery: Option[BaseQuery], filterParticipant: String) extends GeneratedMessage with Updatable[ListVettedPackagesRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

61.  final case class ListVettedPackagesResponse(results: Seq[Result]) extends GeneratedMessage with Updatable[ListVettedPackagesResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

62.  final case class SignTransactionsRequest(transactions: Seq[SignedTopologyTransaction], signedBy: Seq[String], store: Option[StoreId], forceFlags: Seq[ForceFlag]) extends GeneratedMessage with Updatable[SignTransactionsRequest] with Product with Serializable
    transactions

    * The transactions to be signed, but will not be stored in the authorized store

    signedBy

    * Fingerprint of the keys signing the authorization The signing key is used to identify a particular NamespaceDelegation certificate, which is used to justify the given authorization. Optional, if empty, suitable signing keys available known to the node are automatically selected.

    store

    Target store

    forceFlags

    * Force specific changes even if dangerous

    Annotations

    @SerialVersionUID()

63.  final case class SignTransactionsResponse(transactions: Seq[SignedTopologyTransaction]) extends GeneratedMessage with Updatable[SignTransactionsResponse] with Product with Serializable
    transactions

    * The transactions with the additional signatures from this node.

    Annotations

    @SerialVersionUID()

64.  final case class StoreId(store: Store) extends GeneratedMessage with Updatable[StoreId] with Product with Serializable

    Annotations

    @SerialVersionUID()

65.  final case class TopologyTransactions(items: Seq[Item]) extends GeneratedMessage with Updatable[TopologyTransactions] with Product with Serializable

    * Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API

    * Topology transaction collection used during bootstrapping of synchronizer nodes and on the admin API

    Please note that this message should not be in the protocol package, as it is not used on the protocol itself but on the admin apis. But as we can't rename the package name due to backwards compatibility guarantees, we've moved the file out of the protocol.proto file, but kept the package name.

    Annotations

    @SerialVersionUID()