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
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published descriptor snapshot.
Current source file in the latest published 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.com.daml.ledger.api.v2.ActiveContract
3 fields
created_eventCreatedEventsynchronizer_idstringreassignment_counteruint64com.daml.ledger.api.v2.CreatedEvent
15 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifiercontract_keyValuecreate_argumentsRecordcreated_event_blobbytesinterface_viewsrepeated InterfaceViewwitness_partiesrepeated stringsignatoriesrepeated stringobserversrepeated stringcreated_atTimestamppackage_namestringacs_deltaboolrepresentative_package_idstringcom.daml.ledger.api.v2.Identifier
3 fields
package_idstringmodule_namestringentity_namestringcom.daml.ledger.api.v2.Value
16 fields
unitEmptyboolboolint64sint64dateint32timestampsfixed64numericstringpartystringtextstringcontract_idstringoptionalOptionallistListtext_mapTextMapgen_mapGenMaprecordRecordvariantVariantenumEnumcom.daml.ledger.api.v2.Optional
1 fields
valueValuecom.daml.ledger.api.v2.List
1 fields
elementsrepeated Valuecom.daml.ledger.api.v2.TextMap
1 fields
entriesrepeated Entrycom.daml.ledger.api.v2.TextMap.Entry
2 fields
keystringvalueValuecom.daml.ledger.api.v2.GenMap
1 fields
entriesrepeated Entrycom.daml.ledger.api.v2.GenMap.Entry
2 fields
keyValuevalueValuecom.daml.ledger.api.v2.Record
2 fields
record_idIdentifierfieldsrepeated RecordFieldcom.daml.ledger.api.v2.RecordField
2 fields
labelstringvalueValuecom.daml.ledger.api.v2.Variant
3 fields
variant_idIdentifierconstructorstringvalueValuecom.daml.ledger.api.v2.Enum
2 fields
enum_idIdentifierconstructorstringcom.daml.ledger.api.v2.InterfaceView
3 fields
interface_idIdentifierview_statusStatusview_valueRecordcom.daml.ledger.api.v2.Archived
2 fields
archived_eventArchivedEventsynchronizer_idstringcom.daml.ledger.api.v2.ArchivedEvent
7 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifierwitness_partiesrepeated stringpackage_namestringimplemented_interfacesrepeated Identifiercom.daml.ledger.api.v2.AssignCommand
3 fields
reassignment_idstringsourcestringtargetstringcom.daml.ledger.api.v2.AssignedEvent
6 fields
sourcestringtargetstringreassignment_idstringsubmitterstringreassignment_counteruint64created_eventCreatedEventcom.daml.ledger.api.v2.Command
4 fields
createCreateCommandexerciseExerciseCommandexercise_by_keyExerciseByKeyCommandcreate_and_exerciseCreateAndExerciseCommandcom.daml.ledger.api.v2.CreateCommand
2 fields
template_idIdentifiercreate_argumentsRecordcom.daml.ledger.api.v2.ExerciseCommand
4 fields
template_idIdentifiercontract_idstringchoicestringchoice_argumentValuecom.daml.ledger.api.v2.ExerciseByKeyCommand
4 fields
template_idIdentifiercontract_keyValuechoicestringchoice_argumentValuecom.daml.ledger.api.v2.CreateAndExerciseCommand
4 fields
template_idIdentifiercreate_argumentsRecordchoicestringchoice_argumentValuecom.daml.ledger.api.v2.Commands
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 PrefetchContractKeycom.daml.ledger.api.v2.DisclosedContract
4 fields
template_idIdentifiercontract_idstringcreated_event_blobbytessynchronizer_idstringcom.daml.ledger.api.v2.PrefetchContractKey
2 fields
template_idIdentifiercontract_keyValuecom.daml.ledger.api.v2.Completion
11 fields
command_idstringstatusStatusupdate_idstringuser_idstringact_asrepeated stringsubmission_idstringdeduplication_offsetint64deduplication_durationDurationtrace_contextTraceContextoffsetint64synchronizer_timeSynchronizerTimecom.daml.ledger.api.v2.TraceContext
2 fields
traceparentstringtracestatestringcom.daml.ledger.api.v2.SynchronizerTime
2 fields
synchronizer_idstringrecord_timeTimestampcom.daml.ledger.api.v2.CompletionStreamRequest
3 fields
user_idstringpartiesrepeated stringbegin_exclusiveint64com.daml.ledger.api.v2.CompletionStreamResponse
2 fields
completionCompletionoffset_checkpointOffsetCheckpointcom.daml.ledger.api.v2.OffsetCheckpoint
2 fields
offsetint64synchronizer_timesrepeated SynchronizerTimecom.daml.ledger.api.v2.Created
2 fields
created_eventCreatedEventsynchronizer_idstringcom.daml.ledger.api.v2.CumulativeFilter
3 fields
wildcard_filterWildcardFilterinterface_filterInterfaceFiltertemplate_filterTemplateFiltercom.daml.ledger.api.v2.WildcardFilter
1 fields
include_created_event_blobboolcom.daml.ledger.api.v2.InterfaceFilter
3 fields
interface_idIdentifierinclude_interface_viewboolinclude_created_event_blobboolcom.daml.ledger.api.v2.TemplateFilter
2 fields
template_idIdentifierinclude_created_event_blobboolcom.daml.ledger.api.v2.Event
3 fields
createdCreatedEventarchivedArchivedEventexercisedExercisedEventcom.daml.ledger.api.v2.ExercisedEvent
15 fields
offsetint64node_idint32contract_idstringtemplate_idIdentifierinterface_idIdentifierchoicestringchoice_argumentValueacting_partiesrepeated stringconsumingboolwitness_partiesrepeated stringlast_descendant_node_idint32exercise_resultValuepackage_namestringimplemented_interfacesrepeated Identifieracs_deltaboolcom.daml.ledger.api.v2.EventFormat
3 fields
filters_by_partyrepeated mapfilters_for_any_partyFiltersverboseboolcom.daml.ledger.api.v2.Filters
1 fields
cumulativerepeated CumulativeFiltercom.daml.ledger.api.v2.ExperimentalCommandInspectionService
1 fields
supportedboolcom.daml.ledger.api.v2.ExperimentalFeatures
2 fields
static_timeExperimentalStaticTimecommand_inspection_serviceExperimentalCommandInspectionServicecom.daml.ledger.api.v2.ExperimentalStaticTime
1 fields
supportedboolcom.daml.ledger.api.v2.ExperimentalPartyTopologyEvents
1 fields
supportedboolcom.daml.ledger.api.v2.FeaturesDescriptor
5 fields
experimentalExperimentalFeaturesuser_managementUserManagementFeatureparty_managementPartyManagementFeatureoffset_checkpointOffsetCheckpointFeaturepackage_featurePackageFeaturecom.daml.ledger.api.v2.UserManagementFeature
3 fields
supportedboolmax_rights_per_userint32max_users_page_sizeint32com.daml.ledger.api.v2.PartyManagementFeature
1 fields
max_parties_page_sizeint32com.daml.ledger.api.v2.OffsetCheckpointFeature
1 fields
max_offset_checkpoint_emission_delayDurationcom.daml.ledger.api.v2.PackageFeature
1 fields
max_vetted_packages_page_sizeint32com.daml.ledger.api.v2.GetActiveContractsRequest
2 fields
active_at_offsetint64event_formatEventFormatcom.daml.ledger.api.v2.GetActiveContractsResponse
4 fields
workflow_idstringactive_contractActiveContractincomplete_unassignedIncompleteUnassignedincomplete_assignedIncompleteAssignedcom.daml.ledger.api.v2.IncompleteUnassigned
2 fields
created_eventCreatedEventunassigned_eventUnassignedEventcom.daml.ledger.api.v2.UnassignedEvent
12 fields
reassignment_idstringcontract_idstringtemplate_idIdentifiersourcestringtargetstringsubmitterstringreassignment_counteruint64assignment_exclusivityTimestampwitness_partiesrepeated stringpackage_namestringoffsetint64node_idint32com.daml.ledger.api.v2.IncompleteAssigned
1 fields
assigned_eventAssignedEventcom.daml.ledger.api.v2.GetConnectedSynchronizersRequest
3 fields
partystringparticipant_idstringidentity_provider_idstringcom.daml.ledger.api.v2.GetConnectedSynchronizersResponse
1 fields
connected_synchronizersrepeated ConnectedSynchronizercom.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer
3 fields
synchronizer_aliasstringsynchronizer_idstringpermissionParticipantPermissioncom.daml.ledger.api.v2.ParticipantPermission
4 values
PARTICIPANT_PERMISSION_UNSPECIFIEDPARTICIPANT_PERMISSION_SUBMISSIONPARTICIPANT_PERMISSION_CONFIRMATIONPARTICIPANT_PERMISSION_OBSERVATION
com.daml.ledger.api.v2.GetContractRequest
2 fields
contract_idstringquerying_partiesrepeated stringcom.daml.ledger.api.v2.GetContractResponse
1 fields
created_eventCreatedEventcom.daml.ledger.api.v2.GetEventsByContractIdRequest
2 fields
contract_idstringevent_formatEventFormatcom.daml.ledger.api.v2.GetEventsByContractIdResponse
2 fields
createdCreatedarchivedArchivedcom.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest
0 fields
com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse
2 fields
participant_pruned_up_to_inclusiveint64all_divulged_contracts_pruned_up_to_inclusiveint64com.daml.ledger.api.v2.GetLedgerApiVersionRequest
0 fields
com.daml.ledger.api.v2.GetLedgerApiVersionResponse
2 fields
versionstringfeaturesFeaturesDescriptorcom.daml.ledger.api.v2.GetLedgerEndRequest
0 fields
com.daml.ledger.api.v2.GetLedgerEndResponse
1 fields
offsetint64com.daml.ledger.api.v2.GetPackageRequest
1 fields
package_idstringcom.daml.ledger.api.v2.GetPackageResponse
3 fields
hash_functionHashFunctionarchive_payloadbyteshashstringcom.daml.ledger.api.v2.HashFunction
1 values
HASH_FUNCTION_SHA256
com.daml.ledger.api.v2.GetPackageStatusRequest
1 fields
package_idstringcom.daml.ledger.api.v2.GetPackageStatusResponse
1 fields
package_statusPackageStatuscom.daml.ledger.api.v2.PackageStatus
2 values
PACKAGE_STATUS_UNSPECIFIEDPACKAGE_STATUS_REGISTERED
com.daml.ledger.api.v2.GetUpdateByIdRequest
2 fields
update_idstringupdate_formatUpdateFormatcom.daml.ledger.api.v2.UpdateFormat
3 fields
include_transactionsTransactionFormatinclude_reassignmentsEventFormatinclude_topology_eventsTopologyFormatcom.daml.ledger.api.v2.TransactionFormat
2 fields
event_formatEventFormattransaction_shapeTransactionShapecom.daml.ledger.api.v2.TransactionShape
3 values
TRANSACTION_SHAPE_UNSPECIFIEDTRANSACTION_SHAPE_ACS_DELTATRANSACTION_SHAPE_LEDGER_EFFECTS
com.daml.ledger.api.v2.TopologyFormat
1 fields
include_participant_authorization_eventsParticipantAuthorizationTopologyFormatcom.daml.ledger.api.v2.ParticipantAuthorizationTopologyFormat
1 fields
partiesrepeated stringcom.daml.ledger.api.v2.GetUpdateByOffsetRequest
2 fields
offsetint64update_formatUpdateFormatcom.daml.ledger.api.v2.GetUpdateResponse
3 fields
transactionTransactionreassignmentReassignmenttopology_transactionTopologyTransactioncom.daml.ledger.api.v2.Transaction
10 fields
update_idstringcommand_idstringworkflow_idstringeffective_atTimestampeventsrepeated Eventoffsetint64synchronizer_idstringtrace_contextTraceContextrecord_timeTimestampexternal_transaction_hashbytescom.daml.ledger.api.v2.Reassignment
8 fields
update_idstringcommand_idstringworkflow_idstringoffsetint64eventsrepeated ReassignmentEventtrace_contextTraceContextrecord_timeTimestampsynchronizer_idstringcom.daml.ledger.api.v2.ReassignmentEvent
2 fields
unassignedUnassignedEventassignedAssignedEventcom.daml.ledger.api.v2.TopologyTransaction
6 fields
update_idstringoffsetint64synchronizer_idstringrecord_timeTimestampeventsrepeated TopologyEventtrace_contextTraceContextcom.daml.ledger.api.v2.TopologyEvent
3 fields
participant_authorization_changedParticipantAuthorizationChangedparticipant_authorization_revokedParticipantAuthorizationRevokedparticipant_authorization_addedParticipantAuthorizationAddedcom.daml.ledger.api.v2.ParticipantAuthorizationChanged
3 fields
party_idstringparticipant_idstringparticipant_permissionParticipantPermissioncom.daml.ledger.api.v2.ParticipantAuthorizationRevoked
2 fields
party_idstringparticipant_idstringcom.daml.ledger.api.v2.ParticipantAuthorizationAdded
3 fields
party_idstringparticipant_idstringparticipant_permissionParticipantPermissioncom.daml.ledger.api.v2.GetUpdatesRequest
3 fields
begin_exclusiveint64end_inclusiveint64update_formatUpdateFormatcom.daml.ledger.api.v2.GetUpdatesResponse
4 fields
transactionTransactionreassignmentReassignmentoffset_checkpointOffsetCheckpointtopology_transactionTopologyTransactioncom.daml.ledger.api.v2.ListPackagesRequest
0 fields
com.daml.ledger.api.v2.ListPackagesResponse
1 fields
package_idsrepeated stringcom.daml.ledger.api.v2.ListVettedPackagesRequest
4 fields
package_metadata_filterPackageMetadataFiltertopology_state_filterTopologyStateFilterpage_tokenstringpage_sizeuint32com.daml.ledger.api.v2.PackageMetadataFilter
2 fields
package_idsrepeated stringpackage_name_prefixesrepeated stringcom.daml.ledger.api.v2.TopologyStateFilter
2 fields
participant_idsrepeated stringsynchronizer_idsrepeated stringcom.daml.ledger.api.v2.ListVettedPackagesResponse
2 fields
vetted_packagesrepeated VettedPackagesnext_page_tokenstringcom.daml.ledger.api.v2.VettedPackages
4 fields
packagesrepeated VettedPackageparticipant_idstringsynchronizer_idstringtopology_serialuint32com.daml.ledger.api.v2.VettedPackage
5 fields
package_idstringvalid_from_inclusiveTimestampvalid_until_exclusiveTimestamppackage_namestringpackage_versionstringcom.daml.ledger.api.v2.PackageReference
3 fields
package_idstringpackage_namestringpackage_versionstringcom.daml.ledger.api.v2.PriorTopologySerial
2 fields
prioruint32no_priorEmptycom.daml.ledger.api.v2.ReassignmentCommand
2 fields
unassign_commandUnassignCommandassign_commandAssignCommandcom.daml.ledger.api.v2.UnassignCommand
3 fields
contract_idstringsourcestringtargetstringcom.daml.ledger.api.v2.ReassignmentCommands
6 fields
workflow_idstringuser_idstringcommand_idstringsubmitterstringsubmission_idstringcommandsrepeated ReassignmentCommandcom.daml.ledger.api.v2.Signature
4 fields
formatSignatureFormatsignaturebytessigned_bystringsigning_algorithm_specSigningAlgorithmSpeccom.daml.ledger.api.v2.SignatureFormat
5 values
SIGNATURE_FORMAT_UNSPECIFIEDSIGNATURE_FORMAT_RAWSIGNATURE_FORMAT_DERSIGNATURE_FORMAT_CONCATSIGNATURE_FORMAT_SYMBOLIC
com.daml.ledger.api.v2.SigningAlgorithmSpec
4 values
SIGNING_ALGORITHM_SPEC_UNSPECIFIEDSIGNING_ALGORITHM_SPEC_ED25519SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
com.daml.ledger.api.v2.SigningPublicKey
3 fields
formatCryptoKeyFormatkey_databyteskey_specSigningKeySpeccom.daml.ledger.api.v2.CryptoKeyFormat
4 values
CRYPTO_KEY_FORMAT_UNSPECIFIEDCRYPTO_KEY_FORMAT_DERCRYPTO_KEY_FORMAT_RAWCRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
com.daml.ledger.api.v2.SigningKeySpec
5 values
SIGNING_KEY_SPEC_UNSPECIFIEDSIGNING_KEY_SPEC_EC_CURVE25519SIGNING_KEY_SPEC_EC_P256SIGNING_KEY_SPEC_EC_P384SIGNING_KEY_SPEC_EC_SECP256K1
com.daml.ledger.api.v2.SubmitAndWaitForReassignmentRequest
2 fields
reassignment_commandsReassignmentCommandsevent_formatEventFormatcom.daml.ledger.api.v2.SubmitAndWaitForReassignmentResponse
1 fields
reassignmentReassignmentcom.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest
2 fields
commandsCommandstransaction_formatTransactionFormatcom.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse
1 fields
transactionTransactioncom.daml.ledger.api.v2.SubmitAndWaitRequest
1 fields
commandsCommandscom.daml.ledger.api.v2.SubmitAndWaitResponse
2 fields
update_idstringcompletion_offsetint64com.daml.ledger.api.v2.SubmitReassignmentRequest
1 fields
reassignment_commandsReassignmentCommandscom.daml.ledger.api.v2.SubmitReassignmentResponse
0 fields
com.daml.ledger.api.v2.SubmitRequest
1 fields
commandsCommandscom.daml.ledger.api.v2.SubmitResponse
0 fields