Canton developer docs / Reference

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

阅读中文版

referenceprotobufindex

Details and History

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.

Details and History

Descriptor-backed protobuf API history grouped by package.

Protobuf Reference

Details and History

Operation-first gRPC pages with package-level browsing and recursive related schema sections.

Protobuf 
<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">v3.5.1</span>
Source
Canton protobuf trees from published release bundles
<div class="x2mdx-ref-meta-item">
  <dt>Version filter</dt>
  <dd>stable Canton release bundles >= 3.2.0</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Latest release</dt>
  <dd>v3.5.1</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Packages</dt>
  <dd>5</dd>
</div>

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

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

Release Summary

Counts are shown as added / changed / removed within each release slice.

3.4.0

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.2

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.3

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.4

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.5

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.6

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.7

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.8

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.9

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.10

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.4.11

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

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

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

3.5.1

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">Release</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">Endpoint / message / enum deltas for this release.</p>

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

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>8 / 32 / 0</dd>
  </div>

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

Ledger API

com.daml.ledger.api.v2

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">9 services, 22 endpoints, 120 messages, 8 enums</p>

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

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

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

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

com.daml.ledger.api.v2.admin

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">6 services, 28 endpoints, 79 messages, 3 enums</p>

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

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

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

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

com.daml.ledger.api.v2.interactive

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 6 endpoints, 29 messages, 1 enums</p>

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

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

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

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

com.daml.ledger.api.v2.testing

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">1 services, 2 endpoints, 3 messages</p>

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

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

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

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

Schema Packages

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

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">0 services, 0 endpoints, 6 messages</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>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>
</dl>

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