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

​
v2.interactive

1 services, 6 endpoints, 28 messages, 1 enums

gRPC

​
Source Files

​
interactive_submission_common_data.proto

Source file from the latest descriptor snapshot.

​
interactive_submission_service.proto

Source file from the latest descriptor snapshot.

​
InteractiveSubmissionService

​
InteractiveSubmissionService.ExecuteSubmission

gRPCSince 3.4.4

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

​
InteractiveSubmissionService.ExecuteSubmissionAndWait

gRPCSince 3.4.4

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

​
InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction

gRPCSince 3.4.4

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

​
InteractiveSubmissionService.GetPreferredPackageVersion

gRPCSince 3.4.4

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

​
InteractiveSubmissionService.GetPreferredPackages

gRPCSince 3.4.4

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

​
InteractiveSubmissionService.PrepareSubmission

gRPCSince 3.4.4

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.

​
CostEstimation

com.daml.ledger.api.v2.interactive · 4 fields

estimation_timestampTimestamp
confirmation_request_traffic_cost_estimationuint64
confirmation_response_traffic_cost_estimationuint64
total_traffic_cost_estimationuint64

​
CostEstimationHints

com.daml.ledger.api.v2.interactive · 2 fields

disabledbool
expected_signaturesrepeated SigningAlgorithmSpec

​
SigningAlgorithmSpec

com.daml.ledger.api.v2 · 4 values

  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
  • SIGNING_ALGORITHM_SPEC_ED25519
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384

​
DamlTransaction

com.daml.ledger.api.v2.interactive · 4 fields

versionstring
rootsrepeated string
nodesrepeated Node
node_seedsrepeated NodeSeed

​
DamlTransaction.NodeSeed

com.daml.ledger.api.v2.interactive · 2 fields

node_idint32
seedbytes

​
DamlTransaction.Node

com.daml.ledger.api.v2.interactive · 2 fields

node_idstring
v1Node

​
Node

com.daml.ledger.api.v2.interactive.transaction.v1 · 4 fields

createCreate
fetchFetch
exerciseExercise
rollbackRollback

​
Create

com.daml.ledger.api.v2.interactive.transaction.v1 · 7 fields

lf_versionstring
contract_idstring
package_namestring
template_idIdentifier
argumentValue
signatoriesrepeated string
stakeholdersrepeated string

​
Identifier

com.daml.ledger.api.v2 · 3 fields

package_idstring
module_namestring
entity_namestring

​
Value

com.daml.ledger.api.v2 · 16 fields

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

​
Optional

com.daml.ledger.api.v2 · 1 fields

valueValue

​
List

com.daml.ledger.api.v2 · 1 fields

elementsrepeated Value

​
TextMap

com.daml.ledger.api.v2 · 1 fields

entriesrepeated Entry

​
TextMap.Entry

com.daml.ledger.api.v2 · 2 fields

keystring
valueValue

​
GenMap

com.daml.ledger.api.v2 · 1 fields

entriesrepeated Entry

​
GenMap.Entry

com.daml.ledger.api.v2 · 2 fields

keyValue
valueValue

​
Record

com.daml.ledger.api.v2 · 2 fields

record_idIdentifier
fieldsrepeated RecordField

​
RecordField

com.daml.ledger.api.v2 · 2 fields

labelstring
valueValue

​
Variant

com.daml.ledger.api.v2 · 3 fields

variant_idIdentifier
constructorstring
valueValue

​
Enum

com.daml.ledger.api.v2 · 2 fields

enum_idIdentifier
constructorstring

​
Fetch

com.daml.ledger.api.v2.interactive.transaction.v1 · 8 fields

lf_versionstring
contract_idstring
package_namestring
template_idIdentifier
signatoriesrepeated string
stakeholdersrepeated string
acting_partiesrepeated string
interface_idIdentifier

​
Exercise

com.daml.ledger.api.v2.interactive.transaction.v1 · 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

​
Rollback

com.daml.ledger.api.v2.interactive.transaction.v1 · 1 fields

