POST /v2/commands/submit-and-wait-for-transaction

Submits a single composite command, waits for its result, and returns the transaction. Propagates the gRPC error of failed submissions including Daml interpretation errors.

POST /v2/commands/submit-and-wait-for-transaction

cURL

curl --request POST \
  --url 'http://localhost:7575/v2/commands/submit-and-wait-for-transaction' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "commands": {
    "commands": [
      {
        "CreateAndExerciseCommand": {
          "templateId": "<string>",
          "createArguments": "<string>",
          "choice": "<string>",
          "choiceArgument": "<string>"
        }
      }
    ],
    "commandId": "<string>",
    "actAs": [
      "<string>"
    ],
    "userId": "<string>",
    "readAs": [
      "<string>"
    ],
    "workflowId": "<string>",
    "deduplicationPeriod": {
      "DeduplicationDuration": {
        "value": {
          "seconds": 123,
          "nanos": 123,
          "unknownFields": "<object>"
        }
      }
    },
    "minLedgerTimeAbs": "<string>",
    "minLedgerTimeRel": {
      "seconds": 123,
      "nanos": 123,
      "unknownFields": {
        "fields": {}
      }
    },
    "submissionId": "<string>",
    "disclosedContracts": [
      {
        "templateId": "<string>",
        "contractId": "<string>",
        "createdEventBlob": "<string>",
        "synchronizerId": "<string>"
      }
    ],
    "synchronizerId": "<string>",
    "packageIdSelectionPreference": [
      "<string>"
    ],
    "prefetchContractKeys": [
      {
        "templateId": "<string>",
        "contractKey": "<string>",
        "limit": 123
      }
    ],
    "tapsMaxPasses": 123
  },
  "transactionFormat": {
    "eventFormat": {
      "filtersByParty": {},
      "filtersForAnyParty": {
        "cumulative": [
          {
            "identifierFilter": "<object>"
          }
        ]
      },
      "verbose": false
    },
    "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
  }
}'

200

{
  "transaction": {
    "updateId": "<string>",
    "commandId": "<string>",
    "workflowId": "<string>",
    "effectiveAt": "<string>",
    "events": [
      {
        "ArchivedEvent": {
          "offset": 123,
          "nodeId": 123,
          "contractId": "<string>",
          "templateId": "<string>",
          "witnessParties": [
            "<string>"
          ],
          "packageName": "<string>",
          "implementedInterfaces": [
            "<string>"
          ]
        }
      }
    ],
    "offset": 123,
    "synchronizerId": "<string>",
    "traceContext": {
      "traceparent": "<string>",
      "tracestate": "<string>"
    },
    "recordTime": "<string>",
    "externalTransactionHash": "<string>",
    "paidTrafficCost": 123
  }
}

Submits a single composite command, waits for its result, and returns the transaction. Propagates the gRPC error of failed submissions including Daml interpretation errors.

OpenAPIUpdated 3.5Added 3.4

cURL

curl --request POST \
  --url 'http://localhost:7575/v2/commands/submit-and-wait-for-transaction' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "commands": {
    "commands": [
      {
        "CreateAndExerciseCommand": {
          "templateId": "<string>",
          "createArguments": "<string>",
          "choice": "<string>",
          "choiceArgument": "<string>"
        }
      }
    ],
    "commandId": "<string>",
    "actAs": [
      "<string>"
    ],
    "userId": "<string>",
    "readAs": [
      "<string>"
    ],
    "workflowId": "<string>",
    "deduplicationPeriod": {
      "DeduplicationDuration": {
        "value": {
          "seconds": 123,
          "nanos": 123,
          "unknownFields": "<object>"
        }
      }
    },
    "minLedgerTimeAbs": "<string>",
    "minLedgerTimeRel": {
      "seconds": 123,
      "nanos": 123,
      "unknownFields": {
        "fields": {}
      }
    },
    "submissionId": "<string>",
    "disclosedContracts": [
      {
        "templateId": "<string>",
        "contractId": "<string>",
        "createdEventBlob": "<string>",
        "synchronizerId": "<string>"
      }
    ],
    "synchronizerId": "<string>",
    "packageIdSelectionPreference": [
      "<string>"
    ],
    "prefetchContractKeys": [
      {
        "templateId": "<string>",
        "contractKey": "<string>",
        "limit": 123
      }
    ],
    "tapsMaxPasses": 123
  },
  "transactionFormat": {
    "eventFormat": {
      "filtersByParty": {},
      "filtersForAnyParty": {
        "cumulative": [
          {
            "identifierFilter": "<object>"
          }
        ]
      },
      "verbose": false
    },
    "transactionShape": "TRANSACTION_SHAPE_UNSPECIFIED"
  }
}'

