mirror of https://github.com/digital-asset/daml.git synced 2024-09-19 16:57:40 +03:00

History

Moritz Kiefer e09c31899d Connectify user-facing output (#7624 ) Together with #7615, this overs all items in #7612. changelog_begin changelog_end		2020-10-09 15:45:02 +02:00
..
examples	Connectify user-facing output (#7624 )	2020-10-09 15:45:02 +02:00
src/DA	Make Bearer prefix optional in Haskell ledger bindings (#5858 )	2020-05-06 12:09:34 +02:00
test	Split sandbox code into separate packages (#6695 )	2020-07-17 17:06:06 +02:00
BUILD.bazel	replace DAML Authors with DA in copyright headers (#5228 )	2020-03-27 01:26:10 +01:00
export-package.sh	replace DAML Authors with DA in copyright headers (#5228 )	2020-03-27 01:26:10 +01:00
package.yaml	replace DAML Authors with DA in copyright headers (#5228 )	2020-03-27 01:26:10 +01:00
README.md	Use com.daml as root package (#5343 )	2020-04-05 19:49:57 +02:00
stack.yaml	replace DAML Authors with DA in copyright headers (#5228 )	2020-03-27 01:26:10 +01:00

README.md

Usage

There is currently no separate documentation for the haskell ledger bindings, over and above the existing ledger API doc.

The .proto files are the best primary source of truth for the API. The Haskell bindings match closely the names of the services and RPCs, but of course you get much better types.

The entry point is at DA.Ledger.

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 and here.

Using these bindings outside of this repository

Note: These instructions document the current process. We do plan make it simpler!

These bindings can be exported as a standalone Haskell package daml-ledger using stack. Currently, stack references the code directly in the daml repo. The only annoyance is that part of the Haskell code for daml-ledger is generated from .proto files, and this generation step must be performed using the bazel build. We plan to simplify this step by directly providing daml-ledger as a package on hackage. Instructions for working with the daml repo can be found here: https://github.com/digital-asset/daml

As well as stack, the only other prerequisite is to have grpc installed. (grpc is not required to generate the daml-ledger package, but it is required to use it).

We are currently using gRPC version 1.23.0. To install grpc requires building grpc from source (really!). See detailed instructions here: https://github.com/grpc/grpc/blob/master/BUILDING.md.

In the instructions below we do make install for grpc despite the warning from the grpc build instructions:

"WARNING: After installing with make install there is no easy way to uninstall, which can cause issues if you later want to remove the grpc and/or protobuf installation or upgrade to a newer version."

If you decide against the make install, or choose a different install location, you will need to adjust the settings of extra-lib-dirs and extra-include-dirs in your stack.yaml config.

Also, in the instructions below we export the daml-ledger package to /tmp which matches the location declared in the stack.yaml of the example application nim. If you export somewhere else, you will need to adapt your stack.yaml

Download and build grpc at version 1.23.0

git clone -b v1.23.0 https://github.com/grpc/grpc
cd grpc
git submodule update --init
make
make prefix=/usr/local/grpc install

Clone daml repo, and export the daml-ledger package

cd /tmp
git clone https://github.com/digital-asset/daml.git
cd daml
eval $(dev-env/bin/dade-assist)
language-support/hs/bindings/export-package.sh /tmp

Write a DAML Ledger App in Haskell (or copy one!), and build it

cd /tmp
cp -rp /tmp/daml/language-support/hs/bindings/examples/nim nim
cd nim
stack build