digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-20 01:07:18 +03:00
Code Issues Projects Releases Wiki Activity

Update code documentation for participant-state API [KVL-1094] (#10812)

Browse Source 
CHANGELOG_BEGIN
CHANGELOG_END
This commit is contained in:
Miklos 2021-09-08 12:37:54 +02:00 committed by GitHub
parent 60ffb79fb1
commit 9038a8051b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ledger/ledger-configuration/src/main/scala/com/daml/ledger/configuration/Configuration.scala
View File

@ -12,7 +12,7 @@ import scala.util.Try
*
* @param generation The configuration generation. Monotonically increasing.
* @param timeModel The time model of the ledger. Specifying the time-to-live bounds for Ledger API commands.
* @param maxDeduplicationTime The maximum time window during which commands can be deduplicated.
* @param maxDeduplicationTime The maximum time window during which commands can be deduplicated.
*/
final case class Configuration(
generation: Long,

2
ledger/ledger-configuration/src/main/scala/com/daml/ledger/configuration/LedgerInitialConditions.scala
View File

@ -8,7 +8,7 @@ import com.daml.lf.data.Time.Timestamp
/** The initial conditions of the ledger before anything has been committed.
*
* @param ledgerId The static ledger identifier.
* @param config The initial ledger configuration
* @param config The initial ledger configuration.
* @param initialRecordTime The initial record time prior to any update event.
*/
final case class LedgerInitialConditions(

3
ledger/participant-state/src/main/scala/com/daml/ledger/participant/state/v2/CompletionInfo.scala
View File

@ -16,8 +16,7 @@ import com.daml.logging.entries.{LoggingValue, ToLoggingValue}
* application.
* @param optDeduplicationPeriod The deduplication period that the [[WriteService]] actually uses
* for the command submission. It may differ from the suggested
* deduplication period given to [[WriteService.submitTransaction]]
* or [[WriteService.rejectSubmission]].
* deduplication period given to [[WriteService.submitTransaction]].
*
* For example, the suggested deduplication period may have been
* converted into a different kind or extended. The particular choice

4
ledger/participant-state/src/main/scala/com/daml/ledger/participant/state/v2/ReadService.scala
View File

@ -25,7 +25,7 @@ import com.daml.ledger.offset.Offset
trait ReadService extends ReportsHealth {
/** Retrieve the static initial conditions of the ledger, containing
* the ledger identifier and the initial ledger record time.
* the ledger identifier, the ledger config and the initial ledger record time.
*
* Returns a single element Source since the implementation may need to
* first establish connectivity to the underlying ledger. The implementer
@ -99,7 +99,7 @@ trait ReadService extends ReportsHealth {
* The second class of properties relates multiple calls to [[ReadService.stateUpdates]] to each other.
* The class contains two properties:
* (1) a property that enables crash-fault tolerant Ledger API server implementations and
* (2) a property that enables Ledger API server implementations that are synchronized by a backing ledger.
* (2) a property that enables Ledger API server implementations that are synchronized by a backing ledger.
*
* For crash-fault-tolerance, we require an implementation of [[ReadService.stateUpdates]] to support its consumer to
* resume consumption starting after the last offset up to which the consumer completed processing.

4
ledger/participant-state/src/main/scala/com/daml/ledger/participant/state/v2/SubmitterInfo.scala
View File

@ -8,7 +8,7 @@ import com.daml.ledger.configuration.Configuration
import com.daml.lf.data.Ref
import com.daml.logging.entries.{LoggingValue, ToLoggingValue}
/** Collects context information the submission.
/** Collects context information for a submission.
*
* Note that this is used for party-originating changes only. They are usually issued via the
* Ledger API.
@ -25,7 +25,7 @@ import com.daml.logging.entries.{LoggingValue, ToLoggingValue}
* [[ReadService.stateUpdates]].
* @param submissionId An identifier for the submission that allows an application to
* correlate completions to its submissions.
* @param ledgerConfiguration The ledger configuration used during interpretation
* @param ledgerConfiguration The ledger configuration used during interpretation.
*/
final case class SubmitterInfo(
actAs: List[Ref.Party],

3
ledger/participant-state/src/main/scala/com/daml/ledger/participant/state/v2/WriteService.scala
View File

@ -24,9 +24,8 @@ import com.daml.telemetry.TelemetryContext
* plans to make this functionality uniformly available: see the roadmap for
* progress information https://github.com/digital-asset/daml/issues/121.
*
* As of now there are five methods for changing the state of a Daml ledger:
* The following methods are currently available for changing the state of a Daml ledger:
* - submitting a transaction using [[WriteService!.submitTransaction]]
* - recording the rejection of a command submission using [[WriteService!.rejectSubmission]]
* - allocating a new party using [[WritePartyService!.allocateParty]]
* - uploading a new package using [[WritePackagesService!.uploadPackages]]
* - pruning a participant ledger using [[WriteParticipantPruningService!.prune]]