> ## 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. # com.daml.ledger.api.v2.interactive > Package-level overview for com.daml.ledger.api.v2.interactive.

Back to overview

Protobuf Package

com.daml.ledger.api.v2.interactive

1 services, 6 endpoints, 29 messages, 1 enums

gRPC
Files
2
Services
1
Endpoints
6
Messages
29
Enums
1
## 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.

Services
0
Messages
2
Enums
0
Source
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive\_submission\_common\_data.proto

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.

Services
1
Messages
22
Enums
1
Source
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive\_submission\_service.proto
## InteractiveSubmissionService
Source file
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/interactive\_submission\_service.proto
Operations
6

InteractiveSubmissionService.ExecuteSubmission

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.ExecuteSubmissionRequest
Response
com.daml.ledger.api.v2.interactive.ExecuteSubmissionResponse
Client stream
No
Server stream
No

InteractiveSubmissionService.ExecuteSubmissionAndWait

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitRequest
Response
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitResponse
Client stream
No
Server stream
No

InteractiveSubmissionService.ExecuteSubmissionAndWaitForTransaction

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionRequest
Response
com.daml.ledger.api.v2.interactive.ExecuteSubmissionAndWaitForTransactionResponse
Client stream
No
Server stream
No

InteractiveSubmissionService.GetPreferredPackageVersion

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionRequest
Response
com.daml.ledger.api.v2.interactive.GetPreferredPackageVersionResponse
Client stream
No
Server stream
No

InteractiveSubmissionService.GetPreferredPackages

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.GetPreferredPackagesRequest
Response
com.daml.ledger.api.v2.interactive.GetPreferredPackagesResponse
Client stream
No
Server stream
No

InteractiveSubmissionService.PrepareSubmission

gRPC Since 3.4.0

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

Request
com.daml.ledger.api.v2.interactive.PrepareSubmissionRequest
Response
com.daml.ledger.api.v2.interactive.PrepareSubmissionResponse
Client stream
No
Server stream
No
## 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\_timestamp Timestamp
confirmation\_request\_traffic\_cost\_estimation uint64
confirmation\_response\_traffic\_cost\_estimation uint64
total\_traffic\_cost\_estimation uint64

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

2 fields

disabled bool
expected\_signatures repeated SigningAlgorithmSpec

com.daml.ledger.api.v2.SigningAlgorithmSpec

4 values

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

4 fields

version string
roots repeated string
nodes repeated Node
node\_seeds repeated NodeSeed

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

2 fields

node\_id int32
seed bytes

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

2 fields

node\_id string
v1 Node

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

5 fields

create Create
fetch Fetch
exercise Exercise
rollback Rollback
query\_by\_key QueryByKey

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

8 fields

lf\_version string
contract\_id string
package\_name string
template\_id Identifier
argument Value
signatories repeated string
stakeholders repeated string
key GlobalKeyWithMaintainers

com.daml.ledger.api.v2.Identifier

3 fields

package\_id string
module\_name string
entity\_name string

com.daml.ledger.api.v2.Value

16 fields

unit Empty
bool bool
int64 sint64
date int32
timestamp sfixed64
numeric string
party string
text string
contract\_id string
optional Optional
list List
text\_map TextMap
gen\_map GenMap
record Record
variant Variant
enum Enum

com.daml.ledger.api.v2.Optional

1 fields

value Value

com.daml.ledger.api.v2.List

1 fields

elements repeated Value

com.daml.ledger.api.v2.TextMap

1 fields

entries repeated Entry

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

2 fields

key string
value Value

com.daml.ledger.api.v2.GenMap

1 fields

entries repeated Entry

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

2 fields

key Value
value Value

com.daml.ledger.api.v2.Record

2 fields

record\_id Identifier
fields repeated RecordField

com.daml.ledger.api.v2.RecordField

2 fields

label string
value Value

com.daml.ledger.api.v2.Variant

3 fields

variant\_id Identifier
constructor string
value Value

com.daml.ledger.api.v2.Enum

2 fields

enum\_id Identifier
constructor string

com.daml.ledger.api.v2.interactive.GlobalKeyWithMaintainers

2 fields

