Getting Started

Quickstart

This section explains how some key concepts of Daml Finance work in practice. It combines a step by step description of different workflows with supporting code.

To follow the tutorials, you can install the quickstart-finance project via the Daml assistant by executing the following commands -

On Unix-based systems execute:

daml new quickstart-finance --template=quickstart-finance
cd quickstart-finance
./get-dependencies.sh
daml studio

On Windows-based systems execute:

daml new quickstart-finance --template=quickstart-finance
cd quickstart-finance
get-dependencies.bat
daml studio

Reference App

In addition to Daml Finance, there is also a separate Daml Finance Reference App. It showcases several of the Daml Finance capabilites in a web-based graphical user interface.

If you are interested in trying out the app locally, you can clone the corresponding repo and follow the installation instructions on the Daml Finance Reference App GitHub page.

Create your own App

If you want to create a JavaScript app that uses Daml Finance, it is possible to generate JavaScript code from the Daml Finance packages you need. Simply run daml codegen js, for example:

daml codegen js -o ./output daml-finance-interface-swap-0.1.7.dar daml-finance-interface-instrument-bond-0.1.7.dar

Alternatively, if your app uses Java, you can run daml codegen java in a similar way:

daml codegen java -o ./output daml-finance-interface-swap-0.1.7.dar daml-finance-interface-instrument-bond-0.1.7.dar

Note, this Daml Finance codegen is only supported on SDK versions 2.5.x and higher.

Next Steps

The following tutorials are available:

• Transfer: describes accounts, cash instrument, deposits and transfers.
• Settlement: explains how to execute multiple asset movements atomically.
• Lifecycling: describes how lifecycle rules and events can be used to evolve instruments over time.