Canton developer docs / Reference

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

阅读中文版

referencejson-api-asyncapi-referenceoperationsv2-updates-flats

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

Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.

Back to overview

AsyncAPI Channel

/v2/updates/flats

Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.

WebSocket 
<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 3.5</span>
Channel
/v2/updates/flats
<div class="x2mdx-ref-meta-item">
  <dt>Actions</dt>
  <dd>publish, subscribe</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Introduced</dt>
  <dd>3.4</dd>
</div>

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

Actions

Get flat transactions update stream. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead.

publish /v2/updates/flats

<p class="x2mdx-ref-card-summary">Publish GetUpdatesRequest messages from the client to /v2/updates/flats.</p>

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

  <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4</span>

  <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 3.5</span>
</div>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Operation ID</dt>
    <dd>sendV2UpdatesFlats</dd>
  </div>

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

  <div class="x2mdx-ref-meta-item">
    <dt>Payload</dt>
    <dd>object</dd>
  </div>
</dl>

subscribe /v2/updates/flats

<p class="x2mdx-ref-card-summary">Receive Either\_JsCantonError\_JsGetUpdatesResponse messages from /v2/updates/flats on the subscription stream.</p>

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

  <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4</span>

  <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">Changed 3.5</span>
</div>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Operation ID</dt>
    <dd>onV2UpdatesFlats</dd>
  </div>

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

  <div class="x2mdx-ref-meta-item">
    <dt>Payload</dt>
    <dd>oneOf</dd>
  </div>
</dl>

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