key GlobalKey
maintainers repeated string

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

4 fields

template\_id Identifier
package\_name string
key Value
hash bytes

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

10 fields

lf\_version string
contract\_id string
package\_name string
template\_id Identifier
signatories repeated string
stakeholders repeated string
acting\_parties repeated string
interface\_id Identifier
key GlobalKeyWithMaintainers
by\_key bool

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

16 fields

lf\_version string
contract\_id string
package\_name string
template\_id Identifier
signatories repeated string
stakeholders repeated string
acting\_parties repeated string
interface\_id Identifier
choice\_id string
chosen\_value Value
consuming bool
children repeated string
exercise\_result Value
choice\_observers repeated string
key GlobalKeyWithMaintainers
by\_key bool

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

1 fields

children repeated string

com.daml.ledger.api.v2.interactive.transaction.v1.QueryByKey

6 fields

lf\_version string
package\_name string
template\_id Identifier
exhaustive bool
key GlobalKeyWithMaintainers
result repeated string

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

9 fields

prepared\_transaction PreparedTransaction
party\_signatures PartySignatures
deduplication\_duration Duration
deduplication\_offset int64
submission\_id string
user\_id string
hashing\_scheme\_version HashingSchemeVersion
min\_ledger\_time MinLedgerTime
transaction\_format TransactionFormat

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

2 fields

transaction DamlTransaction
metadata Metadata

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

10 fields

submitter\_info SubmitterInfo
synchronizer\_id string
mediator\_group uint32
transaction\_uuid string
preparation\_time uint64
input\_contracts repeated InputContract
min\_ledger\_effective\_time uint64
max\_ledger\_effective\_time uint64
max\_record\_time uint64
global\_key\_mapping repeated GlobalKeyMappingEntry

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

2 fields

act\_as repeated string
command\_id string

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

2 fields

key GlobalKey
value Value

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

3 fields

v1 Create
created\_at uint64
event\_blob bytes

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

1 fields

signatures repeated SinglePartySignatures

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

2 fields

party string
signatures repeated Signature

com.daml.ledger.api.v2.Signature

4 fields

format SignatureFormat
signature bytes
signed\_by string
signing\_algorithm\_spec SigningAlgorithmSpec

com.daml.ledger.api.v2.SignatureFormat

5 values

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

3 values

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

2 fields

min\_ledger\_time\_abs Timestamp
min\_ledger\_time\_rel Duration

com.daml.ledger.api.v2.TransactionFormat

2 fields

event\_format EventFormat
transaction\_shape TransactionShape

com.daml.ledger.api.v2.EventFormat

3 fields

filters\_by\_party repeated map
filters\_for\_any\_party Filters
verbose bool

com.daml.ledger.api.v2.Filters

1 fields

cumulative repeated CumulativeFilter

com.daml.ledger.api.v2.CumulativeFilter

3 fields

wildcard\_filter WildcardFilter
interface\_filter InterfaceFilter
template\_filter TemplateFilter

com.daml.ledger.api.v2.WildcardFilter

1 fields

include\_created\_event\_blob bool

com.daml.ledger.api.v2.InterfaceFilter

3 fields

interface\_id Identifier
include\_interface\_view bool
include\_created\_event\_blob bool

com.daml.ledger.api.v2.TemplateFilter

2 fields

template\_id Identifier
include\_created\_event\_blob bool

com.daml.ledger.api.v2.TransactionShape

3 values

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

1 fields

transaction Transaction

com.daml.ledger.api.v2.Transaction

11 fields

update\_id string
command\_id string
workflow\_id string
effective\_at Timestamp
events repeated Event
offset int64
synchronizer\_id string
trace\_context TraceContext
record\_time Timestamp
external\_transaction\_hash bytes
paid\_traffic\_cost int64

com.daml.ledger.api.v2.Event

3 fields

created CreatedEvent
archived ArchivedEvent
exercised ExercisedEvent

com.daml.ledger.api.v2.CreatedEvent

16 fields

offset int64
node\_id int32
contract\_id string
template\_id Identifier
contract\_key Value
contract\_key\_hash bytes
create\_arguments Record
created\_event\_blob bytes
interface\_views repeated InterfaceView
witness\_parties repeated string
signatories repeated string
observers repeated string
created\_at Timestamp
package\_name string
acs\_delta bool
representative\_package\_id string

