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

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

Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen.

  • ACS delta: a requesting party must be a stakeholder of an event for it to be included. - ledger effects: a requesting party must be a witness of an event for it to be included.

Back to overview

AsyncAPI Channel

/v2/updates

Read the ledger's filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection c...

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

Read the ledger’s filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen.

  • ACS delta: a requesting party must be a stakeholder of an event for it to be included.
  • ledger effects: a requesting party must be a witness of an event for it to be included.

publish /v2/updates

<p class="x2mdx-ref-card-summary">Publish GetUpdatesRequest messages from the client to /v2/updates.</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>sendV2Updates</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

<p class="x2mdx-ref-card-summary">Receive Either\_JsCantonError\_JsGetUpdatesResponse messages from /v2/updates 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>onV2Updates</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.