Skip to content
Documentation/canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesCommandServiceView on canton-network-docs
canton-network-docs/Ledger APIgRPC APIPackagesv2ServicesCommandService

SubmitAndWaitForTransaction

Ledger APIgRPC APIv2SubmitAndWaitForTransaction

com.daml.ledger.api.v2

SubmitAndWaitForTransaction

gRPCSince 3.4.4
RPC/com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction

Protocol Details

Inputs

SubmitAndWaitForTransactionRequest

commandsCommands
transaction_formatTransactionFormat

Outputs

SubmitAndWaitForTransactionResponse

transactionTransaction

Lifecycle Changes

3.4.4introduced

com.daml.ledger.api.v2.SubmitAndWaitForTransactionRequest

commandsCommands
transaction_formatTransactionFormat

com.daml.ledger.api.v2.Commands

workflow_idstring
user_idstring
command_idstring
commandsrepeated Command
deduplication_durationDuration
deduplication_offsetint64
min_ledger_time_absTimestamp
min_ledger_time_relDuration
act_asrepeated string
read_asrepeated string
submission_idstring
disclosed_contractsrepeated DisclosedContract
synchronizer_idstring
package_id_selection_preferencerepeated string
prefetch_contract_keysrepeated PrefetchContractKey
taps_max_passesuint32

com.daml.ledger.api.v2.Command

createCreateCommand
exerciseExerciseCommand
exercise_by_keyExerciseByKeyCommand
create_and_exerciseCreateAndExerciseCommand

com.daml.ledger.api.v2.CreateCommand

template_idIdentifier
create_argumentsRecord

com.daml.ledger.api.v2.Identifier

package_idstring
module_namestring
entity_namestring

com.daml.ledger.api.v2.Record

record_idIdentifier
fieldsrepeated RecordField

com.daml.ledger.api.v2.RecordField

labelstring
valueValue

com.daml.ledger.api.v2.Value

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

valueValue

com.daml.ledger.api.v2.List

elementsrepeated Value

com.daml.ledger.api.v2.TextMap

entriesrepeated Entry

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

keystring
valueValue

com.daml.ledger.api.v2.GenMap

entriesrepeated Entry

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

keyValue
valueValue

com.daml.ledger.api.v2.Variant

variant_idIdentifier
constructorstring
valueValue

com.daml.ledger.api.v2.Enum

enum_idIdentifier
constructorstring

com.daml.ledger.api.v2.ExerciseCommand

template_idIdentifier
contract_idstring
choicestring
choice_argumentValue

com.daml.ledger.api.v2.ExerciseByKeyCommand

template_idIdentifier
contract_keyValue
choicestring
choice_argumentValue

com.daml.ledger.api.v2.CreateAndExerciseCommand

template_idIdentifier
create_argumentsRecord
choicestring
choice_argumentValue

com.daml.ledger.api.v2.DisclosedContract

template_idIdentifier
contract_idstring
created_event_blobbytes
synchronizer_idstring

com.daml.ledger.api.v2.PrefetchContractKey

template_idIdentifier
contract_keyValue
limituint32

com.daml.ledger.api.v2.TransactionFormat

event_formatEventFormat
transaction_shapeTransactionShape

com.daml.ledger.api.v2.EventFormat

filters_by_partyrepeated map
filters_for_any_partyFilters
verbosebool

com.daml.ledger.api.v2.Filters

cumulativerepeated CumulativeFilter

com.daml.ledger.api.v2.CumulativeFilter

wildcard_filterWildcardFilter
interface_filterInterfaceFilter
template_filterTemplateFilter

com.daml.ledger.api.v2.WildcardFilter

include_created_event_blobbool

com.daml.ledger.api.v2.InterfaceFilter

interface_idIdentifier
include_interface_viewbool
include_created_event_blobbool

com.daml.ledger.api.v2.TemplateFilter

template_idIdentifier
include_created_event_blobbool

com.daml.ledger.api.v2.TransactionShape

  • TRANSACTION_SHAPE_UNSPECIFIED
  • TRANSACTION_SHAPE_ACS_DELTA
  • TRANSACTION_SHAPE_LEDGER_EFFECTS

com.daml.ledger.api.v2.SubmitAndWaitForTransactionResponse

transactionTransaction

com.daml.ledger.api.v2.Transaction

update_idstring
command_idstring
workflow_idstring
effective_atTimestamp
eventsrepeated Event
offsetint64
synchronizer_idstring
trace_contextTraceContext
record_timeTimestamp
external_transaction_hashbytes
paid_traffic_costint64

com.daml.ledger.api.v2.Event

createdCreatedEvent
archivedArchivedEvent
exercisedExercisedEvent

com.daml.ledger.api.v2.CreatedEvent

offsetint64
node_idint32
contract_idstring
template_idIdentifier
contract_keyValue
contract_key_hashbytes
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

interface_idIdentifier
view_statusStatus
view_valueRecord
implementation_package_idstring

com.daml.ledger.api.v2.ArchivedEvent

offsetint64
node_idint32
contract_idstring
template_idIdentifier
witness_partiesrepeated string
package_namestring
implemented_interfacesrepeated Identifier

com.daml.ledger.api.v2.ExercisedEvent

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

traceparentstring
tracestatestring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.CommandService/SubmitAndWaitForTransaction <<'EOF'
{
  "commands": {
    "workflowId": "string",
    "userId": "string",
    "commandId": "string",
    "commands": [
      {
        "create": {
          "templateId": {},
          "createArguments": {}
        }
      }
    ],
    "deduplicationDuration": "string",
    "minLedgerTimeAbs": "string",
    "minLedgerTimeRel": "string"
  },
  "transactionFormat": {
    "eventFormat": {
      "filtersByParty": [
        {
          "key": {
            "cumulative": [
              {}
            ]
          }
        }
      ],
      "filtersForAnyParty": {
        "cumulative": [
          {}
        ]
      },
      "verbose": true
    },
    "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
  }
}
EOF
OKapplication/json
OK
{
  "transaction": {
    "updateId": "string",
    "commandId": "string",
    "workflowId": "string",
    "effectiveAt": "string",
    "events": [
      {
        "created": {
          "offset": "0",
          "nodeId": 0,
          "contractId": "string",
          "templateId": {},
          "contractKey": {},
          "contractKeyHash": "BASE64_ENCODED_BYTES",
          "createArguments": {},
          "createdEventBlob": "BASE64_ENCODED_BYTES"
        }
      }
    ],
    "offset": "0",
    "synchronizerId": "string",
    "traceContext": {
      "traceparent": "string",
      "tracestate": "string"
    }
  }
}