curl --request POST \
  --url 'http://localhost:7575/v2/interactive-submission/prepare' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"userId":"string","commandId":"string","commands":[{}],"minLedgerTime":{"time":{}},"actAs":["string"],"readAs":["string"],"disclosedContracts":[{}],"synchronizerId":"string","packageIdSelectionPreference":["string"],"verboseHashing":false,"prefetchContractKeys":[{}],"maxRecordTime":"string","estimateTrafficCost":{"disabled":false,"expectedSignatures":["SIGNING_ALGORITHM_SPEC_UNSPECIFIED"]},"tapsMaxPasses":0,"hashingSchemeVersion":"HASHING_SCHEME_VERSION_UNSPECIFIED"}'

{
  "preparedTransaction": "string",
  "preparedTransactionHash": "string",
  "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED",
  "hashingDetails": "string",
  "costEstimation": {
    "estimationTimestamp": "string",
    "confirmationRequestTrafficCostEstimation": 0,
    "confirmationResponseTrafficCostEstimation": 0,
    "totalTrafficCostEstimation": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

POST

interactive-submission

prepare

curl --request POST \
  --url 'http://localhost:7575/v2/interactive-submission/prepare' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"userId":"string","commandId":"string","commands":[{}],"minLedgerTime":{"time":{}},"actAs":["string"],"readAs":["string"],"disclosedContracts":[{}],"synchronizerId":"string","packageIdSelectionPreference":["string"],"verboseHashing":false,"prefetchContractKeys":[{}],"maxRecordTime":"string","estimateTrafficCost":{"disabled":false,"expectedSignatures":["SIGNING_ALGORITHM_SPEC_UNSPECIFIED"]},"tapsMaxPasses":0,"hashingSchemeVersion":"HASHING_SCHEME_VERSION_UNSPECIFIED"}'

{
  "preparedTransaction": "string",
  "preparedTransactionHash": "string",
  "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED",
  "hashingDetails": "string",
  "costEstimation": {
    "estimationTimestamp": "string",
    "confirmationRequestTrafficCostEstimation": 0,
    "confirmationResponseTrafficCostEstimation": 0,
    "totalTrafficCostEstimation": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

JSON Ledger API

Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

OpenAPISince 3.4Changed 3.5

Requires readAs scope for the submitting party when LAPI User authorization is enabled

Protocol Details

Operation IDpostV2Interactive-submissionPrepare

AuthenticationBearer token

Published3.5

Inputs

Request body

application/json

string

Uniquely identifies the participant user that prepares the transaction. 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

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

object[]

required

OpenAPI type: Command[].Individual elements of this atomic command. Must be non-empty. Limitation: Only single command transaction are currently supported by the API. The field is marked as repeated in preparation for future support of multiple commands. Required: must be non-empty

object

OpenAPI type: MinLedgerTime.

string[]

required

Set of parties on whose behalf the command should be executed, if submitted. If ledger API authorization is enabled, then the authorization metadata must authorize the sender of the request to read (not act) on behalf of each of the given parties. This is because this RPC merely prepares a transaction and does not execute it. Therefore read authorization is sufficient even for actAs parties. Note: This may change, and more specific authorization scope may be introduced in the future. Each element must be a valid PartyIdString (as described in value.proto). Required: must be non-empty

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 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

object[]

OpenAPI type: DisclosedContract[].Additional contracts used to resolve contract & contract key lookups. Optional: can be empty

string

Must be a valid synchronizer id If not set, a suitable synchronizer that this node is connected to will be chosen Optional

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

boolean

When true, the response will contain additional details on how the transaction was encoded and hashed This can be useful for troubleshooting of hash mismatches. Should only be used for debugging. Defaults to false Optional

object[]

OpenAPI type: PrefetchContractKey[].Fetches the contract keys into the caches to speed up the command processing. Should only contain contract keys that are expected to be resolved during interpretation of the commands. Keys of disclosed contracts do not need prefetching. Optional: can be empty

string

Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the PrepareSubmissionResponse. If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again with a new valid max_record_time. Use this to limit the time-to-life of a prepared transaction, which is useful to know when it can definitely not be accepted anymore and resorting to preparing another transaction for the same intent is safe again. Optional

object

OpenAPI type: CostEstimationHints.Hints to improve cost estimation precision of a prepared transaction

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

string

The hashing scheme version to be used when building the hash. Defaults to HASHING_SCHEME_VERSION_V2. Optional

Outputs

200

application/json

string

required

The interpreted transaction, it represents the ledger changes necessary to execute the commands specified in the request. Clients MUST display the content of the transaction to the user for them to validate before signing the hash if the preparing participant is not trusted. Required

string

required

Hash of the transaction, this is what needs to be signed by the party to authorize the transaction. Only provided for convenience, clients MUST recompute the hash from the raw transaction if the preparing participant is not trusted. May be removed in future versions Required: must be non-empty

string

required

The hashing scheme version used when building the hash Required

string

Optional additional details on how the transaction was encoded and hashed. Only set if verbose_hashing = true in the request Note that there are no guarantees on the stability of the format or content of this field. Its content should NOT be parsed and should only be used for troubleshooting purposes. Optional

CostEstimation

Estimation of the cost of submitting the prepared transaction The estimation is done against the synchronizer chosen during preparation of the transaction (or the one explicitly requested). The cost of re-assigning contracts to another synchronizer when necessary is not included in the estimation.

400

text/plain

string

required

default

application/json

string

required

string

required

string

Map_String

required

Tuple2_String_String[]

integer (int32)

required

integer (int32)

string

boolean

History

Changed3.5

The POST /v2/interactive-submission/prepare operation changed in this snapshot.

Introduced3.4

curl --request POST \
  --url 'http://localhost:7575/v2/interactive-submission/prepare' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"userId":"string","commandId":"string","commands":[{}],"minLedgerTime":{"time":{}},"actAs":["string"],"readAs":["string"],"disclosedContracts":[{}],"synchronizerId":"string","packageIdSelectionPreference":["string"],"verboseHashing":false,"prefetchContractKeys":[{}],"maxRecordTime":"string","estimateTrafficCost":{"disabled":false,"expectedSignatures":["SIGNING_ALGORITHM_SPEC_UNSPECIFIED"]},"tapsMaxPasses":0,"hashingSchemeVersion":"HASHING_SCHEME_VERSION_UNSPECIFIED"}'

{
  "preparedTransaction": "string",
  "preparedTransactionHash": "string",
  "hashingSchemeVersion": "HASHING_SCHEME_VERSION_UNSPECIFIED",
  "hashingDetails": "string",
  "costEstimation": {
    "estimationTimestamp": "string",
    "confirmationRequestTrafficCostEstimation": 0,
    "confirmationResponseTrafficCostEstimation": 0,
    "totalTrafficCostEstimation": 0
  }
}

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

⌘I

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

Protocol Details

Inputs

Request body

Outputs

200

400

default

History

​Requires readAs scope for the submitting party when LAPI User authorization is enabled

​Protocol Details

​Inputs

​Request body

​Outputs

​200

​400

​default

​History

Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

Protocol Details

Inputs

Request body

Outputs

200

400

default

History