200

{
  "transaction": {
    "updateId": "<string>",
    "commandId": "<string>",
    "workflowId": "<string>",
    "effectiveAt": "<string>",
    "events": [
      {
        "ArchivedEvent": {
          "offset": 123,
          "nodeId": 123,
          "contractId": "<string>",
          "templateId": "<string>",
          "witnessParties": [
            "<string>"
          ],
          "packageName": "<string>",
          "implementedInterfaces": [
            "<string>"
          ]
        }
      }
    ],
    "offset": 123,
    "synchronizerId": "<string>",
    "traceContext": {
      "traceparent": "<string>",
      "tracestate": "<string>"
    },
    "recordTime": "<string>",
    "externalTransactionHash": "<string>",
    "paidTrafficCost": 123
  }
}

Authorizations

httpAuth

Authorization · string · required

HTTP bearer authentication. Send the token as Authorization: Bearer <token>. Ledger API standard JWT token

apiKeyAuth

Sec-WebSocket-Protocol · string · required

API key authentication in the header. Ledger API standard JWT token (websocket)

Body

application/json

commands · object · required

OpenAPI type: JsCommands.

A composite command that groups multiple commands together.

Show child attributes

commands · object[] · required

OpenAPI type: Command[].

Individual elements of this atomic command. Must be non-empty. Required: must be non-empty

Show child attributes

Variant 1 · object

Show child attributes

CreateAndExerciseCommand · object · required

OpenAPI type: CreateAndExerciseCommand.

Create a contract and exercise a choice on it in the same transaction.

Show child attributes

templateId · string · required

The template of the contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

createArguments · object · required

The arguments required for creating a contract from this template. Required

choice · string · required

The name of the choice the client wants to exercise. Must be a valid NameString (as described in value.proto). Required

choiceArgument · object · required

The argument for this choice. Required

Variant 2 · object

Show child attributes

CreateCommand · object · required

OpenAPI type: CreateCommand.

Create a new contract instance based on a template.

Show child attributes

templateId · string · required

The template of contract the client wants to create. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

createArguments · object · required

The arguments required for creating a contract from this template. Required

Variant 3 · object

Show child attributes

ExerciseByKeyCommand · object · required

OpenAPI type: ExerciseByKeyCommand.

Exercise a choice on an existing contract specified by its key.

Show child attributes

templateId · string · required

The template of contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

contractKey · object · required

The key of the contract the client wants to exercise upon. Required

choice · string · required

The name of the choice the client wants to exercise. Must be a valid NameString (as described in value.proto) Required

choiceArgument · object · required

The argument for this choice. Required

Variant 4 · object

Show child attributes

ExerciseCommand · object · required

OpenAPI type: ExerciseCommand.

Exercise a choice on an existing contract.

Show child attributes

templateId · string · required

The template or interface of the contract the client wants to exercise. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. To exercise a choice on an interface, specify the interface identifier in the template_id field. Required

contractId · string · required

The ID of the contract the client wants to exercise upon. Must be a valid LedgerString (as described in value.proto). Required

choice · string · required

The name of the choice the client wants to exercise. Must be a valid NameString (as described in value.proto) Required

choiceArgument · object · required

The argument for this choice. Required

commandId · string · required

Uniquely identifies the command. The triple (user_id, act_as, command_id) constitutes the change ID for the intended ledger change, where act_as is interpreted as a set of party names. The change ID can be used for matching the intended ledger changes with all their completions. Must be a valid LedgerString (as described in value.proto). Required

