Interface UtxoFilteredTransaction
-
- All Implemented Interfaces:
@DoNotImplement() public interface UtxoFilteredTransaction
Defines a filtered UTXO transaction.
This wraps a signed transaction that has been filtered using Merkle proofs. This means that we can still calculate and verify the transaction ID as a Merkle hash, but do not have access to all data in the original transaction.
For the list-based data properties, there are three possibilities: - The whole entry is filtered out - no further information about this data is available. This will be signified by returning an object implementing UtxoFilteredData.Removed. - Only the number of original entries is revealed, but not the actual data. In this case, an object implementing UtxoFilteredData.SizeOnly is returned. - Some or all of the original data is revealed. In this case, an object implementing UtxoFilteredData.Audit is returned.
There are a few special cases: - getId and getMetadata cannot be filtered and are always returned. - getNotary and getTimeWindow are always unique - they are either revealed, or the filtered transaction will return null when accessing them.
-
-
Method Summary
Modifier and Type Method Description abstract SecureHash
getId()
Gets the ID of the current transaction. abstract TransactionMetadata
getMetadata()
Gets the metadata for the current transaction. abstract TimeWindow
getTimeWindow()
Gets the validity time window for finalizing/notarizing the current transaction, or null if filtered. abstract MemberX500Name
getNotaryName()
Gets the notary service name for the current transaction, or null if filtered. abstract PublicKey
getNotaryKey()
Gets the notary service key for the current transaction, or null if filtered abstract UtxoFilteredData<PublicKey>
getSignatories()
Gets a potentially filtered list of required signatories for the current transaction. abstract UtxoFilteredData<Command>
getCommands()
Gets a potentially filtered list of commands for the current transaction. abstract UtxoFilteredData<StateRef>
getInputStateRefs()
Gets a potentially filtered list of input state refs for the current transaction. abstract UtxoFilteredData<StateRef>
getReferenceStateRefs()
Gets a potentially filtered list of reference input state refs for the current transaction. abstract UtxoFilteredData<StateAndRef<out Object>>
getOutputStateAndRefs()
Gets a potentially filtered list of output state refs for the current transaction. abstract void
verify()
Verifies the current UtxoFilteredTransaction. -
-
Method Detail
-
getId
@NotNull() abstract SecureHash getId()
Gets the ID of the current transaction.
-
getMetadata
@NotNull() abstract TransactionMetadata getMetadata()
Gets the metadata for the current transaction.
-
getTimeWindow
@Nullable() abstract TimeWindow getTimeWindow()
Gets the validity time window for finalizing/notarizing the current transaction, or null if filtered.
-
getNotaryName
@Nullable() abstract MemberX500Name getNotaryName()
Gets the notary service name for the current transaction, or null if filtered.
-
getNotaryKey
abstract PublicKey getNotaryKey()
Gets the notary service key for the current transaction, or null if filtered
-
getSignatories
@NotNull() abstract UtxoFilteredData<PublicKey> getSignatories()
Gets a potentially filtered list of required signatories for the current transaction.
-
getCommands
@NotNull() abstract UtxoFilteredData<Command> getCommands()
Gets a potentially filtered list of commands for the current transaction.
-
getInputStateRefs
@NotNull() abstract UtxoFilteredData<StateRef> getInputStateRefs()
Gets a potentially filtered list of input state refs for the current transaction.
-
getReferenceStateRefs
@NotNull() abstract UtxoFilteredData<StateRef> getReferenceStateRefs()
Gets a potentially filtered list of reference input state refs for the current transaction.
-
getOutputStateAndRefs
@NotNull() abstract UtxoFilteredData<StateAndRef<out Object>> getOutputStateAndRefs()
Gets a potentially filtered list of output state refs for the current transaction.
-
verify
abstract void verify()
Verifies the current UtxoFilteredTransaction.
-
-
-
-