MockServices

An implementation of ServiceHub that is designed for in-memory unit tests of contract validation logic. It has enough functionality to do tests of code that queries the vault, inserts to the vault, and constructs/checks transactions. However it isn't enough to test flows and other aspects of an app that require a network. For that you should investigate MockNetwork.

There are a variety of constructors that can be used to supply enough data to simulate a node. Each mock service hub must have at least an identity of its own. The other components have defaults that work in most situations.

Constructors

Link copied to clipboard
constructor(cordappPackages: Iterable<String>, initialIdentity: <Error class: unknown class>, identityService: IdentityService = makeTestIdentityService(), vararg moreKeys: KeyPair)

Create a mock ServiceHub that looks for app code in the given package names, uses the provided identity service (you can get one from makeTestIdentityService) and represents the given identity.

constructor(cordappPackages: Iterable<String>, initialIdentity: <Error class: unknown class>, identityService: IdentityService, networkParameters: NetworkParameters, vararg moreKeys: KeyPair)
constructor(cordappPackages: Iterable<String>, initialIdentity: <Error class: unknown class>, identityService: IdentityService, networkParameters: NetworkParameters, vararg moreKeys: KeyPair, keyManagementService: KeyManagementService)
constructor(cordappPackages: Iterable<String>, initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService(), key: KeyPair, vararg moreKeys: KeyPair)

Create a mock ServiceHub that looks for app code in the given package names, uses the provided identity service (you can get one from makeTestIdentityService) and represents the given identity.

constructor(cordappPackages: Iterable<String>, initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService())

Create a mock ServiceHub that can't load CorDapp code, which uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity.

constructor(cordappPackages: Iterable<String>)

Create a mock ServiceHub that can't load CorDapp code, and which uses a default service identity.

constructor(initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService(), key: KeyPair, vararg moreKeys: KeyPair)

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity.

constructor(initialIdentityName: CordaX500Name, identityService: IdentityService = makeTestIdentityService())

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses the provided identity service (you can get one from makeTestIdentityService) and which represents the given identity. It has no keys.

constructor(cordappPackages: List<String>, initialIdentityName: CordaX500Name, identityService: IdentityService, networkParameters: NetworkParameters)
constructor(cordappPackages: List<String>, initialIdentityName: CordaX500Name, identityService: IdentityService, networkParameters: NetworkParameters, key: KeyPair)
constructor(firstIdentity: <Error class: unknown class>, vararg moreIdentities: <Error class: unknown class>)

A helper constructor that requires at least one test identity to be registered, and which takes the package of the caller as the package in which to find app code. This is the most convenient constructor and the one that is normally worth using. The first identity is the identity of this service hub, the rest are identities that it is aware of.

constructor(firstIdentity: <Error class: unknown class>, networkParameters: NetworkParameters, vararg moreIdentities: <Error class: unknown class>)
constructor(cordappPackages: List<String>, firstIdentity: <Error class: unknown class>, vararg moreIdentities: <Error class: unknown class>)
constructor(cordappPackages: List<String>, firstIdentity: <Error class: unknown class>, networkParameters: NetworkParameters, vararg moreIdentities: <Error class: unknown class>)
constructor()

Create a mock ServiceHub which uses the package of the caller to find CorDapp code. It uses a default service identity.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Provides access to storage of arbitrary JAR files (which may contain only data, no code).

Link copied to clipboard
open override val clock: TestClock

A Clock representing the node's current time. This should be used in preference to directly accessing the clock so the current time can be controlled during unit testing.

Link copied to clipboard

The ContractUpgradeService is responsible for securely upgrading contract state objects according to a specified and mutually agreed (amongst participants) contract version.

Link copied to clipboard

Returns the classloader containing all jar deployed in the 'cordapps' folder.

Link copied to clipboard
open override val cordappProvider: CordappProvider

Provides access to anything relating to cordapps including contract attachment resolution and app context

Link copied to clipboard

The DiagnosticsService provides diagnostic level information about the node, including the current version of the node, and the CorDapps currently installed on the node. Note that this information should be used to provide diagnostics only, and no functional decisions should be made based on this.

Link copied to clipboard

The configured instance of DigestService which is passed by default to instances of classes like TransactionBuilder and as a parameter to MerkleTree.getMerkleTree(...) method. Default: SHA2_256.

Link copied to clipboard
open override val identityService: IdentityService

An identity service maintains a directory of parties by their associated distinguished name/public keys and thus supports lookup of a party given its key, or name. The service also manages the certificates linking confidential identities back to the well known identity (i.e. the identity in the network map) of a party.

Link copied to clipboard

The key management service is responsible for storing and using private keys to sign things. An implementation of this may, for example, call out to a hardware security module that enforces various auditing and frequency-of-use requirements.

Link copied to clipboard
open override val myInfo: NodeInfo

The NodeInfo object corresponding to our own entry in the network map.

Link copied to clipboard
open override val networkMapCache: NetworkMapCache

A network map contains lists of nodes on the network along with information about their identity keys, services they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised with a specified network map service, which it fetches data from and then subscribes to updates of.

Link copied to clipboard

Returns the network parameters the node is operating under.

Link copied to clipboard

Provides access to historical network parameters that are used in transaction resolution.

Link copied to clipboard

Provides operations to support telemetry and telemetry data between nodes.

