LedgerDSL - corda

corda / net.corda.testing.dsl / LedgerDSL

# LedgerDSL

`class LedgerDSL<out T : TransactionDSLInterpreter, out L : LedgerDSLInterpreter<T>> : 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

#### <init> | 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. `LedgerDSL(interpreter: L, notary: Party)`

### Properties

#### interpreter | `val interpreter: L`

### Functions

#### output | Retrieves the output TransactionState based on the label. `fun <S : ContractState> String.output(): S`
#### outputStateAndRef | Retrieves an output previously defined by TransactionDSLInterpreter._output with a label passed in. `fun <S : ContractState> String.outputStateAndRef(): StateAndRef<S>`
#### retrieveOutput | Retrieves an output previously defined by TransactionDSLInterpreter._output with a label passed in. `fun <S : ContractState> retrieveOutput(clazz: Class<S>, label: String): S`
#### transaction | Creates and adds a transaction to the ledger. `fun transaction(label: String? = null, transactionBuilder: TransactionBuilder = TransactionBuilder(notary = notary), dsl: TransactionDSL<TransactionDSLInterpreter>.() -> EnforceVerifyOrFail): WireTransaction`
#### tweak | Creates a local scoped copy of the ledger. `fun tweak(dsl: LedgerDSL<T, L>.() -> Unit): Unit`
#### unverifiedTransaction | Creates and adds a transaction to the ledger that will not be verified by verifies. `fun unverifiedTransaction(label: String? = null, transactionBuilder: TransactionBuilder = TransactionBuilder(notary = notary), dsl: TransactionDSL<TransactionDSLInterpreter>.() -> Unit): WireTransaction`