Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Back to overview

Protobuf Package

​
com.daml.ledger.api.v2.interactive

1 services, 6 endpoints, 28 messages, 1 enums

gRPC

​
Source Files

​
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_common_data.proto

Current source file in the latest published descriptor snapshot.

​
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive_submission_service.proto

Current source file in the latest published descriptor snapshot.

​
InteractiveSubmissionService

​
InteractiveSubmissionService.ExecuteSubmission

gRPCSince 3.4.0

rpc InteractiveSubmissionService.ExecuteSubmission(com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest) returns (com.daml.ledger.api.v2.interactive.ExecuteSubmissionResp…

​
InteractiveSubmissionService.ExecuteSubmissionAndWait

gRPCSince 3.4.0

rpc InteractiveSubmissionService.ExecuteSubmissionAndWait(com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest) returns (com.daml.ledger.api.v2.interactive.Execute…

​
InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction

gRPCSince 3.4.0

rpc InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction(com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest) returns (com.daml.ledge…

​
InteractiveSubmissionService.GetPreferredPackageVersion

gRPCSince 3.4.0

rpc InteractiveSubmissionService.GetPreferredPackageVersion(com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest) returns (com.daml.ledger.api.v2.interactive.Get…

​
InteractiveSubmissionService.GetPreferredPackages

gRPCSince 3.4.0

rpc InteractiveSubmissionService.GetPreferredPackages(com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest) returns (com.daml.ledger.api.v2.interactive.GetPreferredPac…

​
InteractiveSubmissionService.PrepareSubmission

gRPCSince 3.4.0

rpc InteractiveSubmissionService.PrepareSubmission(com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest) returns (com.daml.ledger.api.v2.interactive.PrepareSubmissionResp…

​
Type Inventory

These are the package-level message and enum shapes in the publish-version snapshot.

​
com.daml.ledger.api.v2.interactive.CostEstimation

4 fields

estimation_timestampTimestamp
confirmation_request_traffic_cost_estimationuint64
confirmation_response_traffic_cost_estimationuint64
total_traffic_cost_estimationuint64

​
com.daml.ledger.api.v2.interactive.CostEstimationHints

2 fields

disabledbool
expected_signaturesrepeated SigningAlgorithmSpec

​
com.daml.ledger.api.v2.SigningAlgorithmSpec

4 values

  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
  • SIGNING_ALGORITHM_SPEC_ED25519
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384

​
com.daml.ledger.api.v2.interactive.DamlTransaction

4 fields

versionstring
rootsrepeated string
nodesrepeated Node
node_seedsrepeated NodeSeed

​
com.daml.ledger.api.v2.interactive.DamlTransaction.NodeSeed

2 fields

node_idint32
seedbytes

​
com.daml.ledger.api.v2.interactive.DamlTransaction.Node

2 fields

node_idstring
v1Node

​
com.daml.ledger.api.v2.interactive.transaction.v1.Node

4 fields

createCreate
fetchFetch
exerciseExercise
rollbackRollback

​
com.daml.ledger.api.v2.interactive.transaction.v1.Create

7 fields

lf_versionstring
contract_idstring
package_namestring
template_idIdentifier
argumentValue
signatoriesrepeated string
stakeholdersrepeated string

​
com.daml.ledger.api.v2.Identifier

3 fields

package_idstring
module_namestring
entity_namestring

​
com.daml.ledger.api.v2.Value

16 fields

unitEmpty
boolbool
int64sint64
dateint32
timestampsfixed64
numericstring
partystring
textstring
contract_idstring
optionalOptional
listList
text_mapTextMap
gen_mapGenMap
recordRecord
variantVariant
enumEnum

​
com.daml.ledger.api.v2.Optional

1 fields

valueValue

​
com.daml.ledger.api.v2.List

1 fields

elementsrepeated Value

​
com.daml.ledger.api.v2.TextMap

1 fields

entriesrepeated Entry

​
com.daml.ledger.api.v2.TextMap.Entry

2 fields

keystring
valueValue

​
com.daml.ledger.api.v2.GenMap

1 fields

entriesrepeated Entry

​
com.daml.ledger.api.v2.GenMap.Entry

2 fields

keyValue
valueValue

​
com.daml.ledger.api.v2.Record

2 fields

record_idIdentifier
fieldsrepeated RecordField

​
com.daml.ledger.api.v2.RecordField

2 fields

labelstring
valueValue

​
com.daml.ledger.api.v2.Variant

3 fields

variant_idIdentifier
constructorstring
valueValue

​
com.daml.ledger.api.v2.Enum

2 fields

enum_idIdentifier
constructorstring

​
com.daml.ledger.api.v2.interactive.transaction.v1.Fetch

8 fields

lf_versionstring
contract_idstring
package_namestring
template_idIdentifier
signatoriesrepeated string
stakeholdersrepeated string
acting_partiesrepeated string
interface_idIdentifier

​
com.daml.ledger.api.v2.interactive.transaction.v1.Exercise

14 fields

lf_versionstring
contract_idstring
package_namestring
template_idIdentifier
signatoriesrepeated string
stakeholdersrepeated string
acting_partiesrepeated string
interface_idIdentifier
choice_idstring
chosen_valueValue
consumingbool
childrenrepeated string
exercise_resultValue
choice_observersrepeated string

​
com.daml.ledger.api.v2.interactive.transaction.v1.Rollback

1 fields

childrenrepeated string

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest

9 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime
transaction_formatTransactionFormat

​
com.daml.ledger.api.v2.interactive.PreparedTransaction

2 fields

transactionDamlTransaction
metadataMetadata

​
com.daml.ledger.api.v2.interactive.Metadata

10 fields

submitter_infoSubmitterInfo
synchronizer_idstring
mediator_groupuint32
transaction_uuidstring
preparation_timeuint64
input_contractsrepeated InputContract
min_ledger_effective_timeuint64
max_ledger_effective_timeuint64
global_key_mappingrepeated GlobalKeyMappingEntry
max_record_timeuint64

​
com.daml.ledger.api.v2.interactive.Metadata.SubmitterInfo

2 fields

act_asrepeated string
command_idstring

​
com.daml.ledger.api.v2.interactive.Metadata.GlobalKeyMappingEntry

2 fields

keyGlobalKey
valueValue

​
com.daml.ledger.api.v2.interactive.GlobalKey

4 fields

template_idIdentifier
package_namestring
keyValue
hashbytes

​
com.daml.ledger.api.v2.interactive.Metadata.InputContract

3 fields

v1Create
created_atuint64
event_blobbytes

​
com.daml.ledger.api.v2.interactive.PartySignatures

1 fields

signaturesrepeated SinglePartySignatures

​
com.daml.ledger.api.v2.interactive.SinglePartySignatures

2 fields

partystring
signaturesrepeated Signature

​
com.daml.ledger.api.v2.Signature

4 fields

formatSignatureFormat
signaturebytes
signed_bystring
signing_algorithm_specSigningAlgorithmSpec

​
com.daml.ledger.api.v2.SignatureFormat

5 values

  • SIGNATURE_FORMAT_UNSPECIFIED
  • SIGNATURE_FORMAT_RAW
  • SIGNATURE_FORMAT_DER
  • SIGNATURE_FORMAT_CONCAT
  • SIGNATURE_FORMAT_SYMBOLIC

​
com.daml.ledger.api.v2.interactive.HashingSchemeVersion

2 values

  • HASHING_SCHEME_VERSION_UNSPECIFIED
  • HASHING_SCHEME_VERSION_V2

​
com.daml.ledger.api.v2.interactive.MinLedgerTime

2 fields

min_ledger_time_absTimestamp
min_ledger_time_relDuration

​
com.daml.ledger.api.v2.TransactionFormat

2 fields

event_formatEventFormat
transaction_shapeTransactionShape

​
com.daml.ledger.api.v2.EventFormat

3 fields

filters_by_partyrepeated map
filters_for_any_partyFilters
verbosebool

​
com.daml.ledger.api.v2.Filters

1 fields

cumulativerepeated CumulativeFilter

​
com.daml.ledger.api.v2.CumulativeFilter

3 fields

wildcard_filterWildcardFilter
interface_filterInterfaceFilter
template_filterTemplateFilter

​
com.daml.ledger.api.v2.WildcardFilter

1 fields

include_created_event_blobbool

​
com.daml.ledger.api.v2.InterfaceFilter

3 fields

interface_idIdentifier
include_interface_viewbool
include_created_event_blobbool

​
com.daml.ledger.api.v2.TemplateFilter

2 fields

template_idIdentifier
include_created_event_blobbool

​
com.daml.ledger.api.v2.TransactionShape

3 values

  • TRANSACTION_SHAPE_UNSPECIFIED
  • TRANSACTION_SHAPE_ACS_DELTA
  • TRANSACTION_SHAPE_LEDGER_EFFECTS

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse

1 fields

transactionTransaction

​
com.daml.ledger.api.v2.Transaction

10 fields

update_idstring
command_idstring
workflow_idstring
effective_atTimestamp
eventsrepeated Event
offsetint64
synchronizer_idstring
trace_contextTraceContext
record_timeTimestamp
external_transaction_hashbytes

​
com.daml.ledger.api.v2.Event

3 fields

createdCreatedEvent
archivedArchivedEvent
exercisedExercisedEvent

​
com.daml.ledger.api.v2.CreatedEvent

15 fields

offsetint64
node_idint32
contract_idstring
template_idIdentifier
contract_keyValue
create_argumentsRecord
created_event_blobbytes
interface_viewsrepeated InterfaceView
witness_partiesrepeated string
signatoriesrepeated string
observersrepeated string
created_atTimestamp
package_namestring
acs_deltabool
representative_package_idstring

​
com.daml.ledger.api.v2.InterfaceView

3 fields

interface_idIdentifier
view_statusStatus
view_valueRecord

​
com.daml.ledger.api.v2.ArchivedEvent

7 fields

offsetint64
node_idint32
contract_idstring
template_idIdentifier
witness_partiesrepeated string
package_namestring
implemented_interfacesrepeated Identifier

​
com.daml.ledger.api.v2.ExercisedEvent

15 fields

offsetint64
node_idint32
contract_idstring
template_idIdentifier
interface_idIdentifier
choicestring
choice_argumentValue
acting_partiesrepeated string
consumingbool
witness_partiesrepeated string
last_descendant_node_idint32
exercise_resultValue
package_namestring
implemented_interfacesrepeated Identifier
acs_deltabool

​
com.daml.ledger.api.v2.TraceContext

2 fields

traceparentstring
tracestatestring

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest

8 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse

2 fields

update_idstring
completion_offsetint64

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest

8 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime

​
com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse

0 fields

​
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest

4 fields

partiesrepeated string
package_namestring
synchronizer_idstring
vetting_valid_atTimestamp

​
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse

1 fields

package_preferencePackagePreference

​
com.daml.ledger.api.v2.interactive.PackagePreference

2 fields

package_referencePackageReference
synchronizer_idstring

​
com.daml.ledger.api.v2.PackageReference

3 fields

package_idstring
package_namestring
package_versionstring

​
com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest

3 fields

package_vetting_requirementsrepeated PackageVettingRequirement
synchronizer_idstring
vetting_valid_atTimestamp

​
com.daml.ledger.api.v2.interactive.PackageVettingRequirement

2 fields

partiesrepeated string
package_namestring

​
com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse

2 fields

package_referencesrepeated PackageReference
synchronizer_idstring

​
com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest

13 fields

user_idstring
command_idstring
commandsrepeated Command
min_ledger_timeMinLedgerTime
max_record_timeTimestamp
act_asrepeated string
read_asrepeated string
disclosed_contractsrepeated DisclosedContract
synchronizer_idstring
package_id_selection_preferencerepeated string
verbose_hashingbool
prefetch_contract_keysrepeated PrefetchContractKey
estimate_traffic_costCostEstimationHints

​
com.daml.ledger.api.v2.Command

4 fields

createCreateCommand
exerciseExerciseCommand
exercise_by_keyExerciseByKeyCommand
create_and_exerciseCreateAndExerciseCommand

​
com.daml.ledger.api.v2.CreateCommand

2 fields

template_idIdentifier
create_argumentsRecord

​
com.daml.ledger.api.v2.ExerciseCommand

4 fields

template_idIdentifier
contract_idstring
choicestring
choice_argumentValue

​
com.daml.ledger.api.v2.ExerciseByKeyCommand

4 fields

template_idIdentifier
contract_keyValue
choicestring
choice_argumentValue

​
com.daml.ledger.api.v2.CreateAndExerciseCommand

4 fields

template_idIdentifier
create_argumentsRecord
choicestring
choice_argumentValue

​
com.daml.ledger.api.v2.DisclosedContract

4 fields

template_idIdentifier
contract_idstring
created_event_blobbytes
synchronizer_idstring

​
com.daml.ledger.api.v2.PrefetchContractKey

2 fields

template_idIdentifier
contract_keyValue

​
com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse

5 fields

prepared_transactionPreparedTransaction
prepared_transaction_hashbytes
hashing_scheme_versionHashingSchemeVersion
hashing_detailsstring
cost_estimationCostEstimation