com.r3corda.protocols / TwoPartyDealProtocol / Primary

Primary

abstract class Primary : ProtocolLogic<SignedTransaction>

Abstracted bilateral deal protocol participant that initiates communication/handshake.

Theres a good chance we can push at least some of this logic down into core protocol logic and helper methods etc.





Types

AWAITING_PROPOSAL object AWAITING_PROPOSAL : Step
COPYING_TO_REGULATOR object COPYING_TO_REGULATOR : Step
NOTARY object NOTARY : Step
RECORDING object RECORDING : Step
SENDING_SIGS object SENDING_SIGS : Step
SIGNING object SIGNING : Step
VERIFYING object VERIFYING : Step

Constructors

<init> Primary(progressTracker: ProgressTracker = Primary.tracker())

Abstracted bilateral deal protocol participant that initiates communication/handshake.

Properties

myKeyPair abstract val myKeyPair: KeyPair
notaryNode abstract val notaryNode: NodeInfo
otherParty abstract val otherParty: Party
payload abstract val payload: Any
progressTracker open val progressTracker: ProgressTracker

Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something helpful with the progress reports. If this protocol is invoked as a sub-protocol of another, then the tracker will be made a child of the current step in the parent. If its null, this protocol doesnt track progress.

Inherited Properties

logger val logger: <ERROR CLASS>

This is where you should log things to.

psm lateinit var psm: ProtocolStateMachine<*>

Reference to the Fiber instance that is the top level controller for the entire flow.

serviceHub val serviceHub: ServiceHub

Provides access to big, heavy classes that may be reconstructed from time to time, e.g. across restarts. It is only available once the protocol has started, which means it cannnot be accessed in the constructor. Either access this lazily or from inside call.

Functions

call open fun call(): SignedTransaction

This is where you fill out your business logic.

getCounterpartyMarker open fun getCounterpartyMarker(party: Party): Class<*>

Return the marker Class which party has used to register the counterparty protocol that is to execute on the other side. The default implementation returns the class object of this ProtocolLogic, but any Class instance will do as long as the other side registers with it.

getPartialTransaction fun getPartialTransaction(): UntrustworthyData<SignedTransaction>
signWithOurKey open fun signWithOurKey(partialTX: SignedTransaction): WithKey
verifyPartialTransaction fun verifyPartialTransaction(untrustedPartialTX: UntrustworthyData<SignedTransaction>): SignedTransaction

Inherited Functions

receive fun <T : Any> receive(otherParty: Party): UntrustworthyData<T>
fun <T : Any> receive(otherParty: Party, receiveType: Class<T>): UntrustworthyData<T>
send fun send(otherParty: Party, payload: Any): Unit
sendAndReceive fun <T : Any> sendAndReceive(otherParty: Party, payload: Any): UntrustworthyData<T>
fun <T : Any> sendAndReceive(otherParty: Party, payload: Any, receiveType: Class<T>): UntrustworthyData<T>
subProtocol fun <R> subProtocol(subLogic: ProtocolLogic<R>, shareParentSessions: Boolean = false): R

Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the ProtocolStateMachine and then calling the call method.

track fun track(): <ERROR CLASS><String, <ERROR CLASS><String>>?

Companion Object Functions

tracker fun tracker(): ProgressTracker

Inheritors

Floater class Floater : Primary

One side of the fixing protocol for an interest rate swap, but could easily be generalised furher.

Instigator class Instigator : Primary

One side of the protocol for inserting a pre-agreed deal.