Module Daml.Finance.Interface.Settlement.Instruction

Interfaces

interface Instruction

An interface for providing a single instruction to transfer an asset.

  • Choice Allocate

    Allocates this instruction and optionally returns a previously allocated (mutated) asset.

    Field Type Description
    actors Parties The parties allocating the instruction.
    allocation Allocation Allocation of an instruction.

  • Choice Approve

    Approves this instruction.

    Field Type Description
    actors Parties The parties approving the instruction.
    approval Approval Approval of an instruction.

  • Choice Archive

    (no fields)

  • Choice Cancel

    Cancels this instruction.

    Field Type Description
    actors Parties The parties canceling the instruction.

  • Choice Execute

    Executes this instruction.

    Field Type Description
    actors Parties The parties executing the instruction.

  • Choice GetView

    Retrieves the interface view.

    Field Type Description
    viewer Party The party retrieving the view.

  • Method allocate : Allocate -> Update (ContractId Instruction, Optional (ContractId I))

    Implementation of the Allocate choice.

  • Method approve : Approve -> Update (ContractId Instruction)

    Implementation of the Approve choice.

  • Method asDisclosure : I

    Conversion to Disclosure interface.

  • Method cancel : Cancel -> Update (Optional (ContractId I))

    Implementation of the Cancel choice.

  • Method execute : Execute -> Update (Optional (ContractId I))

    Implementation of the Execute choice.

Typeclasses

class Implementation t => HasImplementation t where

Data Types

type I

= Instruction

Type synonym for Instruction.

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

type Implementation t

= (HasToInterface t I, Implementation t)

Type constraint for requiring templates to implement Instruction along with Disclosure.

type V

= View

Type synonym for View.

instance HasFromAnyView Instruction V

data View

View for Instruction.

View

Field Type Description
requestors Parties Parties that instructed settlement.
settlers Parties Parties that can execute the Instruction.
batchId Id Batch identifier.
id Id Instruction identifier.
routedStep RoutedStep Instruction details to execute.
settlementTime Optional Time Settlement time (if any).
allocation Allocation Allocation from the sender.
approval Approval Approval from the receiver.
signedSenders Parties Additional signatories, used to collect authorization (on sending side).
signedReceivers Parties Additional signatories, used to collect authorization (on receiving side).

instance Eq View

instance Show View