childrenrepeated string

​
ExecuteSubmissionAndWaitForTransactionRequest

com.daml.ledger.api.v2.interactive · 9 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime
transaction_formatTransactionFormat

​
PreparedTransaction

com.daml.ledger.api.v2.interactive · 2 fields

transactionDamlTransaction
metadataMetadata

​
Metadata

com.daml.ledger.api.v2.interactive · 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

​
Metadata.SubmitterInfo

com.daml.ledger.api.v2.interactive · 2 fields

act_asrepeated string
command_idstring

​
Metadata.GlobalKeyMappingEntry

com.daml.ledger.api.v2.interactive · 2 fields

keyGlobalKey
valueValue

​
GlobalKey

com.daml.ledger.api.v2.interactive · 4 fields

template_idIdentifier
package_namestring
keyValue
hashbytes

​
Metadata.InputContract

com.daml.ledger.api.v2.interactive · 3 fields

v1Create
created_atuint64
event_blobbytes

​
PartySignatures

com.daml.ledger.api.v2.interactive · 1 fields

signaturesrepeated SinglePartySignatures

​
SinglePartySignatures

com.daml.ledger.api.v2.interactive · 2 fields

partystring
signaturesrepeated Signature

​
Signature

com.daml.ledger.api.v2 · 4 fields

formatSignatureFormat
signaturebytes
signed_bystring
signing_algorithm_specSigningAlgorithmSpec

​
SignatureFormat

com.daml.ledger.api.v2 · 5 values

  • SIGNATURE_FORMAT_UNSPECIFIED
  • SIGNATURE_FORMAT_RAW
  • SIGNATURE_FORMAT_DER
  • SIGNATURE_FORMAT_CONCAT
  • SIGNATURE_FORMAT_SYMBOLIC

​
HashingSchemeVersion

com.daml.ledger.api.v2.interactive · 2 values

  • HASHING_SCHEME_VERSION_UNSPECIFIED
  • HASHING_SCHEME_VERSION_V2

​
MinLedgerTime

com.daml.ledger.api.v2.interactive · 2 fields

min_ledger_time_absTimestamp
min_ledger_time_relDuration

​
TransactionFormat

com.daml.ledger.api.v2 · 2 fields

event_formatEventFormat
transaction_shapeTransactionShape

​
EventFormat

com.daml.ledger.api.v2 · 3 fields

filters_by_partyrepeated map
filters_for_any_partyFilters
verbosebool

​
Filters

com.daml.ledger.api.v2 · 1 fields

cumulativerepeated CumulativeFilter

​
CumulativeFilter

com.daml.ledger.api.v2 · 3 fields

wildcard_filterWildcardFilter
interface_filterInterfaceFilter
template_filterTemplateFilter

​
WildcardFilter

com.daml.ledger.api.v2 · 1 fields

include_created_event_blobbool

​
InterfaceFilter

com.daml.ledger.api.v2 · 3 fields

interface_idIdentifier
include_interface_viewbool
include_created_event_blobbool

​
TemplateFilter

com.daml.ledger.api.v2 · 2 fields

template_idIdentifier
include_created_event_blobbool

​
TransactionShape

com.daml.ledger.api.v2 · 3 values

  • TRANSACTION_SHAPE_UNSPECIFIED
  • TRANSACTION_SHAPE_ACS_DELTA
  • TRANSACTION_SHAPE_LEDGER_EFFECTS

​
ExecuteSubmissionAndWaitForTransactionResponse

com.daml.ledger.api.v2.interactive · 1 fields

transactionTransaction

​
Transaction

com.daml.ledger.api.v2 · 10 fields

update_idstring
command_idstring
workflow_idstring
effective_atTimestamp
eventsrepeated Event
offsetint64
synchronizer_idstring
trace_contextTraceContext
record_timeTimestamp
external_transaction_hashbytes

​
Event

com.daml.ledger.api.v2 · 3 fields

createdCreatedEvent
archivedArchivedEvent
exercisedExercisedEvent

