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-state-active-contracts

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

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client SHOULD begin streaming updates from the update service, starting at the GetActiveContractsRequest.active_at_offset specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.

Back to overview

AsyncAPI Channel

/v2/state/active-contracts

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client...

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/state/active-contracts
<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

Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client SHOULD begin streaming updates from the update service, starting at the GetActiveContractsRequest.active_at_offset specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.

publish /v2/state/active-contracts

<p class="x2mdx-ref-card-summary">Publish GetActiveContractsRequest messages from the client to /v2/state/active-contracts.</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>sendV2StateActive-contracts</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/state/active-contracts

<p class="x2mdx-ref-card-summary">Receive Either\_JsCantonError\_JsGetActiveContractsResponse messages from /v2/state/active-contracts 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>onV2StateActive-contracts</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.