Documentation Index
Fetch the complete documentation index at: https://cantonfoundation-generated-hydration-fix.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Source Files
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
Source file from the latest descriptor snapshot.
CommandCompletionService
rpc CommandCompletionService.CompletionStream(com.daml.ledger.api.v2.CompletionStreamRequest) returns (stream com.daml.ledger.api.v2.CompletionStreamResponse);
CommandService
rpc CommandService.SubmitAndWait(com.daml.ledger.api.v2.SubmitAndWaitRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitResponse);
rpc CommandService.SubmitAndWaitForReassignment(com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse);
rpc CommandService.SubmitAndWaitForTransaction(com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest) returns (com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse);
CommandSubmissionService
rpc CommandSubmissionService.Submit(com.daml.ledger.api.v2.SubmitRequest) returns (com.daml.ledger.api.v2.SubmitResponse);
rpc CommandSubmissionService.SubmitReassignment(com.daml.ledger.api.v2.SubmitReassignmentRequest) returns (com.daml.ledger.api.v2.SubmitReassignmentResponse);
ContractService
rpc ContractService.GetContract(com.daml.ledger.api.v2.GetContractRequest) returns (com.daml.ledger.api.v2.GetContractResponse);
EventQueryService
rpc EventQueryService.GetEventsByContractId(com.daml.ledger.api.v2.GetEventsByContractIdRequest) returns (com.daml.ledger.api.v2.GetEventsByContractIdResponse);
PackageService
rpc PackageService.GetPackage(com.daml.ledger.api.v2.GetPackageRequest) returns (com.daml.ledger.api.v2.GetPackageResponse);
rpc PackageService.GetPackageStatus(com.daml.ledger.api.v2.GetPackageStatusRequest) returns (com.daml.ledger.api.v2.GetPackageStatusResponse);
rpc PackageService.ListPackages(com.daml.ledger.api.v2.ListPackagesRequest) returns (com.daml.ledger.api.v2.ListPackagesResponse);
rpc PackageService.ListVettedPackages(com.daml.ledger.api.v2.ListVettedPackagesRequest) returns (com.daml.ledger.api.v2.ListVettedPackagesResponse);
StateService
rpc StateService.GetActiveContracts(com.daml.ledger.api.v2.GetActiveContractsRequest) returns (stream com.daml.ledger.api.v2.GetActiveContractsResponse);
rpc StateService.GetConnectedSynchronizers(com.daml.ledger.api.v2.GetConnectedSynchronizersRequest) returns (com.daml.ledger.api.v2.GetConnectedSynchronizersResponse);
rpc StateService.GetLatestPrunedOffsets(com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest) returns (com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse);
rpc StateService.GetLedgerEnd(com.daml.ledger.api.v2.GetLedgerEndRequest) returns (com.daml.ledger.api.v2.GetLedgerEndResponse);
UpdateService
rpc UpdateService.GetUpdateById(com.daml.ledger.api.v2.GetUpdateByIdRequest) returns (com.daml.ledger.api.v2.GetUpdateResponse);
rpc UpdateService.GetUpdateByOffset(com.daml.ledger.api.v2.GetUpdateByOffsetRequest) returns (com.daml.ledger.api.v2.GetUpdateResponse);
rpc UpdateService.GetUpdates(com.daml.ledger.api.v2.GetUpdatesRequest) returns (stream com.daml.ledger.api.v2.GetUpdatesResponse);
VersionService
rpc VersionService.GetLedgerApiVersion(com.daml.ledger.api.v2.GetLedgerApiVersionRequest) returns (com.daml.ledger.api.v2.GetLedgerApiVersionResponse);
Type Inventory
These are the package-level message and enum shapes in the publish-version snapshot.ActiveContract
com.daml.ledger.api.v2 · 3 fields
created_eventCreatedEventsynchronizer_idstringreassignment_counteruint64CreatedEvent
com.daml.ledger.api.v2 · 15 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifiercontract_keyValuecreate_argumentsRecordcreated_event_blobbytesinterface_viewsrepeated InterfaceViewwitness_partiesrepeated stringsignatoriesrepeated stringobserversrepeated stringcreated_atTimestamppackage_namestringacs_deltaboolrepresentative_package_idstringIdentifier
com.daml.ledger.api.v2 · 3 fields
package_idstringmodule_namestringentity_namestringValue
com.daml.ledger.api.v2 · 16 fields
unitEmptyboolboolint64sint64dateint32timestampsfixed64numericstringpartystringtextstringcontract_idstringoptionalOptionallistListtext_mapTextMapgen_mapGenMaprecordRecordvariantVariantenumEnumOptional
com.daml.ledger.api.v2 · 1 fields
valueValueList
com.daml.ledger.api.v2 · 1 fields
elementsrepeated ValueTextMap
com.daml.ledger.api.v2 · 1 fields
entriesrepeated EntryTextMap.Entry
com.daml.ledger.api.v2 · 2 fields
keystringvalueValueGenMap
com.daml.ledger.api.v2 · 1 fields
entriesrepeated EntryGenMap.Entry
com.daml.ledger.api.v2 · 2 fields
keyValuevalueValueRecord
com.daml.ledger.api.v2 · 2 fields
record_idIdentifierfieldsrepeated RecordFieldRecordField
com.daml.ledger.api.v2 · 2 fields
labelstringvalueValueVariant
com.daml.ledger.api.v2 · 3 fields
variant_idIdentifierconstructorstringvalueValueEnum
com.daml.ledger.api.v2 · 2 fields
enum_idIdentifierconstructorstringInterfaceView
com.daml.ledger.api.v2 · 3 fields
interface_idIdentifierview_statusStatusview_valueRecordArchived
com.daml.ledger.api.v2 · 2 fields
archived_eventArchivedEventsynchronizer_idstringArchivedEvent
com.daml.ledger.api.v2 · 7 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifierwitness_partiesrepeated stringpackage_namestringimplemented_interfacesrepeated IdentifierAssignCommand
com.daml.ledger.api.v2 · 3 fields
reassignment_idstringsourcestringtargetstringAssignedEvent
com.daml.ledger.api.v2 · 6 fields
sourcestringtargetstringreassignment_idstringsubmitterstringreassignment_counteruint64created_eventCreatedEventCommand
com.daml.ledger.api.v2 · 4 fields
createCreateCommandexerciseExerciseCommandexercise_by_keyExerciseByKeyCommandcreate_and_exerciseCreateAndExerciseCommandCreateCommand
com.daml.ledger.api.v2 · 2 fields
template_idIdentifiercreate_argumentsRecordExerciseCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercontract_idstringchoicestringchoice_argumentValueExerciseByKeyCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercontract_keyValuechoicestringchoice_argumentValueCreateAndExerciseCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercreate_argumentsRecordchoicestringchoice_argumentValueCommands
com.daml.ledger.api.v2 · 15 fields
workflow_idstringuser_idstringcommand_idstringcommandsrepeated Commanddeduplication_durationDurationdeduplication_offsetint64min_ledger_time_absTimestampmin_ledger_time_relDurationact_asrepeated stringread_asrepeated stringsubmission_idstringdisclosed_contractsrepeated DisclosedContractsynchronizer_idstringpackage_id_selection_preferencerepeated stringprefetch_contract_keysrepeated PrefetchContractKeyDisclosedContract
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercontract_idstringcreated_event_blobbytessynchronizer_idstringPrefetchContractKey
com.daml.ledger.api.v2 · 2 fields
template_idIdentifiercontract_keyValueCompletion
com.daml.ledger.api.v2 · 11 fields
command_idstringstatusStatusupdate_idstringuser_idstringact_asrepeated stringsubmission_idstringdeduplication_offsetint64deduplication_durationDurationtrace_contextTraceContextoffsetint64synchronizer_timeSynchronizerTimeTraceContext
com.daml.ledger.api.v2 · 2 fields
traceparentstringtracestatestringSynchronizerTime
com.daml.ledger.api.v2 · 2 fields
synchronizer_idstringrecord_timeTimestampCompletionStreamRequest
com.daml.ledger.api.v2 · 3 fields
user_idstringpartiesrepeated stringbegin_exclusiveint64CompletionStreamResponse
com.daml.ledger.api.v2 · 2 fields
completionCompletionoffset_checkpointOffsetCheckpointOffsetCheckpoint
com.daml.ledger.api.v2 · 2 fields
offsetint64synchronizer_timesrepeated SynchronizerTimeCreated
com.daml.ledger.api.v2 · 2 fields
created_eventCreatedEventsynchronizer_idstringCumulativeFilter
com.daml.ledger.api.v2 · 3 fields
wildcard_filterWildcardFilterinterface_filterInterfaceFiltertemplate_filterTemplateFilterWildcardFilter
com.daml.ledger.api.v2 · 1 fields
include_created_event_blobboolInterfaceFilter
com.daml.ledger.api.v2 · 3 fields
interface_idIdentifierinclude_interface_viewboolinclude_created_event_blobboolTemplateFilter
com.daml.ledger.api.v2 · 2 fields
template_idIdentifierinclude_created_event_blobboolEvent
com.daml.ledger.api.v2 · 3 fields
createdCreatedEventarchivedArchivedEventexercisedExercisedEventExercisedEvent
com.daml.ledger.api.v2 · 15 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifierinterface_idIdentifierchoicestringchoice_argumentValueacting_partiesrepeated stringconsumingboolwitness_partiesrepeated stringlast_descendant_node_idint32exercise_resultValuepackage_namestringimplemented_interfacesrepeated Identifieracs_deltaboolEventFormat
com.daml.ledger.api.v2 · 3 fields
filters_by_partyrepeated mapfilters_for_any_partyFiltersverboseboolFilters
com.daml.ledger.api.v2 · 1 fields
cumulativerepeated CumulativeFilterExperimentalCommandInspectionService
com.daml.ledger.api.v2 · 1 fields
supportedboolExperimentalFeatures
com.daml.ledger.api.v2 · 2 fields
static_timeExperimentalStaticTimecommand_inspection_serviceExperimentalCommandInspectionServiceExperimentalStaticTime
com.daml.ledger.api.v2 · 1 fields
supportedboolExperimentalPartyTopologyEvents
com.daml.ledger.api.v2 · 1 fields
supportedboolFeaturesDescriptor
com.daml.ledger.api.v2 · 5 fields
experimentalExperimentalFeaturesuser_managementUserManagementFeatureparty_managementPartyManagementFeatureoffset_checkpointOffsetCheckpointFeaturepackage_featurePackageFeatureUserManagementFeature
com.daml.ledger.api.v2 · 3 fields
supportedboolmax_rights_per_userint32max_users_page_sizeint32PartyManagementFeature
com.daml.ledger.api.v2 · 1 fields
max_parties_page_sizeint32OffsetCheckpointFeature
com.daml.ledger.api.v2 · 1 fields
max_offset_checkpoint_emission_delayDurationPackageFeature
com.daml.ledger.api.v2 · 1 fields
max_vetted_packages_page_sizeint32GetActiveContractsRequest
com.daml.ledger.api.v2 · 2 fields
active_at_offsetint64event_formatEventFormatGetActiveContractsResponse
com.daml.ledger.api.v2 · 4 fields
workflow_idstringactive_contractActiveContractincomplete_unassignedIncompleteUnassignedincomplete_assignedIncompleteAssignedIncompleteUnassigned
com.daml.ledger.api.v2 · 2 fields
created_eventCreatedEventunassigned_eventUnassignedEventUnassignedEvent
com.daml.ledger.api.v2 · 12 fields
reassignment_idstringcontract_idstringtemplate_idIdentifiersourcestringtargetstringsubmitterstringreassignment_counteruint64assignment_exclusivityTimestampwitness_partiesrepeated stringpackage_namestringoffsetint64node_idint32IncompleteAssigned
com.daml.ledger.api.v2 · 1 fields
assigned_eventAssignedEventGetConnectedSynchronizersRequest
com.daml.ledger.api.v2 · 3 fields
partystringparticipant_idstringidentity_provider_idstringGetConnectedSynchronizersResponse
com.daml.ledger.api.v2 · 1 fields
connected_synchronizersrepeated ConnectedSynchronizerGetConnectedSynchronizersResponse.ConnectedSynchronizer
com.daml.ledger.api.v2 · 3 fields
synchronizer_aliasstringsynchronizer_idstringpermissionParticipantPermissionParticipantPermission
com.daml.ledger.api.v2 · 4 values
PARTICIPANT_PERMISSION_UNSPECIFIEDPARTICIPANT_PERMISSION_SUBMISSIONPARTICIPANT_PERMISSION_CONFIRMATIONPARTICIPANT_PERMISSION_OBSERVATION
GetContractRequest
com.daml.ledger.api.v2 · 2 fields
contract_idstringquerying_partiesrepeated stringGetContractResponse
com.daml.ledger.api.v2 · 1 fields
created_eventCreatedEventGetEventsByContractIdRequest
com.daml.ledger.api.v2 · 2 fields
contract_idstringevent_formatEventFormatGetEventsByContractIdResponse
com.daml.ledger.api.v2 · 2 fields
createdCreatedarchivedArchivedGetLatestPrunedOffsetsRequest
com.daml.ledger.api.v2 · 0 fields
GetLatestPrunedOffsetsResponse
com.daml.ledger.api.v2 · 2 fields
participant_pruned_up_to_inclusiveint64all_divulged_contracts_pruned_up_to_inclusiveint64GetLedgerApiVersionRequest
com.daml.ledger.api.v2 · 0 fields
GetLedgerApiVersionResponse
com.daml.ledger.api.v2 · 2 fields
versionstringfeaturesFeaturesDescriptorGetLedgerEndRequest
com.daml.ledger.api.v2 · 0 fields
GetLedgerEndResponse
com.daml.ledger.api.v2 · 1 fields
offsetint64GetPackageRequest
com.daml.ledger.api.v2 · 1 fields
package_idstringGetPackageResponse
com.daml.ledger.api.v2 · 3 fields
hash_functionHashFunctionarchive_payloadbyteshashstringHashFunction
com.daml.ledger.api.v2 · 1 values
HASH_FUNCTION_SHA256
GetPackageStatusRequest
com.daml.ledger.api.v2 · 1 fields
package_idstringGetPackageStatusResponse
com.daml.ledger.api.v2 · 1 fields
package_statusPackageStatusPackageStatus
com.daml.ledger.api.v2 · 2 values
PACKAGE_STATUS_UNSPECIFIEDPACKAGE_STATUS_REGISTERED
GetUpdateByIdRequest
com.daml.ledger.api.v2 · 2 fields
update_idstringupdate_formatUpdateFormatUpdateFormat
com.daml.ledger.api.v2 · 3 fields
include_transactionsTransactionFormatinclude_reassignmentsEventFormatinclude_topology_eventsTopologyFormatTransactionFormat
com.daml.ledger.api.v2 · 2 fields
event_formatEventFormattransaction_shapeTransactionShapeTransactionShape
com.daml.ledger.api.v2 · 3 values
TRANSACTION_SHAPE_UNSPECIFIEDTRANSACTION_SHAPE_ACS_DELTATRANSACTION_SHAPE_LEDGER_EFFECTS
TopologyFormat
com.daml.ledger.api.v2 · 1 fields
include_participant_authorization_eventsParticipantAuthorizationTopologyFormatParticipantAuthorizationTopologyFormat
com.daml.ledger.api.v2 · 1 fields
partiesrepeated stringGetUpdateByOffsetRequest
com.daml.ledger.api.v2 · 2 fields
offsetint64update_formatUpdateFormatGetUpdateResponse
com.daml.ledger.api.v2 · 3 fields
transactionTransactionreassignmentReassignmenttopology_transactionTopologyTransactionTransaction
com.daml.ledger.api.v2 · 10 fields
update_idstringcommand_idstringworkflow_idstringeffective_atTimestampeventsrepeated Eventoffsetint64synchronizer_idstringtrace_contextTraceContextrecord_timeTimestampexternal_transaction_hashbytesReassignment
com.daml.ledger.api.v2 · 8 fields
update_idstringcommand_idstringworkflow_idstringoffsetint64eventsrepeated ReassignmentEventtrace_contextTraceContextrecord_timeTimestampsynchronizer_idstringReassignmentEvent
com.daml.ledger.api.v2 · 2 fields
unassignedUnassignedEventassignedAssignedEventTopologyTransaction
com.daml.ledger.api.v2 · 6 fields
update_idstringoffsetint64synchronizer_idstringrecord_timeTimestampeventsrepeated TopologyEventtrace_contextTraceContextTopologyEvent
com.daml.ledger.api.v2 · 3 fields
participant_authorization_changedParticipantAuthorizationChangedparticipant_authorization_revokedParticipantAuthorizationRevokedparticipant_authorization_addedParticipantAuthorizationAddedParticipantAuthorizationChanged
com.daml.ledger.api.v2 · 3 fields
party_idstringparticipant_idstringparticipant_permissionParticipantPermissionParticipantAuthorizationRevoked
com.daml.ledger.api.v2 · 2 fields
party_idstringparticipant_idstringParticipantAuthorizationAdded
com.daml.ledger.api.v2 · 3 fields
party_idstringparticipant_idstringparticipant_permissionParticipantPermissionGetUpdatesRequest
com.daml.ledger.api.v2 · 3 fields
begin_exclusiveint64end_inclusiveint64update_formatUpdateFormatGetUpdatesResponse
com.daml.ledger.api.v2 · 4 fields
transactionTransactionreassignmentReassignmentoffset_checkpointOffsetCheckpointtopology_transactionTopologyTransactionListPackagesRequest
com.daml.ledger.api.v2 · 0 fields
ListPackagesResponse
com.daml.ledger.api.v2 · 1 fields
package_idsrepeated stringListVettedPackagesRequest
com.daml.ledger.api.v2 · 4 fields
package_metadata_filterPackageMetadataFiltertopology_state_filterTopologyStateFilterpage_tokenstringpage_sizeuint32PackageMetadataFilter
com.daml.ledger.api.v2 · 2 fields
package_idsrepeated stringpackage_name_prefixesrepeated stringTopologyStateFilter
com.daml.ledger.api.v2 · 2 fields
participant_idsrepeated stringsynchronizer_idsrepeated stringListVettedPackagesResponse
com.daml.ledger.api.v2 · 2 fields
vetted_packagesrepeated VettedPackagesnext_page_tokenstringVettedPackages
com.daml.ledger.api.v2 · 4 fields
packagesrepeated VettedPackageparticipant_idstringsynchronizer_idstringtopology_serialuint32VettedPackage
com.daml.ledger.api.v2 · 5 fields
package_idstringvalid_from_inclusiveTimestampvalid_until_exclusiveTimestamppackage_namestringpackage_versionstringPackageReference
com.daml.ledger.api.v2 · 3 fields
package_idstringpackage_namestringpackage_versionstringPriorTopologySerial
com.daml.ledger.api.v2 · 2 fields
prioruint32no_priorEmptyReassignmentCommand
com.daml.ledger.api.v2 · 2 fields
unassign_commandUnassignCommandassign_commandAssignCommandUnassignCommand
com.daml.ledger.api.v2 · 3 fields
contract_idstringsourcestringtargetstringReassignmentCommands
com.daml.ledger.api.v2 · 6 fields
workflow_idstringuser_idstringcommand_idstringsubmitterstringsubmission_idstringcommandsrepeated ReassignmentCommandSignature
com.daml.ledger.api.v2 · 4 fields
formatSignatureFormatsignaturebytessigned_bystringsigning_algorithm_specSigningAlgorithmSpecSignatureFormat
com.daml.ledger.api.v2 · 5 values
SIGNATURE_FORMAT_UNSPECIFIEDSIGNATURE_FORMAT_RAWSIGNATURE_FORMAT_DERSIGNATURE_FORMAT_CONCATSIGNATURE_FORMAT_SYMBOLIC
SigningAlgorithmSpec
com.daml.ledger.api.v2 · 4 values
SIGNING_ALGORITHM_SPEC_UNSPECIFIEDSIGNING_ALGORITHM_SPEC_ED25519SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
SigningPublicKey
com.daml.ledger.api.v2 · 3 fields
formatCryptoKeyFormatkey_databyteskey_specSigningKeySpecCryptoKeyFormat
com.daml.ledger.api.v2 · 4 values
CRYPTO_KEY_FORMAT_UNSPECIFIEDCRYPTO_KEY_FORMAT_DERCRYPTO_KEY_FORMAT_RAWCRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
SigningKeySpec
com.daml.ledger.api.v2 · 5 values
SIGNING_KEY_SPEC_UNSPECIFIEDSIGNING_KEY_SPEC_EC_CURVE25519SIGNING_KEY_SPEC_EC_P256SIGNING_KEY_SPEC_EC_P384SIGNING_KEY_SPEC_EC_SECP256K1
SubmitAndWaitForReassignmentRequest
com.daml.ledger.api.v2 · 2 fields
reassignment_commandsReassignmentCommandsevent_formatEventFormatSubmitAndWaitForReassignmentResponse
com.daml.ledger.api.v2 · 1 fields
reassignmentReassignmentSubmitAndWaitForTransactionRequest
com.daml.ledger.api.v2 · 2 fields
commandsCommandstransaction_formatTransactionFormatSubmitAndWaitForTransactionResponse
com.daml.ledger.api.v2 · 1 fields
transactionTransactionSubmitAndWaitRequest
com.daml.ledger.api.v2 · 1 fields
commandsCommandsSubmitAndWaitResponse
com.daml.ledger.api.v2 · 2 fields
update_idstringcompletion_offsetint64SubmitReassignmentRequest
com.daml.ledger.api.v2 · 1 fields
reassignment_commandsReassignmentCommandsSubmitReassignmentResponse
com.daml.ledger.api.v2 · 0 fields
SubmitRequest
com.daml.ledger.api.v2 · 1 fields
commandsCommandsSubmitResponse
com.daml.ledger.api.v2 · 0 fields