Canton developer docs / Reference

Complete documentation page mirrored and translated for learning. Attribution is shown at the bottom of each article.

阅读中文版

referencegrpc-ledger-api-referencecom-daml-ledger-api-v2-interactive-transaction-v1

v2.interactive.transaction.v1

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.

v2.interactive.transaction.v1

Package-level overview for com.daml.ledger.api.v2.interactive.transaction.v1.

Back to overview

Protobuf Package

v2.interactive.transaction.v1

0 services, 0 endpoints, 6 messages

gRPC
Files
1
<div class="x2mdx-ref-meta-item">
  <dt>Services</dt>
  <dd>0</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Endpoints</dt>
  <dd>0</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Messages</dt>
  <dd>6</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Enums</dt>
  <dd>0</dd>
</div>

Source Files

interactive\_submission\_data.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>6</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive_submission_data.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/interactive/transaction/v1/interactive\_submission\_data.proto</a></dd>
  </div>
</dl>

Type Inventory

These are the package-level message and enum shapes in the publish-version snapshot.

Create

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 8 fields</p>
lf\_version string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">template\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">argument</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signatories</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">stakeholders</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key</code>
    <span class="x2mdx-ref-type-badge">GlobalKeyWithMaintainers</span>
  </div>
</div>

Identifier

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 3 fields</p>
package\_id string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">module\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">entity\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

Value

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 16 fields</p>
unit Empty 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">bool</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">int64</code>
    <span class="x2mdx-ref-type-badge">sint64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">date</code>
    <span class="x2mdx-ref-type-badge">int32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">timestamp</code>
    <span class="x2mdx-ref-type-badge">sfixed64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">numeric</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">party</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">text</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">optional</code>
    <span class="x2mdx-ref-type-badge">Optional</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">list</code>
    <span class="x2mdx-ref-type-badge">List</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">text\_map</code>
    <span class="x2mdx-ref-type-badge">TextMap</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">gen\_map</code>
    <span class="x2mdx-ref-type-badge">GenMap</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">record</code>
    <span class="x2mdx-ref-type-badge">Record</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">variant</code>
    <span class="x2mdx-ref-type-badge">Variant</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">enum</code>
    <span class="x2mdx-ref-type-badge">Enum</span>
  </div>
</div>

Optional

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
value Value

List

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
elements repeated Value

TextMap

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
entries repeated Entry

TextMap.Entry

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
key string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

GenMap

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
entries repeated Entry

GenMap.Entry

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
key Value 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Record

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
record\_id Identifier 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">fields</code>
    <span class="x2mdx-ref-type-badge">repeated RecordField</span>
  </div>
</div>

RecordField

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
label string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Variant

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 3 fields</p>
variant\_id Identifier 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">constructor</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Enum

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
enum\_id Identifier 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">constructor</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

GlobalKeyWithMaintainers

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive · 2 fields</p>
key GlobalKey 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">maintainers</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

GlobalKey

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive · 4 fields</p>
template\_id Identifier 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">hash</code>
    <span class="x2mdx-ref-type-badge">bytes</span>
  </div>
</div>

Exercise

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 16 fields</p>
lf\_version string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">template\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signatories</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">stakeholders</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">acting\_parties</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">interface\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">chosen\_value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">consuming</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">children</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exercise\_result</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice\_observers</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key</code>
    <span class="x2mdx-ref-type-badge">GlobalKeyWithMaintainers</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">by\_key</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

Fetch

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 10 fields</p>
lf\_version string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">template\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signatories</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">stakeholders</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">acting\_parties</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">interface\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key</code>
    <span class="x2mdx-ref-type-badge">GlobalKeyWithMaintainers</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">by\_key</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

Node

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 5 fields</p>
create Create 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">fetch</code>
    <span class="x2mdx-ref-type-badge">Fetch</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exercise</code>
    <span class="x2mdx-ref-type-badge">Exercise</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">rollback</code>
    <span class="x2mdx-ref-type-badge">Rollback</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">query\_by\_key</code>
    <span class="x2mdx-ref-type-badge">QueryByKey</span>
  </div>
</div>

Rollback

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 1 fields</p>
children repeated string

QueryByKey

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.interactive.transaction.v1 · 6 fields</p>
lf\_version string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">template\_id</code>
    <span class="x2mdx-ref-type-badge">Identifier</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exhaustive</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key</code>
    <span class="x2mdx-ref-type-badge">GlobalKeyWithMaintainers</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">result</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.