actAs · string[] · required

Set of parties on whose behalf the command should be executed. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to act on behalf of each of the given parties. Each element must be a valid PartyIdString (as described in value.proto). Required: must be non-empty

userId · string

Uniquely identifies the participant user that issued the command. Must be a valid UserIdString (as described in value.proto). Required unless authentication is used with a user token. In that case, the token’s user-id will be used for the request’s user_id. Optional

readAs · string[]

Set of parties on whose behalf (in addition to all parties listed in act_as) contracts can be retrieved. This affects Daml operations such as fetch, fetchByKey, lookupByKey, exercise, and exerciseByKey. Note: A participant node of a Daml network can host multiple parties. Each contract present on the participant node is only visible to a subset of these parties. A command can only use contracts that are visible to at least one of the parties in act_as or read_as. This visibility check is independent from the Daml authorization rules for fetch operations. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read contract data on behalf of each of the given parties. Optional: can be empty

workflowId · string

Identifier of the on-ledger workflow that this command is a part of. Must be a valid LedgerString (as described in value.proto). Optional

deduplicationPeriod · object

OpenAPI type: DeduplicationPeriod.

Specifies the deduplication period for the change ID. If omitted, the participant will assume the configured maximum deduplication time. Optional

Show child attributes

Variant 1 · object

Show child attributes

DeduplicationDuration · object · required

OpenAPI type: DeduplicationDuration.

Show child attributes

value · object · required

OpenAPI type: Duration.

Show child attributes

seconds · number · required

OpenAPI type: integer (int64).

nanos · number · required

OpenAPI type: integer (int32).

unknownFields · object

OpenAPI type: UnknownFieldSet.

This field is automatically added as part of protobuf to json mapping

Show child attributes

fields · object · required

OpenAPI type: Map_Int_Field.

Variant 2 · object

Show child attributes

DeduplicationOffset · object · required

OpenAPI type: DeduplicationOffset.

Show child attributes

value · number · required

OpenAPI type: integer (int64).

Variant 3 · object

Show child attributes

Empty · object · required

OpenAPI type: Empty.

minLedgerTimeAbs · string

Lower bound for the ledger time assigned to the resulting transaction. Note: The ledger time of a transaction is assigned as part of command interpretation. Use this property if you expect that command interpretation will take a considerate amount of time, such that by the time the resulting transaction is sequenced, its assigned ledger time is not valid anymore. Must not be set at the same time as min_ledger_time_rel. Optional

minLedgerTimeRel · object

OpenAPI type: Duration.

Same as min_ledger_time_abs, but specified as a duration, starting from the time the command is received by the server. Must not be set at the same time as min_ledger_time_abs. Optional

Show child attributes

seconds · number · required

OpenAPI type: integer (int64).

nanos · number · required

OpenAPI type: integer (int32).

unknownFields · object

OpenAPI type: UnknownFieldSet.

This field is automatically added as part of protobuf to json mapping

Show child attributes

fields · object · required

OpenAPI type: Map_Int_Field.

submissionId · string

A unique identifier to distinguish completions for different submissions with the same change ID. Typically a random UUID. Applications are expected to use a different UUID for each retry of a submission with the same change ID. Must be a valid LedgerString (as described in value.proto). If omitted, the participant or the committer may set a value of their choice. Optional

disclosedContracts · object[]

OpenAPI type: DisclosedContract[].

Additional contracts used to resolve contract & contract key lookups. Optional: can be empty

Show child attributes

templateId · string

The template id of the contract. The identifier uses the package-id reference format. If provided, used to validate the template id of the contract serialized in the created_event_blob. Optional

contractId · string

The contract id If provided, used to validate the contract id of the contract serialized in the created_event_blob. Optional

createdEventBlob · string · required

Opaque byte string containing the complete payload required by the Daml engine to reconstruct a contract not known to the receiving participant. Required: must be non-empty

synchronizerId · string

The ID of the synchronizer where the contract is currently assigned Optional

synchronizerId · string

