com.r3corda.protocols / TwoPartyDealProtocol / Primary

# Primary

`abstract class Primary<out U> : 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`
otherSessionID | `abstract val otherSessionID: Long`
otherSide | `abstract val otherSide: Party`
payload | `abstract val payload: U`
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.
topic | `open val topic: String` The topic to use when communicating with other parties. If more than one topic is required then use sub-protocols. Note that this is temporary until protocol sessions are properly implemented.

### 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.
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(sessionIDForReceive: Long, receiveType: Class<T>): UntrustworthyData<T>` `fun <T : Any> receive(sessionIDForReceive: Long): UntrustworthyData<T>`
send | `fun send(destination: Party, sessionID: Long, payload: Any): Unit`
sendAndReceive | `fun <T : Any> sendAndReceive(destination: Party, sessionIDForSend: Long, sessionIDForReceive: Long, payload: Any): UntrustworthyData<T>`
subProtocol | `fun <R> subProtocol(subLogic: ProtocolLogic<R>): R` Invokes the given subprotocol by simply passing through this ProtocolLogics reference to the ProtocolStateMachine and then calling the call method.

### Companion Object Functions

tracker | `fun tracker(): ProgressTracker`

### Inheritors

Floater | `class Floater : Primary<StateRef>` One side of the fixing protocol for an interest rate swap, but could easily be generalised furher.
Instigator | `class Instigator<T : DealState> : Primary<T>` One side of the protocol for inserting a pre-agreed deal.