corda / net.corda.finance.flows / CashIssueFlow

CashIssueFlow

@StartableByRPC class CashIssueFlow : AbstractCashFlow<Result>

Initiates a flow that self-issues cash (which should then be sent to recipient(s) using a payment transaction).

We issue cash only to ourselves so that all KYC/AML checks on payments are enforced consistently, rather than risk checks for issuance and payments differing. Outside of test scenarios it would be extremely unusual to issue cash and immediately transfer it, so impact of this limitation is considered minimal.

Parameters

amount - the amount of currency to issue.

issuerBankPartyRef - a reference to put on the issued currency.

notary - the notary to set on the output states.

Types

IssueRequest

class IssueRequest : AbstractRequest

Constructors

<init>

CashIssueFlow(amount: Amount<Currency>, issuerBankPartyRef: OpaqueBytes, notary: Party)
CashIssueFlow(request: IssueRequest)CashIssueFlow(amount: Amount<Currency>, issuerBankPartyRef: OpaqueBytes, notary: Party, progressTracker: ProgressTracker)

Initiates a flow that self-issues cash (which should then be sent to recipient(s) using a payment transaction).

Inherited Properties

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 e.g record to the audit service. If this flow is invoked as a subflow of another, then the tracker will be made a child of the current step in the parent. If it's null, this flow doesn't track progress.

Functions

call

fun call(): Result

This is where you fill out your business logic.

Inherited Functions

finaliseTx

fun finaliseTx(tx: SignedTransaction, sessions: Collection<FlowSession>, message: String): SignedTransaction

Extension Functions

contextLogger

fun Any.contextLogger(): <ERROR CLASS>

When called from a companion object, returns the logger for the enclosing class.

receiveAll

fun FlowLogic<*>.receiveAll(session: <ERROR CLASS><FlowSession, Class<out Any>>, vararg sessions: <ERROR CLASS><FlowSession, Class<out Any>>): Map<FlowSession, UntrustworthyData<Any>>
fun <R : Any> FlowLogic<*>.receiveAll(receiveType: Class<R>, session: FlowSession, vararg sessions: FlowSession): List<UntrustworthyData<R>>
fun <R : Any> FlowLogic<*>.receiveAll(session: FlowSession, vararg sessions: FlowSession): List<UntrustworthyData<R>>

Suspends until a message has been received for each session in the specified sessions.