Skip to content

Commit

Permalink
Improvements to wording in ledger-api protobuf docs (digital-asset#10851
Browse files Browse the repository at this point in the history
)

CHANGELOG_BEGIN
CHANGELOG_END
  • Loading branch information
miklos-da authored Sep 13, 2021
1 parent cff0358 commit 7c47aca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ message Commands {
// Uniquely identifies the command.
// The triple (application_id, party + act_as, command_id) constitutes the change ID for the intended ledger change,
// where party + act_as is interpreted as a set of party names.
// The change ID can be used for matching the intended ledger changes with their respective completions.
// The change ID can be used for matching the intended ledger changes with all their completions.
// Must be a valid LedgerString (as described in ``value.proto``).
// Required
string command_id = 4;
Expand All @@ -58,7 +58,8 @@ message Commands {
repeated Command commands = 8;

// Specifies the deduplication period for the change ID.
// If omitted, the participant chooses a deduplication period at its discretion.
// If omitted, the participant will assume the configured maximum deduplication time (see
// ``ledger_configuration_service.proto``).
oneof deduplication_period {
// Specifies the length of the deduplication period.
// Same semantics apply as for `deduplication_duration`.
Expand All @@ -68,8 +69,6 @@ message Commands {

// Specifies the length of the deduplication period.
// It is interpreted relative to the local clock at some point during the submission's processing.
// If omitted, the participant will assume the configured maximum deduplication time (see
// ``ledger_configuration_service.proto``).
//
// Must be non-negative.
google.protobuf.Duration deduplication_duration = 15;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ message LedgerConfiguration {
// ledger effective time and maximum record time of transactions.
LedgerTimeModel time_model = 3;

// The maximum value for the ``deduplication_duration`` parameter of command submissions
// The default value for the ``deduplication_duration`` parameter of command submissions
// (as described in ``commands.proto``). This defines the maximum time window during which
// commands can be deduplicated.
// commands SHOULD be deduplicated.
google.protobuf.Duration max_deduplication_time = 4;
}

Expand All @@ -48,7 +48,7 @@ message LedgerTimeModel {
// being assigned a record time.
google.protobuf.Duration avg_transaction_latency = 4;

// The minimimum skew between ledger time and record time: lt_TX >= rt_TX - minSkew
// The minimum skew between ledger time and record time: lt_TX >= rt_TX - minSkew
google.protobuf.Duration min_skew = 5;

// The maximum skew between ledger time and record time: lt_TX <= rt_TX + maxSkew
Expand Down

0 comments on commit 7c47aca

Please sign in to comment.