Writing the state

In Corda, shared facts on the blockchain are represented as states. Our first task will be to define a new state type to represent an IOU.

Implementing the ContractState interface

A Corda state is any instance of a class that implements the ContractState interface. The ContractState interface is defined as follows:

interface ContractState {
    // The list of entities considered to have a stake in this state.
    val participants: List<AbstractParty>
}

As you can see, the ContractState interface has a single field, participants. participants is a list of the entities for which this state is relevant.

Beyond this, your state is free to define any fields, methods, helpers or inner classes that the state requires to accurately represent a given type of shared fact on the blockchain.

Modelling IOUs

How should you define the IOUState representing IOUs on the blockchain? Beyond implementing the ContractState interface, your IOUState will also need properties to track the relevant features of the IOU:

  • The value of the IOU.
  • The lender of the IOU.
  • The borrower of the IOU.

There are many more fields you could include, such as the IOU’s currency, but let’s ignore those for now. Adding them later is often as simple as adding an additional property to your class definition.

Defining IOUState

Let’s get started by opening TemplateState.java (for Java) or TemplateState.kt (for Kotlin).

If you’re following along in Kotlin, you’ll need to begin by updating TemplateState to define an IOUState, as shown in the following code example.

If you’re following along in Java, you’ll need to first rename TemplateState.java to IOUState.java.

To define IOUState, you’ll also need to make the following changes:

  • You’ll need to rename the TemplateState class to IOUState.

  • You’ll need to add properties for value, lender and borrower, along with the required getters and setters in. Java:

    • value is of type int (in Java)/Int (in Kotlin).
    • lender and borrower are of type Party.
      • Party is a built-in Corda type that represents an entity on the network.
  • You’ll need to override participants to return a list of the lender and borrower.

    • participants is a list of all the parties who should be notified of the creation or consumption of this state.

The IOUs that you issue onto a ledger will simply be instances of this class.

The code examples below show how your code should be looking after doing all of the above:

// Add this import:
import net.corda.core.identity.Party

// Replace TemplateState's definition with:
@BelongsToContract(TemplateContract::class)
class IOUState(val value: Int,
               val lender: Party,
               val borrower: Party) : ContractState {
    override val participants get() = listOf(lender, borrower)

}

// Add this import:
import net.corda.core.identity.Party;

// Replace TemplateState's definition with:
public class IOUState implements ContractState {
    private final int value;
    private final Party lender;
    private final Party borrower;

    public IOUState(int value, Party lender, Party borrower) {
        this.value = value;
        this.lender = lender;
        this.borrower = borrower;
    }

    public int getValue() {
        return value;
    }

    public Party getLender() {
        return lender;
    }

    public Party getBorrower() {
        return borrower;
    }

    @Override
    public List<AbstractParty> getParticipants() {
        return Arrays.asList(lender, borrower);
    }
}

Progress so far

You’ve defined an IOUState that can be used to represent IOUs as shared facts on a ledger. As you’ve seen, states in Corda are simply classes that implement the ContractState interface. They can have any additional properties and methods you like.

All that’s left to do is write the IOUFlow that will allow a node to orchestrate the creation of a new IOUState on the blockchain, while only sharing information on a need-to-know basis.

What about the contract?

If you’ve read the white paper or Key Concepts section, you’ll know that each state has an associated contract that imposes invariants on how the state evolves over time. Including a contract isn’t crucial for our first CorDapp, so you’ll just use the empty TemplateContract and TemplateContract.Commands.Action command defined by the template for now.

In the next tutorial, you’ll implement our own contract and command.