​
CreatedEvent

com.daml.ledger.api.v2 · 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

​
InterfaceView

com.daml.ledger.api.v2 · 3 fields

interface_idIdentifier
view_statusStatus
view_valueRecord

​
ArchivedEvent

com.daml.ledger.api.v2 · 7 fields

offsetint64
node_idint32
contract_idstring
template_idIdentifier
witness_partiesrepeated string
package_namestring
implemented_interfacesrepeated Identifier

​
ExercisedEvent

com.daml.ledger.api.v2 · 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

​
TraceContext

com.daml.ledger.api.v2 · 2 fields

traceparentstring
tracestatestring

​
ExecuteSubmissionAndWaitRequest

com.daml.ledger.api.v2.interactive · 8 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime

​
ExecuteSubmissionAndWaitResponse

com.daml.ledger.api.v2.interactive · 2 fields

update_idstring
completion_offsetint64

​
ExecuteSubmissionRequest

com.daml.ledger.api.v2.interactive · 8 fields

prepared_transactionPreparedTransaction
party_signaturesPartySignatures
deduplication_durationDuration
deduplication_offsetint64
submission_idstring
user_idstring
hashing_scheme_versionHashingSchemeVersion
min_ledger_timeMinLedgerTime

​
ExecuteSubmissionResponse

com.daml.ledger.api.v2.interactive · 0 fields

​
GetPreferredPackageVersionRequest

com.daml.ledger.api.v2.interactive · 4 fields

partiesrepeated string
package_namestring
synchronizer_idstring
vetting_valid_atTimestamp

​
GetPreferredPackageVersionResponse

com.daml.ledger.api.v2.interactive · 1 fields

package_preferencePackagePreference

​
PackagePreference

com.daml.ledger.api.v2.interactive · 2 fields

package_referencePackageReference
synchronizer_idstring

​
PackageReference

com.daml.ledger.api.v2 · 3 fields

package_idstring
package_namestring
package_versionstring

​
GetPreferredPackagesRequest

com.daml.ledger.api.v2.interactive · 3 fields

package_vetting_requirementsrepeated PackageVettingRequirement
synchronizer_idstring
vetting_valid_atTimestamp

​
PackageVettingRequirement

com.daml.ledger.api.v2.interactive · 2 fields

partiesrepeated string
package_namestring

​
GetPreferredPackagesResponse

com.daml.ledger.api.v2.interactive · 2 fields

package_referencesrepeated PackageReference
synchronizer_idstring

​
PrepareSubmissionRequest

com.daml.ledger.api.v2.interactive · 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

​
Command

com.daml.ledger.api.v2 · 4 fields

createCreateCommand
exerciseExerciseCommand
exercise_by_keyExerciseByKeyCommand
create_and_exerciseCreateAndExerciseCommand

​
CreateCommand

com.daml.ledger.api.v2 · 2 fields

template_idIdentifier
create_argumentsRecord

​
ExerciseCommand

com.daml.ledger.api.v2 · 4 fields

template_idIdentifier
contract_idstring
choicestring
choice_argumentValue

​
ExerciseByKeyCommand

com.daml.ledger.api.v2 · 4 fields

template_idIdentifier
contract_keyValue
choicestring
choice_argumentValue

​
CreateAndExerciseCommand

com.daml.ledger.api.v2 · 4 fields

template_idIdentifier
create_argumentsRecord
choicestring
choice_argumentValue

​
DisclosedContract

com.daml.ledger.api.v2 · 4 fields

template_idIdentifier
contract_idstring
created_event_blobbytes
synchronizer_idstring

​
PrefetchContractKey

com.daml.ledger.api.v2 · 2 fields

template_idIdentifier
contract_keyValue

​
PrepareSubmissionResponse

com.daml.ledger.api.v2.interactive · 5 fields

prepared_transactionPreparedTransaction
prepared_transaction_hashbytes
hashing_scheme_versionHashingSchemeVersion
hashing_detailsstring
cost_estimationCostEstimation