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
f899a3e19c
daml/ledger-api
History
Stefano Baghino d3899368ff
Document offset inclusivity and exclusivity in Protobuf (#8145) 
* Document offset inclusivity and exclusivity in Protobuf

As brought up in https://discuss.daml.com/t/using-offsets/1731, the
inclusivity and exclusivity of start and end offsets as exposed by
the Ledger API is not well documented.

This commit clearly states which offset is inclusive and which is
exclusive on all relevant endpoints (command completion and
transaction services).

changelog_begin
changelog_end

* Address https://github.com/digital-asset/daml/pull/8145#pullrequestreview-543758867
2020-12-03 16:00:50 +01:00
..
grpc-definitions Document offset inclusivity and exclusivity in Protobuf (#8145) 2020-12-03 16:00:50 +01:00
perf-testing disable warts.Any and remove most suppressions (#6132) 2020-05-28 16:53:41 +00:00
rs-grpc-akka Ledger: revert time change from #7430 (#7541) 2020-10-02 12:25:26 +02:00
rs-grpc-bridge rs-grpc-bridge-test-lib: remove unneeded deps (#7435) 2020-09-18 13:25:05 +02:00
rs-grpc-testing-utils remove unused definitions, params, args from ledger API Scala code (#6985) 2020-08-04 18:02:19 +00:00
sample-service remove unused definitions, params, args from ledger API Scala code (#6985) 2020-08-04 18:02:19 +00:00
scripts open-sourcing daml 2019-04-04 09:33:38 +01:00
testing-utils [DPP-84] Employ parallel unnesting instead of batching on PostgreSQL (#8042) 2020-12-01 12:06:36 +00:00
.gitignore open-sourcing daml 2019-04-04 09:33:38 +01:00
.sbtopts open-sourcing daml 2019-04-04 09:33:38 +01:00
BUILD.bazel API version service [KVL-541] (#7792) 2020-10-27 17:47:44 +01:00
README.md correct broken ledger-api-introduction links (#1565) 2019-06-07 15:18:21 -04:00
VERSION API version service [KVL-541] (#7792) 2020-10-27 17:47:44 +01:00

README.md

Ledger-API

This is the API code for the ledger, which contains:

  • gRPC API definitions
  • Generated Scala bindings
  • gRPC-RS bridge
  • gRPC-Akka bridge
  • Server API classes with validation
  • Prototype Server
  • Prototype Clients
    • Scala
    • Python
    • Node.js
  • Integration tests for all of the above

Documentation

The Ledger API Introduction contains introductory material as well as links to the protodocs reference documentation.

See the docs README for more about how to preview and publish documentation.