docs/net.corda.core.transactions/NotaryChangeLedgerTransaction

NotaryChangeLedgerTransaction

class NotaryChangeLedgerTransaction : FullTransaction, TransactionWithSignatures

A notary change transaction with fully resolved inputs and signatures. In contrast with a regular transaction, signatures are checked against the signers specified by input states' participants fields, so full resolution is needed for signature verification.

Constructors

constructor(inputs: List<StateAndRef<ContractState>>, notary: Party, newNotary: Party, id: SecureHash, sigs: List<TransactionSignature>)

Types

Companion

object Companion

Properties

open override val id: SecureHash

inputs

open override val inputs: List<StateAndRef<ContractState>>

The inputs of this transaction. Note that in BaseTransaction subclasses the type of this list may change!

networkParameters

open override val networkParameters: NetworkParameters?

Network parameters that were in force when this transaction was created. Resolved from the hash of network parameters on the corresponding wire transaction.

newNotary

val newNotary: Party

notary

open override val notary: Party

If present, the notary for this transaction. If absent then the transaction is not notarised at all. This is intended for issuance/genesis transactions that don't consume any other states and thus can't double spend anything.

outputs

open override val outputs: List<TransactionState<ContractState>>

We compute the outputs on demand by applying the notary field modification to the inputs.

outputStates

val outputStates: List<ContractState>

Helper property to return a list of ContractState objects, rather than the often less convenient TransactionState

references

open override val references: List<StateAndRef<ContractState>>

A list of reusable reference data states which can be referred to by other contracts in this transaction.

requiredSigningKeys

open override val requiredSigningKeys: Set<PublicKey>

Specifies all the public keys that require signatures for the transaction to be valid.

sigs

open override val sigs: List<TransactionSignature>

List of signatures on this transaction.

Functions

checkSignaturesAreValid

open fun checkSignaturesAreValid()

Mathematically validates the signatures that are present on this transaction. This does not imply that the signatures are by the right keys, or that there are sufficient signatures, just that they aren't corrupt. If you use this function directly you'll need to do the other checks yourself. Probably you want verifyRequiredSignatures instead.

component1

operator fun component1(): List<StateAndRef<ContractState>>

component2

operator fun component2(): Party

component3

operator fun component3(): Party

component4

operator fun component4(): SecureHash

component5

operator fun component5(): List<TransactionSignature>

component6

operator fun component6(): NetworkParameters?

copy

fun ~~copy~~(inputs: List<StateAndRef<ContractState>> = this.inputs, notary: Party = this.notary, newNotary: Party = this.newNotary, id: SecureHash = this.id, sigs: List<TransactionSignature> = this.sigs): NotaryChangeLedgerTransaction

equals

open operator override fun equals(other: Any?): Boolean

filterOutputs

inline fun <T : ContractState> filterOutputs(crossinline predicate: (T) -> Boolean): List<T>

fun <T : ContractState> filterOutputs(clazz: Class<T>, predicate: Predicate<T>): List<T>

Helper to simplify filtering outputs according to a Predicate.

filterOutRefs

inline fun <T : ContractState> filterOutRefs(crossinline predicate: (T) -> Boolean): List<StateAndRef<T>>

fun <T : ContractState> filterOutRefs(clazz: Class<T>, predicate: Predicate<T>): List<StateAndRef<T>>

Helper to simplify filtering output StateAndRef items according to a Predicate.

findOutput

inline fun <T : ContractState> findOutput(crossinline predicate: (T) -> Boolean): T

fun <T : ContractState> findOutput(clazz: Class<T>, predicate: Predicate<T>): T

Helper to simplify finding a single output matching a Predicate.

findOutRef

inline fun <T : ContractState> findOutRef(crossinline predicate: (T) -> Boolean): StateAndRef<T>

fun <T : ContractState> findOutRef(clazz: Class<T>, predicate: Predicate<T>): StateAndRef<T>

Helper to simplify finding a single output StateAndRef matching a Predicate.

getKeyDescriptions

open override fun getKeyDescriptions(keys: Set<PublicKey>): List<String>

Get a human readable description of where signatures are required from, and are missing, to assist in debugging the underlying cause.

getMissingSigners

open fun getMissingSigners(): Set<PublicKey>

Return the PublicKeys for which we still need signatures.

getOutput

fun getOutput(index: Int): ContractState

Helper to simplify getting an indexed output.

hashCode

open override fun hashCode(): Int

outputsOfType

inline fun <T : ContractState> outputsOfType(): List<T>

fun <T : ContractState> outputsOfType(clazz: Class<T>): List<T>

Helper to simplify getting all output states of a particular class, interface, or base class.

outRef

fun <T : ContractState> outRef(index: Int): StateAndRef<T>

Returns a StateAndRef for the given output index.

fun <T : ContractState> outRef(state: ContractState): StateAndRef<T>

Returns a StateAndRef for the requested output state, or throws IllegalArgumentException if not found.

outRefsOfType

inline fun <T : ContractState> outRefsOfType(): List<StateAndRef<T>>

fun <T : ContractState> outRefsOfType(clazz: Class<T>): List<StateAndRef<T>>

Helper to simplify getting all output StateAndRef items of a particular state class, interface, or base class.

toSimpleString

fun NamedByHash.toSimpleString(): String

toString

open override fun toString(): String

verifyRequiredSignatures

open fun verifyRequiredSignatures(): <Error class: unknown class>

Verifies the signatures on this transaction and throws if any are missing. In this context, "verifying" means checking they are valid signatures and that their public keys are in the requiredSigningKeys set.

verifySignaturesExcept

open fun verifySignaturesExcept(vararg allowedToBeMissing: PublicKey)

open fun verifySignaturesExcept(allowedToBeMissing: Collection<PublicKey>)

Verifies the signatures on this transaction and throws if any are missing which aren't passed as parameters. In this context, "verifying" means checking they are valid signatures and that their public keys are in the requiredSigningKeys set.