Must be a valid synchronizer id Optional

packageIdSelectionPreference · string[]

The package-id selection preference of the client for resolving package names and interface instances in command submission and interpretation Optional: can be empty

prefetchContractKeys · object[]

OpenAPI type: PrefetchContractKey[].

Fetches the contract keys into the caches to speed up the command processing. Each entry specifies a key and a limit on how many contracts to prefetch for that key. The limit does not count disclosed contracts, and should reflect the number of additional contracts expected to be resolved during interpretation of the commands. If a key appears multiple times, the last entry’s limit wins. Optional: can be empty

Show child attributes

templateId · string · required

The template of contract the client wants to prefetch. Both package-name and package-id reference identifier formats for the template-id are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

contractKey · object · required

The key of the contract the client wants to prefetch. Required

limit · number

OpenAPI type: integer (int32).

The number of contracts to prefetch for this key, if available. This is in addition to disclosed contracts. - for backward compatibility reason, absence is interpreted as 1 - 0 is forbidden - capped at 2^31 - 1. The system may impose further limits. Optional

tapsMaxPasses · number

OpenAPI type: integer (int32).

The maximum number of passes for the Topology-Aware Package Selection (TAPS). Higher values can increase the chance of successful package selection for routing of interpreted transactions. If unset, this defaults to the value defined in the participant configuration. The provided value must not exceed the limit specified in the participant configuration. Optional

transactionFormat · object

OpenAPI type: TransactionFormat.

A format that specifies what events to include in Daml transactions and what data to compute and include for them.

Show child attributes

eventFormat · object · required

OpenAPI type: EventFormat.

A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the TransactionShape, which is expected to be specified alongside usages of EventFormat.

Show child attributes

filtersByParty · object

OpenAPI type: Map_Filters.

Each key must be a valid PartyIdString (as described in value.proto). The interpretation of the filter depends on the transaction-shape being filtered: 1. For ledger-effects create and exercise events are returned, for which the witnesses include at least one of the listed parties and match the per-party filter. 2. For transaction and active-contract-set streams create and archive events are returned for all contracts whose stakeholders include at least one of the listed parties and match the per-party filter. Optional: can be empty

filtersForAnyParty · object

OpenAPI type: Filters.

The union of a set of template filters, interface filters, or a wildcard.

Show child attributes

cumulative · object[]

OpenAPI type: CumulativeFilter[].

Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no CumulativeFilter defined, the default of a single WildcardFilter with include_created_event_blob unset is used. Optional: can be empty

Show child attributes

identifierFilter · object

OpenAPI type: IdentifierFilter.

Required

Show child attributes

Variant 1 · object

Show child attributes

Empty · object · required

OpenAPI type: Empty1.

Variant 2 · object

Show child attributes

InterfaceFilter · object · required

OpenAPI type: InterfaceFilter.

This filter matches contracts that implement a specific interface.

Show child attributes

value · object · required

OpenAPI type: InterfaceFilter1.

This filter matches contracts that implement a specific interface.

Show child attributes

interfaceId · string · required

The interface that a matching contract must implement. The interface_id needs to be valid: corresponding interface should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

includeInterfaceView · boolean

Whether to include the interface view on the contract in the returned CreatedEvent. Use this to access contract data in a uniform manner in your API client. Optional

includeCreatedEventBlob · boolean

Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional

Variant 3 · object

Show child attributes

TemplateFilter · object · required

OpenAPI type: TemplateFilter.

This filter matches contracts of a specific template.

Show child attributes

value · object · required

OpenAPI type: TemplateFilter1.

This filter matches contracts of a specific template.

Show child attributes

templateId · string · required

A template for which the payload should be included in the response. The template_id needs to be valid: corresponding template should be defined in one of the available packages at the time of the query. Both package-name and package-id reference formats for the identifier are supported. Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4. Required

includeCreatedEventBlob · boolean

Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract event payload in your API client for submitting it as a disclosed contract with future commands. Optional

Variant 4 · object

Show child attributes

WildcardFilter · object · required

OpenAPI type: WildcardFilter.

