Struct Completion 

pub struct Completion {
    pub command_id: String,
    pub status: Option<Status>,
    pub update_id: String,
    pub user_id: String,
    pub act_as: Vec<String>,
    pub submission_id: String,
    pub trace_context: Option<TraceContext>,
    pub offset: i64,
    pub synchronizer_time: Option<SynchronizerTime>,
    pub paid_traffic_cost: i64,
    pub transaction_hash: Option<Vec<u8>>,
    pub deduplication_period: Option<DeduplicationPeriod>,
}

A completion represents the status of a submitted command on the ledger: it can be successful or failed.

Fields

command_id: String

The ID of the succeeded or failed command. Must be a valid LedgerString (as described in value.proto).

Required

status: Option<Status>

Identifies the exact type of the error. It uses the same format of conveying error details as it is used for the RPC responses of the APIs.

Optional

update_id: String

The update_id of the transaction or reassignment that resulted from the command with command_id.

Only set for successfully executed commands. Must be a valid LedgerString (as described in value.proto).

Optional

user_id: String

The user-id that was used for the submission, as described in commands.proto. Must be a valid UserIdString (as described in value.proto).

Required

act_as: Vec<String>

The set of parties on whose behalf the commands were executed. Contains the act_as parties from commands.proto filtered to the requesting parties in CompletionStreamRequest. The order of the parties need not be the same as in the submission. Each element must be a valid PartyIdString (as described in value.proto).

Required: must be non-empty

submission_id: String

The submission ID this completion refers to, as described in commands.proto. Must be a valid LedgerString (as described in value.proto).

Optional

trace_context: Option<TraceContext>

The Ledger API trace context

The trace context transported in this message corresponds to the trace context supplied by the client application in a HTTP2 header of the original command submission. We typically use a header to transfer this type of information. Here we use message body, because it is used in gRPC streams which do not support per message headers. This field will be populated with the trace context contained in the original submission. If that was not provided, a unique ledger-api-server generated trace context will be used instead.

Optional

offset: i64

May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time. Must be a valid absolute offset (positive integer).

Required

synchronizer_time: Option<SynchronizerTime>

The synchronizer along with its record time. The synchronizer id provided, in case of

• successful/failed transactions: identifies the synchronizer of the transaction
• for successful/failed unassign commands: identifies the source synchronizer
• for successful/failed assign commands: identifies the target synchronizer

Required

paid_traffic_cost: i64

The traffic cost paid by this participant node for the confirmation request for the submitted command.

Commands whose execution is rejected before their corresponding confirmation request is ordered by the synchronizer will report a paid traffic cost of zero. If a confirmation request is ordered for a command, but the request fails (e.g., due to contention with a concurrent contract archival), the traffic cost is paid and reported on the failed completion for the request.

If you want to correlate the traffic cost of a successful completion with the transaction that resulted from the command, you can use the offset field to retrieve the transaction using UpdateService.GetUpdateByOffset on the same participant node; or alternatively use the update_id field to retrieve the transaction using UpdateService.GetUpdateById on any participant node that sees the transaction.

Note: for completions processed before the participant started serving traffic cost on the Ledger API, this field will be set to zero. Additionally, the total cost incurred by the submitting node for the submission of the transaction may be greater than the reported cost, for example if retries were issued due to failed submissions to the synchronizer. The cost reported here is the one paid for ordering the confirmation request.

Optional

transaction_hash: Option<Vec<u8>>

The transaction hash signed by the external party for prepared transactions that were submitted using InteractiveSubmissionService.ExecuteSubmission or one of its variants.

Use this to correlate prepared transactions with their execution result on the same participant that executed the transaction.

Not available for:

• transactions executed on Canton versions prior to 3.5
• transactions of internal parties submitted using CommandSubmissionService.Submit and its variants

Optional: can be empty

deduplication_period: Option<DeduplicationPeriod>

The actual deduplication window used for the submission, which is derived from Commands.deduplication_period. The ledger may convert the deduplication period into other descriptions and extend the period in implementation-specified ways.

Used to audit the deduplication guarantee described in commands.proto.

The deduplication guarantee applies even if the completion omits this field.

Optional

Implementations

impl Completion

pub fn transaction_hash(&self) -> &[u8]

Returns the value of transaction_hash, or the default value if transaction_hash is unset.

Trait Implementations

impl Clone for Completion

fn clone(&self) -> Completion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Completion

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Completion

fn default() -> Completion

Returns the “default value” for a type.

impl Message for Completion

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Completion

fn eq(&self, other: &Completion) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Completion