Module Daml.Finance.Interface.Settlement.Batch¶
Interfaces¶
interface Batch
An interface for atomically settling a batch of
Instruction\s. The corresponding Instructions are referenced by key.
Choice Archive
(no fields)
Choice Cancel
Cancels the batch.
Field Type Description actors Parties The parties canceling the batch. Choice GetView
Retrieves the interface view.
Field Type Description viewer Party The party retrieving the view. Choice Settle
Settles the batch.
Field Type Description actors Parties The parties settling the batch. Method cancel : Cancel -> Update [ContractId I]
Implementation of the
Cancelchoice.Method settle : Settle -> Update [ContractId I]
Implementation of the
Settlechoice.
Typeclasses¶
class Implementation t => HasImplementation t where
Data Types¶
- type I
= Batch
Type synonym for
Batch.instance HasMethod Factory "instruct" (Instruct -> Update (ContractId I, [ContractId I]))
- type Implementation t
= HasToInterface t I
Type constraint for requiring templates to implement
Batch.
- type V
= View
Type synonym for
View.instance HasFromAnyView Batch V
data View
View for
Batch.
Field Type Description requestors Parties Parties requesting the settlement. settlers Parties Parties that can trigger the final settlement. id Id Batch identifier. description Text Batch description. contextId Optional Id Identifier to link a batch to a context (e.g. the Effectit originated from).routedSteps [RoutedStep] Routed settlement steps. settlementTime Optional Time Settlement time (if any).