This filter matches all templates.

Show child attributes

value · object · required

OpenAPI type: WildcardFilter1.

This filter matches all templates.

Show child attributes

includeCreatedEventBlob · boolean

Whether to include a created_event_blob in the returned CreatedEvent. Use this to access the contract create event payload in your API client for submitting it as a disclosed contract with future commands. Optional

verbose · boolean

If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional

transactionShape · string · required

What transaction shape to use for interpreting the filters of the event format. Required

Allowed values: TRANSACTION_SHAPE_UNSPECIFIED, TRANSACTION_SHAPE_ACS_DELTA, TRANSACTION_SHAPE_LEDGER_EFFECTS.

Responses

200

application/json

transaction · JsTransaction · required

Filtered view of an on-ledger transaction’s create and archive events.

Show child attributes

updateId · string · required

Assigned by the server. Useful for correlating logs. Must be a valid LedgerString (as described in value.proto). Required

commandId · string

The ID of the command which resulted in this transaction. Missing for everyone except the submitting party. Must be a valid LedgerString (as described in value.proto). Optional

workflowId · string

The workflow ID used in command submission. Must be a valid LedgerString (as described in value.proto). Optional

effectiveAt · string · required

Ledger effective time. Required

events · Event[] · required

The collection of events. Contains: - CreatedEvent or ArchivedEvent in case of ACS_DELTA transaction shape - CreatedEvent or ExercisedEvent in case of LEDGER_EFFECTS transaction shape Required: must be non-empty

Show child attributes

Variant 1 · object

Show child attributes

ArchivedEvent · ArchivedEvent · required

Records that a contract has been archived, and choices may no longer be exercised on it.

Show child attributes

offset · integer (int64) · required

The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required

nodeId · integer (int32) · required

The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required

contractId · string · required

The ID of the archived contract. Must be a valid LedgerString (as described in value.proto). Required

templateId · string · required

Identifies the template that defines the choice that archived the contract. This template’s package-id may differ from the target contract’s package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required

witnessParties · string[] · required

The parties that are notified of this event. For an ArchivedEvent, these are the intersection of the stakeholders of the contract in question and the parties specified in the TransactionFilter. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in value.proto). Required: must be non-empty

packageName · string · required

The package name of the contract. Required

implementedInterfaces · string[]

The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional: can be empty

Variant 2 · object

Show child attributes

CreatedEvent · CreatedEvent · required

Records that a contract has been created, and choices may now be exercised on it.

Show child attributes

offset · integer (int64) · required

The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required

nodeId · integer (int32) · required

The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required

contractId · string · required

The ID of the created contract. Must be a valid LedgerString (as described in value.proto). Required

templateId · string · required

The template of the created contract. The identifier uses the package-id reference format. Required

contractKey · object

The key of the created contract. This will be set if and only if template_id defines a contract key. Optional

contractKeyHash · string

The hash of contract_key. This will be set if and only if template_id defines a contract key. Optional: can be empty

createArgument · object · required

The arguments that have been used to create the contract. Required

createdEventBlob · string

Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty

interfaceViews · JsInterfaceView[]

Interface views specified in the transaction filter. Includes an InterfaceView for each interface for which there is a InterfaceFilter with - its party in the witness_parties of this event, - and which is implemented by the template of this event, - and which has include_interface_view set. Optional: can be empty

Show child attributes

interfaceId · string · required

The interface implemented by the matched event. The identifier uses the package-id reference format. Required

viewStatus · JsStatus · required

Whether the view was successfully computed, and if not, the reason for the error. The error is reported using the same rules for error codes and messages as the errors returned for API requests. Required

Show child attributes

code · integer (int32) · required

message · string · required

details · ProtoAny[]

Show child attributes

typeUrl · string · required

value · string · required

unknownFields · UnknownFieldSet · required

Show child attributes

fields · Map_Int_Field · required

valueDecoded · string

viewValue · object

The value of the interface’s view method on this event. Set if it was requested in the InterfaceFilter and it could be successfully computed. Optional

implementationPackageId · string

The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional

