Package net.finmath.smartcontract.statemachine

Class SmartContractStateMachine

java.lang.Object
net.finmath.smartcontract.statemachine.SmartContractStateMachine
public class SmartContractStateMachine extends Object
State Machine Modeling of the Smart Derivative Contract.

This state machine models a smart derivative contract using a loop of the following core states:

  • a pre-funding test (Guard),
  • an active state (State) (representing the time until the settlement has to occurs),
  • a settlement state (State),
  • a settlement test (Guard),
  • a maturity test (Guard),
See also SmartContractStateMachine.States and SmartContractStateMachine.Events.

Most of the time, a smart derivative contract is in the ACTIVE state. If a SETTLE event occurs the contract moves to the SETTLEMENT state.

A settlement can be partial or successful. A partial settlement will lead to termination.

After settlement, the machine checks the success of the settlement, checks for maturity, checks for pre-funding for the next period, then returns to the active state.

Hence, there are three different termination states.

Author:
Christian Fries

  • Constructor Details

    • SmartContractStateMachine

      public SmartContractStateMachine()

  • Method Details

    • main

      public static void main​(String[] args) throws Exception
      Example for using the SmartContractStateMachine.
      Parameters:
      args - Not used.
      Throws:
      Exception - General exception.

    • buildMachine

      public org.springframework.statemachine.StateMachine<SmartContractStateMachine.States,​SmartContractStateMachine.Events> buildMachine() throws Exception
      Building a smart derivative contract state machine.
      Returns:
      The state machine in terms of States and Events.
      Throws:
      Exception - Thrown when build of state machine fails. This is a severe internal error. It should not happen.

    • isPrefunded

      public boolean isPrefunded()
      Check the state if the account is prefunded.
      Returns:
      True, if the account has been verified to be pre-funded.

    • setPrefunded

      public SmartContractStateMachine setPrefunded​(boolean isPrefunded)
      Set the state if the account is prefunded.
      Parameters:
      isPrefunded - True, if the account has been verified to be pre-funded.
      Returns:
      Self reference.

    • isMatured

      public boolean isMatured()
      Check the state if the contract is matured.
      Returns:
      True, if the contract is matured.

    • setMatured

      public SmartContractStateMachine setMatured​(boolean isMatured)
      Set the state if the contract is matured.
      Parameters:
      isMatured - True, if the contract is matured.
      Returns:
      Self reference.

    • isSettlementSuccessful

      public boolean isSettlementSuccessful()
      Check the state if the settlement has been successful.
      Returns:
      True, if the settlement was successful.

    • setSettlementSuccessful

      public SmartContractStateMachine setSettlementSuccessful​(boolean isSettlementSuccessful)
      Set the state if the settlement has been successful.
      Parameters:
      isSettlementSuccessful - True, if the settlement has been successful.
      Returns:
      Self reference.

    • settlementCheck

      public org.springframework.statemachine.guard.Guard<SmartContractStateMachine.States,​SmartContractStateMachine.Events> settlementCheck()
      Test to be executed to check for successful settlement.
      Returns:
      The test to be executed to check for successful settlement.

    • prefundingCheck

      public org.springframework.statemachine.guard.Guard<SmartContractStateMachine.States,​SmartContractStateMachine.Events> prefundingCheck()
      Test to be executed to check for existing pre-funding.
      Returns:
      The test to be executed to check for existing pre-funding.

    • notMaturedCheck

      public org.springframework.statemachine.guard.Guard<SmartContractStateMachine.States,​SmartContractStateMachine.Events> notMaturedCheck()
      Test to be executed to check for maturity.
      Returns:
      The test to be executed to check for maturity.

    • performSettlement

      public org.springframework.statemachine.action.Action<SmartContractStateMachine.States,​SmartContractStateMachine.Events> performSettlement()
      Action performend if the settlement state is entered.
      Returns:
      The action executed if settlement state is entered