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.

viewtype V

  • Choice Archive

    Controller: Signatories of implementing template

    Returns: ()

    (no fields)

  • Choice Cancel

    Cancels the batch.

    Controller: actors

    Returns: [ContractId I]

    Field Type Description
    actors Parties The parties canceling the batch.

  • Choice GetView

    Retrieves the interface view.

    Controller: viewer

    Returns: View

    Field Type Description
    viewer Party The party retrieving the view.

  • Choice Settle

    Settles the batch.

    Controller: actors

    Returns: [ContractId I]

    Field Type Description
    actors Parties The parties settling the batch.

  • Method cancel : Cancel -> Update [ContractId I]

    Implementation of the Cancel choice.

  • Method settle : Settle -> Update [ContractId I]

    Implementation of the Settle choice.

Data Types

type I

= Batch

Type synonym for Batch.

instance HasMethod Factory "instruct" (Instruct -> Update (ContractId I, [ContractId I]))

type V

= View

Type synonym for View.

instance HasFromAnyView Batch V

data View

View for Batch.

View

Field Type Description
instructor Party Party instructing settlement (and the creation of the Batch).
consenters Parties Parties consenting with the creation of the Batch.
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 Effect it originated from).
routedSteps [RoutedStep] Routed settlement steps.
settlementTime Optional Time Settlement time (if any).

instance Eq View

instance Show View