Extending Daml Finance¶
Daml Finance is designed to be extended whenever the provided implementations do not satisfy the requirements at hand. In principle, all interfaces in the interface layer can be implemented with custom implementations. Specific extension points we expect and encourage users to customize are explained below.
Note that for all of the listed extension points, we are happy to receive external contributions to be included in the library.
Custom Holding Implementations¶
Daml Finance provides default implementations for fungible, non-fungible, and non-transferable holdings. The transferability of transferable holdings can be flexibly controlled through the controllers property on an Account. Some use cases, however, might require additional functionality on holding contracts:
- Restricted transferability: a custom implementation of the Transferable interface can enforce additional conditions (e.g. the presence of some contract) required to transfer a holding.
- Fixed divisibility: a custom implementation of the Fungible interface can enforce specific requirements regarding the divisibility of a holding.
- Additional information: a custom implementation of a holding can provide additional information, for example, the timestamp of when the holding was obtained. This can be used to implement features that depend on the time a particular asset has been held (e.g. holding fees, interest, etc.).
Note that any custom holding implementation will still allow you to leverage other parts of the library (e.g. lifecycling or settlement) as those are implemented against the respective interfaces. You will need to provide an implementation of the Holding Factory interface for your implementation to be usable throughout the library.
Custom Account Implementations¶
The default account implementation in Daml Finance allows you to define authorization requirements for incoming and outgoing transfers through the controllers property. For some cases, however, a custom account implementation may be warranted:
- Restricted credit and debit: a custom implementation of the
Creditand / or
Debitchoices on the Account interface can place additional restrictions on those actions that can depend, for example, on the presence of a separate know-your-customer (KYC) contract.
- Additional information: a custom account implementation can serve to represent different concepts of accounts. For example, a shelf in a vault for gold bars or a specific location within a warehouse can be represented by providing additional information on an account implementation.
Custom Instrument Implementations¶
Daml Finance provides default implementations for a wide range of financial instruments. However, we anticipate that specific requirements will lead to the adaptation of existing, or the creation of entirely new instrument types. The following are typical examples of when a custom instrument implementation is required:
- Additional information: a custom instrument implementation might, for example, build upon the Equity interface to provide additional information pertinent to private equity (like share class, or liquidation preference).
- New instrument types: if Daml Finance does not provide an implementation for a given instrument type, a custom implementation can be provided to fill that gap. The implementation can either leverage the Contingent Claims framework, as described in this tutorial, or be implemented through standard interfaces, as seen in the implementation of the Equity instrument.
Custom Lifecycle Implementations¶
Daml Finance provides a default set of lifecycle rules that can be used to evolve instruments. Examples are the implementation of Distributions, Replacements, or the time-based evolution of contingent-claims based instruments. There are many more lifecycle events and rules that can be implemented using the provided interfaces. Typically, implementations of the Event and Rule interface are required to handle new lifecycle events. Examples of events where a library extension might be warranted include:
- Credit events on bonds: our bond implementations don’t provide an implementation for handling default events, as these are highly case-specific. A custom lifecycle event and rule implementation can provide the logic to handle the treatment of bond positions in case of default.
- Special corporate actions: a distribution that is either restricted to, or dependent on certain conditions can be implemented through a custom lifecycle implementation.
- Custom evolution logic: a non-fungible token following a specific evolution logic (i.e., it can be evolved under certain circumstances) can be implemented using custom lifecycle events and rules.
Custom Settlement Implementations¶
Daml Finance aims to provide a flexible and powerful mechanism to orchestrate asset settlement. There are cases, however, where a custom implementation might be required:
- Off-ledger integrations: specific information might be required to facilitate handling of settlement instructions in off-ledger rails. This could include, for example, information required to create SWIFT messages.
- Cross-ledger settlement: mechanisms like Hashed Timelock Contracts or custodial-bridged settlement might require a custom implementation of the settlement choices.