GenerateExternalPartyTopology
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.
GenerateExternalPartyTopology
Ledger API
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/docs/canton/reference-protobuf-index">Protobuf</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="https://docs.canton.network/reference/protobuf/packages/com-daml-ledger-api-v2-admin">com.daml.ledger.api.v2.admin</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>GenerateExternalPartyTopology</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.daml.ledger.api.v2.admin</p>
<h1 class="x2mdx-ref-title">GenerateExternalPartyTopology</h1>
<div class="x2mdx-ref-badges">
<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.0</span>
</div>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--rpc">RPC</span>
<code>/com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology</code>
</div>
## Protocol Details
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Protocol</dt>
<dd>gRPC</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Service</dt>
<dd>PartyManagementService</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>GenerateExternalPartyTopology</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
## Inputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GenerateExternalPartyTopologyRequest</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Client stream</dt>
<dd>No</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer</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\_hint</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">public\_key</code>
<span class="x2mdx-ref-type-badge">SigningPublicKey</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">local\_participant\_observation\_only</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">other\_confirming\_participant\_uids</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">confirmation\_threshold</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">observing\_participant\_uids</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
</div>
</div>
## Outputs
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>GenerateExternalPartyTopologyResponse</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>Message</dt>
<dd>com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>Server stream</dt>
<dd>No</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">party\_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">public\_key\_fingerprint</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">topology\_transactions</code>
<span class="x2mdx-ref-type-badge">repeated bytes</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">multi\_hash</code>
<span class="x2mdx-ref-type-badge">bytes</span>
</div>
</div>
</div>
</div>
## Lifecycle Changes
<div class="x2mdx-ref-change-list">
<div class="x2mdx-ref-change-item">
<span class="x2mdx-ref-change-version">3.4.0</span>
<span class="x2mdx-ref-change-detail">introduced</span>
</div>
</div>
## Related Schemas
<AccordionGroup>
<Accordion title="com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-generateexternalpartytopologyrequest">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">synchronizer</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\_hint</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">public\_key</code>
<span class="x2mdx-ref-type-badge">SigningPublicKey</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">local\_participant\_observation\_only</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">other\_confirming\_participant\_uids</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">confirmation\_threshold</code>
<span class="x2mdx-ref-type-badge">uint32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">observing\_participant\_uids</code>
<span class="x2mdx-ref-type-badge">repeated string</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.SigningPublicKey">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-signingpublickey">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">format</code>
<span class="x2mdx-ref-type-badge">CryptoKeyFormat</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">key\_data</code>
<span class="x2mdx-ref-type-badge">bytes</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">key\_spec</code>
<span class="x2mdx-ref-type-badge">SigningKeySpec</span>
</div>
</div>
</div>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.CryptoKeyFormat">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-cryptokeyformat">
<ul class="x2mdx-ref-enum-list">
<li><code>CRYPTO\_KEY\_FORMAT\_UNSPECIFIED</code></li>
<li><code>CRYPTO\_KEY\_FORMAT\_DER</code></li>
<li><code>CRYPTO\_KEY\_FORMAT\_RAW</code></li>
<li><code>CRYPTO\_KEY\_FORMAT\_DER\_X509\_SUBJECT\_PUBLIC\_KEY\_INFO</code></li>
</ul>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.SigningKeySpec">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-signingkeyspec">
<ul class="x2mdx-ref-enum-list">
<li><code>SIGNING\_KEY\_SPEC\_UNSPECIFIED</code></li>
<li><code>SIGNING\_KEY\_SPEC\_EC\_CURVE25519</code></li>
<li><code>SIGNING\_KEY\_SPEC\_EC\_P256</code></li>
<li><code>SIGNING\_KEY\_SPEC\_EC\_P384</code></li>
<li><code>SIGNING\_KEY\_SPEC\_EC\_SECP256K1</code></li>
</ul>
</div>
</Accordion>
<Accordion title="com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse">
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-admin-generateexternalpartytopologyresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">party\_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">public\_key\_fingerprint</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">topology\_transactions</code>
<span class="x2mdx-ref-type-badge">repeated bytes</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">multi\_hash</code>
<span class="x2mdx-ref-type-badge">bytes</span>
</div>
</div>
</div>
</div>
</Accordion>
</AccordionGroup>
grpcurl
```bash grpcurl theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Add -plaintext if the server is not using TLS.
grpcurl \
-d @ \
<HOST:PORT> \
com.daml.ledger.api.v2.admin.PartyManagementService/GenerateExternalPartyTopology <<'EOF'
{
"synchronizer": "string",
"partyHint": "string",
"publicKey": {
"format": "CRYPTO_KEY_FORMAT_UNSPECIFIED",
"keyData": "BASE64_ENCODED_BYTES",
"keySpec": "SIGNING_KEY_SPEC_UNSPECIFIED"
},
"localParticipantObservationOnly": true,
"otherConfirmingParticipantUids": [
"string"
],
"confirmationThreshold": 0,
"observingParticipantUids": [
"string"
]
}
EOF
```
</div>
</div>
<div className="x2mdx-ref-rail-panel">
<div className="x2mdx-ref-rail-code x2mdx-ref-rail-code--response">
<div className="x2mdx-ref-rail-head">
<span className="x2mdx-ref-rail-heading">OK</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json OK theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"partyId": "string",
"publicKeyFingerprint": "string",
"topologyTransactions": [
"BASE64_ENCODED_BYTES"
],
"multiHash": "BASE64_ENCODED_BYTES"
}
```
</div>
</div>Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.