Daml Finance Documentation

Welcome to the Daml Finance documentation. This page provides an overview of the documentation content as well as suggested starting points. Use the left-hand menu to explore the various sections, or the search bar above for quick navigation. If you are missing content from the documentation, have feedback on the library, or need any help using it, do not hesitate to open an issue on the repository.

Content

  • Overview: description of the purpose of the library, its high-level architecture, as well as targeted use cases
  • Concepts: explanation of the main concepts used throughout the library, and how they fit together
  • Packages: documentation for each individual package and its contained modules
  • Tutorials: step-by-step implementation guides across different use cases
  • Reference: glossary as well as code-level documentation for each package

Starting Points

The following is a suggested learning path to get productive quickly:

  1. Get started quickly
  2. Understand the fundamental concepts in depth
  3. Learn how to model different financial instruments
  4. Read up on the background, purpose, and intended usage of the library
  5. Explore the Daml Finance Reference Application

Releases

This section details the list of released packages for each Daml SDK release. It also provides status information for each package according to the Daml Ecosystem convention.

Daml SDK 2.5.0

Stable Packages

Package Version Status
ContingentClaims.Core 1.0.0 Stable
ContingentClaims.Lifecycle 1.0.0 Stable
Daml.Finance.Account 1.0.0 Stable
Daml.Finance.Claims 1.0.0 Stable
Daml.Finance.Data 1.0.0 Stable
Daml.Finance.Holding 1.0.0 Stable
Daml.Finance.Instrument.Generic 1.0.0 Stable
Daml.Finance.Instrument.Token 1.0.0 Stable
Daml.Finance.Interface.Account 1.0.0 Stable
Daml.Finance.Interface.Claims 1.0.0 Stable
Daml.Finance.Interface.Data 1.0.0 Stable
Daml.Finance.Interface.Holding 1.0.0 Stable
Daml.Finance.Interface.Instrument.Base 1.0.0 Stable
Daml.Finance.Interface.Instrument.Generic 1.0.0 Stable
Daml.Finance.Interface.Instrument.Token 1.0.0 Stable
Daml.Finance.Interface.Lifecycle 1.0.0 Stable
Daml.Finance.Interface.Settlement 1.0.0 Stable
Daml.Finance.Interface.Types 1.0.0 Stable
Daml.Finance.Interface.Util 1.0.0 Stable
Daml.Finance.Lifecycle 1.0.0 Stable
Daml.Finance.Settlement 1.0.0 Stable
Daml.Finance.Util 1.0.0 Stable

Early Access Packages

Package Version Status
ContingentClaims.Valuation 0.2.0 Labs
Daml.Finance.Instrument.Bond 0.2.0 Alpha
Daml.Finance.Instrument.Equity 0.2.0 Alpha
Daml.Finance.Instrument.Swap 0.2.0 Alpha
Daml.Finance.Interface.Instrument.Bond 0.2.0 Alpha
Daml.Finance.Interface.Instrument.Equity 0.2.0 Alpha
Daml.Finance.Interface.Instrument.Swap 0.2.0 Alpha

Deprecated Packages

Package Version Status
None