Link copied to clipboard

A map of hash->tx where tx has been signature/contract validated and the states are known to be correct. The signatures aren't technically needed after that point, but we keep them around so that we can relay the transaction data to other nodes that need it.

Link copied to clipboard
open override val vaultService: VaultService

The vault service lets you observe, soft lock and add notes to states that involve you or are relevant to your node in some way. Additionally you may query and track states that correspond to various criteria.

Functions

Link copied to clipboard
fun addMockCordapp(contractClassName: ContractClassName)

Add the given package name to the list of packages which will be scanned for cordapp contract verification code

Link copied to clipboard
open fun addSignature(signedTransaction: SignedTransaction): SignedTransaction

Helper method to append an additional signature for an existing (partially) SignedTransaction using the default identity signing key of the node.

open fun addSignature(signedTransaction: SignedTransaction, publicKey: PublicKey): SignedTransaction

Helper method to append an additional signature to an existing (partially) SignedTransaction.

Link copied to clipboard
open override fun <T : SerializeAsToken> cordaService(type: Class<T>): T

Return the singleton instance of the given Corda service type. This is a class that is annotated with CordaService and will have automatically been registered by the node.

Link copied to clipboard
open override fun <T : TelemetryComponent> cordaTelemetryComponent(type: Class<T>): T

Return the singleton instance of the given Corda telemetry component type. This is a class that implements TelemetryComponent and will have automatically been registered by the node.

Link copied to clipboard

Helper method to create a signature for a FilteredTransaction using the default identity signing key of the node. The legal identity key is used to sign. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

Helper method to create a signature for an existing (partially) SignedTransaction using the default identity signing key of the node. The legal identity key is used to sign. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

open fun createSignature(filteredTransaction: FilteredTransaction, publicKey: PublicKey): TransactionSignature

Helper method to create a signature for a FilteredTransaction. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

open fun createSignature(signedTransaction: SignedTransaction, publicKey: PublicKey): TransactionSignature

Helper method to create an additional signature for an existing (partially) SignedTransaction. Additional SignatureMetadata, including the platform version used during signing and the cryptographic signature scheme use, is added to the signature.

Link copied to clipboard
fun ServicesForResolution.ensureMinimumPlatformVersion(requiredMinPlatformVersion: Int, feature: String)
Link copied to clipboard
Link copied to clipboard
open override fun jdbcSession(): Connection

Exposes a JDBC connection (session) object using the currently configured database. Applications can use this to execute arbitrary SQL queries (native, direct, prepared, callable) against its Node database tables (including custom contract tables defined by extending net.corda.core.schemas.QueryableState).

Link copied to clipboard

Creates and tests a ledger built by the passed in dsl.

Link copied to clipboard
open override fun loadContractAttachment(stateRef: StateRef): Attachment

Returns a dummy Attachment, in context of signature constrains non-downgrade rule this default to contract class version 1.

Link copied to clipboard
open override fun loadState(stateRef: StateRef): TransactionState<ContractState>

Given a StateRef loads the referenced transaction and looks up the specified output ContractState.

Link copied to clipboard
open override fun loadStates(stateRefs: Set<StateRef>): Set<StateAndRef<ContractState>>

Given a Set of StateRef's loads the referenced transaction and looks up the specified output ContractState.

Link copied to clipboard
open fun recordTransactions(first: SignedTransaction, vararg remaining: SignedTransaction)

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing. This is expected to be run within a database transaction.

open fun recordTransactions(notifyVault: Boolean, first: SignedTransaction, vararg remaining: SignedTransaction)

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing if notifyVault is true. This is expected to be run within a database transaction.

fun recordTransactions(txs: Iterable<SignedTransaction>, disableSignatureVerification: Boolean)
fun recordTransactions(txn: SignedTransaction, disableSignatureVerification: Boolean): <Error class: unknown class>

open override fun recordTransactions(statesToRecord: StatesToRecord, txs: Iterable<SignedTransaction>)

Stores the given SignedTransactions in the local transaction storage and then sends them to the vault for further processing if statesToRecord is not StatesToRecord.NONE. This is expected to be run within a database transaction.

Link copied to clipboard
open override fun registerUnloadHandler(runOnStop: () -> Unit): Nothing

Allows the registration of a callback that may inform services when the app is shutting down.

Link copied to clipboard

Helper method to construct an initial partially signed transaction from a TransactionBuilder using the default identity key contained in the node. The legal identity key is used to sign.

Helper method to construct an initial partially signed transaction from a TransactionBuilder using keys stored inside the node. Signature metadata is added automatically.

Helper method to construct an initial partially signed transaction from a TransactionBuilder using a set of keys all held in this node.

Link copied to clipboard

Provides a callback for the Node to customise the LedgerTransaction.

Link copied to clipboard

Converts the given StateRef into a StateAndRef object.

Link copied to clipboard

Creates a ledger with a single transaction, built by the passed in dsl.

Link copied to clipboard
open override fun withEntityManager(block: Consumer<<Error class: unknown class>>)
open override fun <T> withEntityManager(block: <Error class: unknown class>.() -> T): T

Exposes the Java Persistence API (JPA) to flows via a restricted EntityManager. This method can be used to persist and query entities which inherit from MappedSchema. This is particularly useful if off-ledger data needs to be kept in conjunction with on-ledger state data.