docs/net.corda.testing.dsl/LedgerDSL

LedgerDSL

class LedgerDSL<out T : TransactionDSLInterpreter, out L : LedgerDSLInterpreter<T>>(val interpreter: L, notary: Party) : LedgerDSLInterpreter<TransactionDSLInterpreter>

This is the class that defines the syntactic sugar of the ledger Test DSL and delegates to the contained interpreter, and what is actually used in ledger { (...) }. Add convenience functions here, or if you want to extend the DSL functionality then first add your primitive to LedgerDSLInterpreter and then add the convenience defaults/extension methods here.

Constructors

LedgerDSL

constructor(interpreter: L, notary: Party)

Properties

interpreter

val interpreter: L

Functions

_transaction

open override fun _transaction(transactionLabel: String?, transactionBuilder: TransactionBuilder, dsl: TransactionDSLInterpreter.() -> EnforceVerifyOrFail): WireTransaction

Creates and adds a transaction to the ledger.

_tweak

open override fun _tweak(dsl: LedgerDSLInterpreter<TransactionDSLInterpreter>.() -> Unit)

Creates a local scoped copy of the ledger.

_unverifiedTransaction

open override fun _unverifiedTransaction(transactionLabel: String?, transactionBuilder: TransactionBuilder, dsl: TransactionDSLInterpreter.() -> Unit): WireTransaction

Creates and adds a transaction to the ledger that will not be verified by verifies.

attachment

open override fun attachment(attachment: InputStream): SecureHash

Adds an attachment to the ledger.

fails

open override fun fails(): EnforceVerifyOrFail

Asserts that verifies throws, with no condition on the exception message.

fails with

open infix override fun fails with(msg: String): EnforceVerifyOrFail

failsWith

open override fun failsWith(expectedMessage: String?): EnforceVerifyOrFail

Asserts that verifies() throws.

output

inline fun <S : ContractState> String.output(): S

Retrieves the output TransactionState based on the label.

outputStateAndRef

inline fun <S : ContractState> String.outputStateAndRef(): StateAndRef<S>

Retrieves an output previously defined by TransactionDSLInterpreter._output with a label passed in.

retrieveOutput

fun <S : ContractState> retrieveOutput(clazz: Class<S>, label: String): S

Retrieves an output previously defined by TransactionDSLInterpreter._output with a label passed in.

retrieveOutputStateAndRef

open override fun <S : ContractState> retrieveOutputStateAndRef(clazz: Class<S>, label: String): StateAndRef<S>

Retrieves an output previously defined by TransactionDSLInterpreter.output with a label passed in.

transaction

fun transaction(label: String? = null, transactionBuilder: TransactionBuilder = TransactionBuilder(notary = notary), dsl: TransactionDSL<TransactionDSLInterpreter>.() -> EnforceVerifyOrFail): WireTransaction

Creates and adds a transaction to the ledger.

tweak

fun tweak(dsl: LedgerDSL<T, L>.() -> Unit)

Creates a local scoped copy of the ledger.

unverifiedTransaction

fun unverifiedTransaction(label: String? = null, transactionBuilder: TransactionBuilder = TransactionBuilder(notary = notary), dsl: TransactionDSL<TransactionDSLInterpreter>.() -> Unit): WireTransaction

Creates and adds a transaction to the ledger that will not be verified by verifies.

verifies

open override fun verifies(): EnforceVerifyOrFail

Verifies the ledger/transaction, throws if the verification fails.