Client side API implementation for a DAML based ledgers. This library implements the JSON API for a DAML ledger.
Comprehensive documentation for
@daml/ledger can be found
We recommend to use the React framework and the
@daml/react library to
take a look at the source of
@daml/react and it's usage of the
The main export of
@daml/ledger is the
Ledger class. It's constructor takes an authentication
token used to communicate with the JSON API, an HTTP
base URL and a websocket base URL.
An instance of the
Ledger class provides the following methods to communicate with a DAML ledger.
Please consult the documentation
for their exact signatures.
Create a new contract of the given template with given arguments.
Archive a contract identified by its contract id.
Archive a contract identified by its contract key.
Exercise a choice on a contract identified by its contract id.
Exercise a choice on a contract identified by its contract key.
Retrieve contracts for a given template matching a given query. If no query is given, all contracts of that template visible for the submitting party are returned.
Retrieve a consolidated stream of events for a given template and query. The accumulated state is
the current set of active contracts matching the query. An event can be a
CreateEvent or an
ArchiveEvent. When no
query argument is given, all events visible to the submitting party are
Fetch a contract identified by its contract id.
Fetch a contract identified by its contract key.
Retrieve a consolidated stream of
CreateEvent's for a given template and contract key.
Generated using TypeDoc