record Nick's comments on hs ledger bindings #2340
+22
−1
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,27 @@ | ||
| # Usage | ||
|
|
||
| There is currently no separate documentation for the haskell ledger bindings, | ||
| over and above the existing ledger API doc. | ||
|
|
||
| The [.proto files](/ledger-api/grpc-definitions/com/digitalasset/ledger/api/v1) | ||
| are the best primary source of truth for the API. The [Haskell | ||
| bindings](/language-support/hs/bindings/src/DA/Ledger/Services) match closely | ||
| the names of the services and RPCs, but of course you get much better | ||
| [types](/language-support/hs/bindings/src/DA/Ledger/Types.hs). | ||
|
|
||
| The entry point is at [DA.Ledger](/language-support/hs/bindings/src/DA/Ledger.hs). | ||
|
|
||
| To use the bindings **in this repo**, you need the following `BUILD` dep: | ||
| ``` | ||
| "//language-support/hs/bindings:hs-ledger", | ||
| ``` | ||
| And then you can import the `DA.Ledger` module in your Haskell code. | ||
|
|
||
| You can find some usage examples | ||
| [here](/language-support/hs/bindings/test/DA/Ledger/Tests.hs) and | ||
| [here](/language-support/hs/bindings/examples/chat/src/DA/Chat/ChatLedger.hs). | ||
|
There was a problem hiding this comment. This link is broken for me There was a problem hiding this comment. It should be There was a problem hiding this comment. Thanks for catching this! There was a problem hiding this comment. Fixed in #2349. |
||
|
|
||
| Using these bindings **outside of this repository** can be a bit | ||
| tricky since there are quite a few packages required that are not | ||
| published to Hackage at the moment. | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make the
in this repopart bold and maybe point out explicitly that this is only for this repo since I don’t expect that most people will use it in the repo.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I've also switched the order, which I believe reads better as a logical sequence: how the code is structured, how to use in repo, how to use out of repo. (As opposed to previous commit which had how to use outside, how code is structured, how to use inside.)