witnessParties · string[] · required

The parties that are notified of this event. When a CreatedEvent is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the TransactionFilter that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the TransactionFilter that are stakeholders of the contract (i.e. either signatories or observers). If the CreatedEvent is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the TransactionFilter that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the TopologyEvents for that party by setting a corresponding UpdateFormat. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty

signatories · string[] · required

The signatories for this contract as specified by the template. Required: must be non-empty

observers · string[]

The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty

createdAt · string · required

Ledger effective time of the transaction that created the contract. Required

packageName · string · required

The package name of the created contract. Required

representativePackageId · string · required

A package-id present in the participant package store that typechecks the contract’s argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract’s creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required

acsDelta · boolean · required

Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required

Variant 3 · object

Show child attributes

ExercisedEvent · ExercisedEvent · required

Records that a choice has been exercised on a target contract.

Show child attributes

offset · integer (int64) · required

The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required

nodeId · integer (int32) · required

The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required

contractId · string · required

The ID of the target contract. Must be a valid LedgerString (as described in value.proto). Required

templateId · string · required

Identifies the template that defines the executed choice. This template’s package-id may differ from the target contract’s package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required

interfaceId · string

The interface where the choice is defined, if inherited. If defined, the identifier uses the package-id reference format. Optional

choice · string · required

The choice that was exercised on the target contract. Must be a valid NameString (as described in value.proto). Required

choiceArgument · object · required

The argument of the exercised choice. Required

actingParties · string[] · required

The parties that exercised the choice. Each element must be a valid PartyIdString (as described in value.proto). Required: must be non-empty

consuming · boolean · required

If true, the target contract may no longer be exercised. Required

witnessParties · string[] · required

The parties that are notified of this event. The witnesses of an exercise node will depend on whether the exercise was consuming or not. If consuming, the witnesses are the union of the stakeholders, the actors and all informees of all the ancestors of this event this participant knows about. If not consuming, the witnesses are the union of the signatories, the actors and all informees of all the ancestors of this event this participant knows about. In both cases the witnesses are limited to the querying parties, or not limited in case anyParty filters are used. Note that the actors might not necessarily be observers and thus stakeholders. This is the case when the controllers of a choice are specified using “flexible controllers”, using the choice ... controller syntax, and said controllers are not explicitly marked as observers. Each element must be a valid PartyIdString (as described in value.proto). Required: must be non-empty

lastDescendantNodeId · integer (int32) · required

Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of this ExercisedEvent. This allows unambiguous identification of all the members of the subtree rooted at this node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily filtered, it is only possible to determine if a node is in a consequent subtree or not. Required

exerciseResult · object

The result of exercising the choice. Optional

packageName · string · required

The package name of the contract. Required

implementedInterfaces · string[]

If the event is consuming, the interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. The identifier uses the package-id reference format. Optional: can be empty

acsDelta · boolean · required

Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required

offset · integer (int64) · required

The absolute offset. The details of this field are described in community/ledger-api/README.md. It is a valid absolute offset (positive integer). Required

synchronizerId · string · required

A valid synchronizer id. Identifies the synchronizer that synchronized the transaction. Required

traceContext · TraceContext

Ledger API trace context The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead. Optional

Show child attributes

traceparent · string

https://www.w3.org/TR/trace-context/ Optional

tracestate · string

Optional

recordTime · string · required

The time at which the transaction was recorded. The record time refers to the synchronizer which synchronized the transaction. Required

externalTransactionHash · string

For transaction externally signed, contains the external transaction hash signed by the external party. Can be used to correlate an external submission with a committed transaction. Optional: can be empty

paidTrafficCost · integer (int64)

The traffic cost that this participant node paid for the confirmation request for this transaction. Not set for transactions that were - initiated by another participant - initiated offline via the repair service - processed before the participant started serving traffic cost on the Ledger API - returned as part of a query filtering for a non submitting party Optional

400

Invalid value, Invalid value for: body

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Updated3.5

The POST /v2/commands/submit-and-wait-for-transaction operation was updated in this snapshot.

Added3.4