POST /v2/parties/external/generate-topology

You may use this endpoint to generate the common external topology transactions which can be signed externally and uploaded as part of the allocate party process

Note that this request will create a normal namespace using the same key for the identity as for signing. More elaborate schemes such as multi-signature or decentralized parties require you to construct the topology transactions yourself.

post/v2/parties/external/generate-topology

Request body

synchronizerstring required

Synchronizer-id for which we are building this request.

Required

partyHintstring required

The actual party id will be constructed from this hint and a fingerprint of the public key

Required

localParticipantObservationOnlyboolean

If true, then the local participant will only be observing, not confirming. Default false.

Optional

otherConfirmingParticipantUidsstring[]

Other participant ids which should be confirming for this party

Optional: can be empty

confirmationThresholdinteger

Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0).

Optional

observingParticipantUidsstring[]

Other observing participant ids for this party

Optional: can be empty

Example request

{
  "publicKey": {
    "format": "CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO",
    "keySpec": "SIGNING_KEY_SPEC_EC_CURVE25519"
  }
}

Response

partyIdstring required

The generated party id

Required

publicKeyFingerprintstring required

The fingerprint of the supplied public key

Required

topologyTransactionsstring[] required

The serialized topology transactions which need to be signed and submitted as part of the allocate party process Note that the serialization includes the versioning information. Therefore, the transaction here is serialized as an UntypedVersionedMessage which in turn contains the serialized TopologyTransaction in the version supported by the synchronizer.

Required: must be non-empty

multiHashstring required

the multi-hash which may be signed instead of each individual transaction

Required: must be non-empty

Changes

No recorded changes to this endpoint across all 1 revision of this API.