interface Claim

Interface for contracts that allow holders to claim an Effect and generate SettlementInstruction\s.

viewtype V

  • Choice Archive

    Controller: Signatories of implementing template

    Returns: ()

    (no fields)

  • Choice ClaimEffect

    Claim an effect and generate corresponding settlement instructions.

    Controller: claimer

    Returns: ClaimResult

    Field Type Description
    claimer Party The party claiming the effect.
    holdingCids [ContractId I] The holdings to process.
    effectCid ContractId I The effect to process.
    batchId Id Identifier used for the generated settlement batch.
  • Choice GetView

    Retrieves the interface view.

    Controller: viewer

    Returns: View

    Field Type Description
    viewer Party The party retrieving the view.
  • Method claimEffect : ClaimEffect -> Update ClaimResult

    Implementation of the ClaimEffect choice.

Data Types

data ClaimResult

Data type wrapping the results of Claim``ing an ``Effect.


Field Type Description
batchCid ContractId I Batch used to batch-settle settlement instructions.
instructionCids [ContractId I] Settlement instructions to settle all effect consequences.

instance Eq ClaimResult

instance Show ClaimResult

instance HasMethod Claim "claimEffect" (ClaimEffect -> Update ClaimResult)

type I

= Claim

Type synonym for Claim.

type V

= View

Type synonym for View.

instance HasFromAnyView Claim V

data View

View for Settlement.


Field Type Description
providers Parties Providers of the claim rule. Together with the actors of the ClaimEffect choice the authorization requirements to upgrade the holdings being claimed have to be met.
claimers Parties Any of the parties can claim an effect.
settlers Parties Any of the parties can trigger settlement of the resulting batch.
routeProviderCid ContractId I RouteProvider contract used to discover settlement routes.
settlementFactoryCid ContractId I Settlement factory contract used to create a Batch of Instruction\s.

instance Eq View

instance Show View