com.daml.ledger.api.v2.InterfaceView

4 fields

interface\_id Identifier
view\_status Status
view\_value Record
implementation\_package\_id string

com.daml.ledger.api.v2.ArchivedEvent

7 fields

offset int64
node\_id int32
contract\_id string
template\_id Identifier
witness\_parties repeated string
package\_name string
implemented\_interfaces repeated Identifier

com.daml.ledger.api.v2.ExercisedEvent

15 fields

offset int64
node\_id int32
contract\_id string
template\_id Identifier
interface\_id Identifier
choice string
choice\_argument Value
acting\_parties repeated string
consuming bool
witness\_parties repeated string
last\_descendant\_node\_id int32
exercise\_result Value
package\_name string
implemented\_interfaces repeated Identifier
acs\_delta bool

com.daml.ledger.api.v2.TraceContext

2 fields

traceparent string
tracestate string

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

8 fields

prepared\_transaction PreparedTransaction
party\_signatures PartySignatures
deduplication\_duration Duration
deduplication\_offset int64
submission\_id string
user\_id string
hashing\_scheme\_version HashingSchemeVersion
min\_ledger\_time MinLedgerTime

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

2 fields

update\_id string
completion\_offset int64

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

8 fields

prepared\_transaction PreparedTransaction
party\_signatures PartySignatures
deduplication\_duration Duration
deduplication\_offset int64
submission\_id string
user\_id string
hashing\_scheme\_version HashingSchemeVersion
min\_ledger\_time MinLedgerTime

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

0 fields

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

4 fields

parties repeated string
package\_name string
synchronizer\_id string
vetting\_valid\_at Timestamp

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

1 fields

package\_preference PackagePreference

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

2 fields

package\_reference PackageReference
synchronizer\_id string

com.daml.ledger.api.v2.PackageReference

3 fields

package\_id string
package\_name string
package\_version string

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

3 fields

package\_vetting\_requirements repeated PackageVettingRequirement
synchronizer\_id string
vetting\_valid\_at Timestamp

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

2 fields

parties repeated string
package\_name string

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

2 fields

package\_references repeated PackageReference
synchronizer\_id string

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

15 fields

user\_id string
command\_id string
commands repeated Command
min\_ledger\_time MinLedgerTime
max\_record\_time Timestamp
act\_as repeated string
read\_as repeated string
disclosed\_contracts repeated DisclosedContract
synchronizer\_id string
package\_id\_selection\_preference repeated string
verbose\_hashing bool
prefetch\_contract\_keys repeated PrefetchContractKey
estimate\_traffic\_cost CostEstimationHints
hashing\_scheme\_version HashingSchemeVersion
taps\_max\_passes uint32

com.daml.ledger.api.v2.Command

4 fields

create CreateCommand
exercise ExerciseCommand
exercise\_by\_key ExerciseByKeyCommand
create\_and\_exercise CreateAndExerciseCommand

com.daml.ledger.api.v2.CreateCommand

2 fields

template\_id Identifier
create\_arguments Record

com.daml.ledger.api.v2.ExerciseCommand

4 fields

template\_id Identifier
contract\_id string
choice string
choice\_argument Value

com.daml.ledger.api.v2.ExerciseByKeyCommand

4 fields

template\_id Identifier
contract\_key Value
choice string
choice\_argument Value

com.daml.ledger.api.v2.CreateAndExerciseCommand

4 fields

template\_id Identifier
create\_arguments Record
choice string
choice\_argument Value

com.daml.ledger.api.v2.DisclosedContract

4 fields

template\_id Identifier
contract\_id string
created\_event\_blob bytes
synchronizer\_id string

com.daml.ledger.api.v2.PrefetchContractKey

3 fields

template\_id Identifier
contract\_key Value
limit uint32

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

5 fields

prepared\_transaction PreparedTransaction
prepared\_transaction\_hash bytes
hashing\_scheme\_version HashingSchemeVersion
hashing\_details string
cost\_estimation CostEstimation