public class Transaction extends ChildMessage
A transaction represents the movement of coins from some addresses to some other addresses. It can also represent the minting of new coins. A Transaction object corresponds to the equivalent in the Bitcoin C++ implementation.
Transactions are the fundamental atoms of Bitcoin and have many powerful features. Read "Working with transactions" in the documentation to learn more about how to use this class.
All Bitcoin transactions are at risk of being reversed, though the risk is much less than with traditional payment systems. Transactions have confidence levels, which help you decide whether to trust a transaction or not. Whether to trust a transaction is something that needs to be decided on a case by case basis - a rule that makes sense for selling MP3s might not make sense for selling cars, or accepting payments from a family member. If you are building a wallet, how to present confidence to your users is something to consider carefully.
Instances of this class are not safe for use by multiple threads.
Modifier and Type | Class and Description |
---|---|
static class |
Transaction.Purpose
This enum describes the underlying reason the transaction was created.
|
static class |
Transaction.SigHash
These constants are a part of a scriptSig signature on the inputs.
|
Modifier and Type | Field and Description |
---|---|
static Coin |
DEFAULT_TX_FEE
If using this feePerKb, transactions will get confirmed within the next couple of blocks.
|
static int |
LOCKTIME_THRESHOLD
Threshold for lockTime: below this value it is interpreted as block number, otherwise as timestamp.
|
static java.math.BigInteger |
LOCKTIME_THRESHOLD_BIG
Same but as a BigInteger for CHECKLOCKTIMEVERIFY
|
static int |
MAX_STANDARD_TX_SIZE
How many bytes a transaction can be before it won't be relayed anymore.
|
static Coin |
MIN_NONDUST_OUTPUT
Deprecated.
|
static Coin |
REFERENCE_DEFAULT_MIN_TX_FEE
If feePerKb is lower than this, Bitcoin Core will treat it as if there were no fee.
|
static int |
SERIALIZE_TRANSACTION_NO_WITNESS
When this bit is set in protocolVersion, do not include witness.
|
static byte |
SIGHASH_ANYONECANPAY_VALUE
Deprecated.
Instead use SigHash.ANYONECANPAY.value or SigHash.ANYONECANPAY.byteValue() as appropriate.
|
static java.util.Comparator<Transaction> |
SORT_TX_BY_HEIGHT
A comparator that can be used to sort transactions by their chain height.
|
static java.util.Comparator<Transaction> |
SORT_TX_BY_UPDATE_TIME
A comparator that can be used to sort transactions by their updateTime field.
|
parent
cursor, length, MAX_SIZE, offset, params, payload, recached, serializer, UNKNOWN_LENGTH
Constructor and Description |
---|
Transaction(NetworkParameters params) |
Transaction(NetworkParameters params,
byte[] payloadBytes)
Creates a transaction from the given serialized bytes, eg, from a block or a tx network message.
|
Transaction(NetworkParameters params,
byte[] payload,
int offset)
Creates a transaction by reading payload starting from offset bytes in.
|
Transaction(NetworkParameters params,
byte[] payload,
int offset,
Message parent,
MessageSerializer setSerializer,
int length,
byte[] hashFromHeader)
Creates a transaction by reading payload starting from offset bytes in.
|
Transaction(NetworkParameters params,
byte[] payload,
Message parent,
MessageSerializer setSerializer,
int length)
Creates a transaction by reading payload.
|
Modifier and Type | Method and Description |
---|---|
void |
addBlockAppearance(Sha256Hash blockHash,
int relativityOffset) |
TransactionInput |
addInput(Sha256Hash spendTxHash,
long outputIndex,
Script script)
Creates and adds an input to this transaction, with no checking that it's valid.
|
TransactionInput |
addInput(TransactionInput input)
Adds an input directly, with no checking that it's valid.
|
TransactionInput |
addInput(TransactionOutput from)
Adds an input to this transaction that imports value from the given output.
|
TransactionOutput |
addOutput(Coin value,
Address address)
Creates an output based on the given address and value, adds it to this transaction, and returns the new output.
|
TransactionOutput |
addOutput(Coin value,
ECKey pubkey)
Creates an output that pays to the given pubkey directly (no address) with the given value, adds it to this
transaction, and returns the new output.
|
TransactionOutput |
addOutput(Coin value,
Script script)
Creates an output that pays to the given script.
|
TransactionOutput |
addOutput(TransactionOutput to)
Adds the given output to this transaction.
|
TransactionInput |
addSignedInput(TransactionOutPoint prevOut,
Script scriptPubKey,
ECKey sigKey)
Same as
addSignedInput(TransactionOutPoint, Script, ECKey, Transaction.SigHash, boolean)
but defaults to Transaction.SigHash.ALL and "false" for the anyoneCanPay flag. |
TransactionInput |
addSignedInput(TransactionOutPoint prevOut,
Script scriptPubKey,
ECKey sigKey,
Transaction.SigHash sigHash,
boolean anyoneCanPay)
Adds a new and fully signed input for the given parameters.
|
TransactionInput |
addSignedInput(TransactionOutput output,
ECKey signingKey)
Adds an input that points to the given output and contains a valid signature for it, calculated using the
signing key.
|
TransactionInput |
addSignedInput(TransactionOutput output,
ECKey signingKey,
Transaction.SigHash sigHash,
boolean anyoneCanPay)
Adds an input that points to the given output and contains a valid signature for it, calculated using the
signing key.
|
protected void |
bitcoinSerializeToStream(java.io.OutputStream stream)
Serializes this message to the provided stream.
|
protected void |
bitcoinSerializeToStream(java.io.OutputStream stream,
boolean useSegwit)
Serialize according to BIP144 or the
classic format, depending on if segwit is
desired.
|
protected static int |
calcLength(byte[] buf,
int offset) |
TransactionSignature |
calculateSignature(int inputIndex,
ECKey key,
byte[] redeemScript,
Transaction.SigHash hashType,
boolean anyoneCanPay)
Calculates a signature that is valid for being inserted into the input at the given position.
|
TransactionSignature |
calculateSignature(int inputIndex,
ECKey key,
org.bouncycastle.crypto.params.KeyParameter aesKey,
byte[] redeemScript,
Transaction.SigHash hashType,
boolean anyoneCanPay)
Calculates a signature that is valid for being inserted into the input at the given position.
|
TransactionSignature |
calculateSignature(int inputIndex,
ECKey key,
org.bouncycastle.crypto.params.KeyParameter aesKey,
Script redeemScript,
Transaction.SigHash hashType,
boolean anyoneCanPay)
Calculates a signature that is valid for being inserted into the input at the given position.
|
TransactionSignature |
calculateSignature(int inputIndex,
ECKey key,
Script redeemScript,
Transaction.SigHash hashType,
boolean anyoneCanPay)
Calculates a signature that is valid for being inserted into the input at the given position.
|
TransactionSignature |
calculateWitnessSignature(int inputIndex,
ECKey key,
byte[] scriptCode,
Coin value,
Transaction.SigHash hashType,
boolean anyoneCanPay) |
TransactionSignature |
calculateWitnessSignature(int inputIndex,
ECKey key,
org.bouncycastle.crypto.params.KeyParameter aesKey,
byte[] scriptCode,
Coin value,
Transaction.SigHash hashType,
boolean anyoneCanPay) |
TransactionSignature |
calculateWitnessSignature(int inputIndex,
ECKey key,
org.bouncycastle.crypto.params.KeyParameter aesKey,
Script scriptCode,
Coin value,
Transaction.SigHash hashType,
boolean anyoneCanPay) |
TransactionSignature |
calculateWitnessSignature(int inputIndex,
ECKey key,
Script scriptCode,
Coin value,
Transaction.SigHash hashType,
boolean anyoneCanPay) |
void |
checkCoinBaseHeight(int height)
Check block height is in coinbase input script, for use after BIP 34
enforcement is enabled.
|
void |
clearInputs()
Removes all the inputs from this transaction.
|
void |
clearOutputs()
Removes all the outputs from this transaction.
|
boolean |
equals(java.lang.Object o) |
java.util.Date |
estimateLockTime(AbstractBlockChain chain)
Returns either the lock time as a date, if it was specified in seconds, or an estimate based on the time in
the current head block if it was specified as a block time.
|
Sha256Hash |
findWitnessCommitment()
Loops the outputs of a coinbase transaction to locate the witness commitment.
|
java.util.Map<Sha256Hash,java.lang.Integer> |
getAppearsInHashes()
Returns a map of block [hashes] which contain the transaction mapped to relativity counters, or null if this
transaction doesn't have that data because it's not stored in the wallet or because it has never appeared in a
block.
|
TransactionConfidence |
getConfidence()
Returns the confidence object for this transaction from the
TxConfidenceTable
referenced by the implicit Context . |
TransactionConfidence |
getConfidence(Context context)
Returns the confidence object for this transaction from the
TxConfidenceTable
referenced by the given Context . |
TransactionConfidence |
getConfidence(TxConfidenceTable table)
Returns the confidence object for this transaction from the
TxConfidenceTable |
ExchangeRate |
getExchangeRate()
Getter for
exchangeRate . |
Coin |
getFee()
The transaction fee is the difference of the value of all inputs and the value of all outputs.
|
Sha256Hash |
getHash()
Deprecated.
use
getTxId() |
java.lang.String |
getHashAsString()
Deprecated.
use
getTxId() .toString() |
TransactionInput |
getInput(long index)
Same as getInputs().get(index).
|
java.util.List<TransactionInput> |
getInputs()
Returns an unmodifiable view of all inputs.
|
Coin |
getInputSum()
Gets the sum of the inputs, regardless of who owns them.
|
long |
getLockTime()
Transactions can have an associated lock time, specified either as a block height or in seconds since the
UNIX epoch.
|
java.lang.String |
getMemo()
Returns the transaction
memo . |
int |
getMessageSizeForPriorityCalc()
The priority (coin age) calculation doesn't use the regular message size, but rather one adjusted downwards
for the number of inputs.
|
int |
getOptimalEncodingMessageSize() |
TransactionOutput |
getOutput(long index)
Same as getOutputs().get(index)
|
java.util.List<TransactionOutput> |
getOutputs()
Returns an unmodifiable view of all outputs.
|
Coin |
getOutputSum()
Gets the sum of the outputs of the transaction.
|
Transaction.Purpose |
getPurpose()
Returns the purpose for which this transaction was created.
|
int |
getSigOpCount()
Gets the count of regular SigOps in this transactions
|
Sha256Hash |
getTxId()
Returns the transaction id as you see them in block explorers.
|
java.util.Date |
getUpdateTime()
Returns the earliest time at which the transaction was seen (broadcast or included into the chain),
or the epoch if that information isn't available.
|
Coin |
getValue(TransactionBag wallet)
Returns the difference of
getValueSentToMe(TransactionBag) and getValueSentFromMe(TransactionBag) . |
Coin |
getValueSentFromMe(TransactionBag wallet)
Calculates the sum of the inputs that are spending coins with keys in the wallet.
|
Coin |
getValueSentToMe(TransactionBag transactionBag)
Calculates the sum of the outputs that are sending coins to a key in the wallet.
|
long |
getVersion() |
int |
getVsize()
Gets the virtual transaction size as defined in BIP141.
|
java.util.List<TransactionOutput> |
getWalletOutputs(TransactionBag transactionBag)
Returns the list of transacion outputs, whether spent or unspent, that match a wallet by address or that are
watched by a wallet, i.e., transaction outputs whose script's address is controlled by the wallet and transaction
outputs whose script is watched by the wallet.
|
int |
getWeight()
Gets the transaction weight as defined in BIP141.
|
Sha256Hash |
getWTxId()
Returns the witness transaction id (aka witness id) as per BIP144.
|
boolean |
hasConfidence()
Check if the transaction has a known confidence
|
int |
hashCode() |
Sha256Hash |
hashForSignature(int inputIndex,
byte[] connectedScript,
byte sigHashType)
This is required for signatures which use a sigHashType which cannot be represented using SigHash and anyoneCanPay
See transaction c99c49da4c38af669dea436d3e73780dfdb6c1ecf9958baa52960e8baee30e73, which has sigHashType 0
|
Sha256Hash |
hashForSignature(int inputIndex,
byte[] redeemScript,
Transaction.SigHash type,
boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction.
|
Sha256Hash |
hashForSignature(int inputIndex,
Script redeemScript,
Transaction.SigHash type,
boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction.
|
Sha256Hash |
hashForWitnessSignature(int inputIndex,
byte[] scriptCode,
Coin prevValue,
byte sigHashType) |
Sha256Hash |
hashForWitnessSignature(int inputIndex,
byte[] scriptCode,
Coin prevValue,
Transaction.SigHash type,
boolean anyoneCanPay) |
Sha256Hash |
hashForWitnessSignature(int inputIndex,
Script scriptCode,
Coin prevValue,
Transaction.SigHash type,
boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction.
|
boolean |
hasRelativeLockTime()
A transaction has a relative lock time
(BIP 68) if it is version 2 or
higher and at least one of its inputs has its
TransactionInput.SEQUENCE_LOCKTIME_DISABLE_FLAG cleared. |
boolean |
hasWitnesses() |
boolean |
isAnyOutputSpent()
Returns true if any of the outputs is marked as spent.
|
boolean |
isCoinBase()
A coinbase transaction is one that creates a new coin.
|
boolean |
isEveryOwnedOutputSpent(TransactionBag transactionBag)
Returns false if this transaction has at least one output that is owned by the given wallet and unspent, true
otherwise.
|
boolean |
isFinal(int height,
long blockTimeSeconds)
Returns true if this transaction is considered finalized and can be placed in a block.
|
boolean |
isMature()
A transaction is mature if it is either a building coinbase tx that is as deep or deeper than the required coinbase depth, or a non-coinbase tx.
|
boolean |
isOptInFullRBF()
Returns whether this transaction will opt into the
full replace-by-fee semantics.
|
boolean |
isPending()
Convenience wrapper around getConfidence().getConfidenceType()
|
boolean |
isTimeLocked()
A transaction is time-locked if at least one of its inputs is non-final and it has a lock time.
|
protected void |
parse()
Deserialize according to BIP144 or
the classic format, depending on if the
transaction is segwit or not.
|
void |
setBlockAppearance(StoredBlock block,
boolean bestChain,
int relativityOffset)
Puts the given block in the internal set of blocks in which this transaction appears.
|
void |
setExchangeRate(ExchangeRate exchangeRate)
Setter for
exchangeRate . |
void |
setLockTime(long lockTime)
Transactions can have an associated lock time, specified either as a block height or in seconds since the
UNIX epoch.
|
void |
setMemo(java.lang.String memo)
Set the transaction
memo . |
void |
setPurpose(Transaction.Purpose purpose)
Marks the transaction as being created for the given purpose.
|
void |
setUpdateTime(java.util.Date updatedAt) |
void |
setVersion(int version) |
void |
shuffleOutputs()
Randomly re-orders the transaction outputs: good for privacy
|
java.lang.String |
toString() |
java.lang.String |
toString(AbstractBlockChain chain,
java.lang.CharSequence indent)
A human readable version of the transaction useful for debugging.
|
protected void |
unCache()
To be called before any change of internal values including any setters.
|
void |
verify()
Checks the transaction contents for sanity, in ways that can be done in a standalone manner.
|
adjustLength, adjustLength, setParent
bitcoinSerialize, bitcoinSerialize, getMessageSize, getParams, hasMoreBytes, isCached, isRecached, readByte, readByteArray, readBytes, readHash, readInt64, readStr, readUint32, readUint64, readVarInt, readVarInt, setSerializer, unsafeBitcoinSerialize
public static final java.util.Comparator<Transaction> SORT_TX_BY_UPDATE_TIME
public static final java.util.Comparator<Transaction> SORT_TX_BY_HEIGHT
public static final int SERIALIZE_TRANSACTION_NO_WITNESS
public static final int LOCKTIME_THRESHOLD
public static final java.math.BigInteger LOCKTIME_THRESHOLD_BIG
public static final int MAX_STANDARD_TX_SIZE
public static final Coin REFERENCE_DEFAULT_MIN_TX_FEE
public static final Coin DEFAULT_TX_FEE
@Deprecated public static final Coin MIN_NONDUST_OUTPUT
TransactionOutput.getMinNonDustValue()
public static final byte SIGHASH_ANYONECANPAY_VALUE
public Transaction(NetworkParameters params)
public Transaction(NetworkParameters params, byte[] payloadBytes) throws ProtocolException
ProtocolException
public Transaction(NetworkParameters params, byte[] payload, int offset) throws ProtocolException
ProtocolException
public Transaction(NetworkParameters params, byte[] payload, int offset, @Nullable Message parent, MessageSerializer setSerializer, int length, @Nullable byte[] hashFromHeader) throws ProtocolException
params
- NetworkParameters object.payload
- Bitcoin protocol formatted byte array containing message content.offset
- The location of the first payload byte within the array.parent
- The parent of the transaction.setSerializer
- The serializer to use for this transaction.length
- The length of message if known. Usually this is provided when deserializing of the wire
as the length will be provided as part of the header. If unknown then set to Message.UNKNOWN_LENGTHhashFromHeader
- Used by BitcoinSerializer. The serializer has to calculate a hash for checksumming so to
avoid wasting the considerable effort a set method is provided so the serializer can set it. No verification
is performed on this hash.ProtocolException
public Transaction(NetworkParameters params, byte[] payload, @Nullable Message parent, MessageSerializer setSerializer, int length) throws ProtocolException
ProtocolException
@Deprecated public Sha256Hash getHash()
getTxId()
Message
@Deprecated public java.lang.String getHashAsString()
getTxId()
.toString()public Sha256Hash getTxId()
public Sha256Hash getWTxId()
getTxId()
.public int getWeight()
public int getVsize()
public Coin getInputSum()
public Coin getValueSentToMe(TransactionBag transactionBag)
@Nullable public java.util.Map<Sha256Hash,java.lang.Integer> getAppearsInHashes()
public boolean isPending()
public void setBlockAppearance(StoredBlock block, boolean bestChain, int relativityOffset)
Puts the given block in the internal set of blocks in which this transaction appears. This is used by the wallet to ensure transactions that appear on side chains are recorded properly even though the block stores do not save the transaction data at all.
If there is a re-org this will be called once for each block that was previously seen, to update which block is the best chain. The best chain block is guaranteed to be called last. So this must be idempotent.
Sets updatedAt to be the earliest valid block time where this tx was seen.
block
- The StoredBlock
in which the transaction has appeared.bestChain
- whether to set the updatedAt timestamp from the block header (only if not already set)relativityOffset
- A number that disambiguates the order of transactions within a block.public void addBlockAppearance(Sha256Hash blockHash, int relativityOffset)
public Coin getValueSentFromMe(TransactionBag wallet) throws ScriptException
ScriptException
public Coin getOutputSum()
public Coin getValue(TransactionBag wallet) throws ScriptException
getValueSentToMe(TransactionBag)
and getValueSentFromMe(TransactionBag)
.ScriptException
public Coin getFee()
public boolean isAnyOutputSpent()
public boolean isEveryOwnedOutputSpent(TransactionBag transactionBag)
public java.util.Date getUpdateTime()
public void setUpdateTime(java.util.Date updatedAt)
protected void unCache()
Message
To be called before any change of internal values including any setters. This ensures any cached byte array is removed.
Child messages of this object(e.g. Transactions belonging to a Block) will not have their internal byte caches invalidated unless they are also modified internally.
unCache
in class ChildMessage
protected static int calcLength(byte[] buf, int offset)
protected void parse() throws ProtocolException
parse
in class Message
ProtocolException
public boolean hasWitnesses()
public int getOptimalEncodingMessageSize()
public int getMessageSizeForPriorityCalc()
public boolean isCoinBase()
public boolean isMature()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(@Nullable AbstractBlockChain chain, @Nullable java.lang.CharSequence indent)
chain
- If provided, will be used to estimate lock times (if set). Can be null.public void clearInputs()
public TransactionInput addInput(TransactionOutput from)
addInput(TransactionInput)
and every output is added with
addOutput(TransactionOutput)
, a TransactionSigner
must be used to finalize the transaction and finish the inputs
off. Otherwise it won't be accepted by the network.public TransactionInput addInput(TransactionInput input)
public TransactionInput addInput(Sha256Hash spendTxHash, long outputIndex, Script script)
public TransactionInput addSignedInput(TransactionOutPoint prevOut, Script scriptPubKey, ECKey sigKey, Transaction.SigHash sigHash, boolean anyoneCanPay) throws ScriptException
ScriptException
- if the scriptPubKey is not a pay to address or P2PK script.public TransactionInput addSignedInput(TransactionOutPoint prevOut, Script scriptPubKey, ECKey sigKey) throws ScriptException
addSignedInput(TransactionOutPoint, Script, ECKey, Transaction.SigHash, boolean)
but defaults to Transaction.SigHash.ALL
and "false" for the anyoneCanPay flag. This is normally what you want.ScriptException
public TransactionInput addSignedInput(TransactionOutput output, ECKey signingKey)
public TransactionInput addSignedInput(TransactionOutput output, ECKey signingKey, Transaction.SigHash sigHash, boolean anyoneCanPay)
public void clearOutputs()
public TransactionOutput addOutput(TransactionOutput to)
public TransactionOutput addOutput(Coin value, Address address)
public TransactionOutput addOutput(Coin value, ECKey pubkey)
public TransactionOutput addOutput(Coin value, Script script)
public TransactionSignature calculateSignature(int inputIndex, ECKey key, byte[] redeemScript, Transaction.SigHash hashType, boolean anyoneCanPay)
hashForSignature(int, byte[], Transaction.SigHash, boolean)
followed by ECKey.sign(Sha256Hash)
and then returning a new TransactionSignature
. The key
must be usable for signing as-is: if the key is encrypted it must be decrypted first external to this method.inputIndex
- Which input to calculate the signature for, as an index.key
- The private key used to calculate the signature.redeemScript
- Byte-exact contents of the scriptPubKey that is being satisfied, or the P2SH redeem script.hashType
- Signing mode, see the enum for documentation.anyoneCanPay
- Signing mode, see the SigHash enum for documentation.public TransactionSignature calculateSignature(int inputIndex, ECKey key, Script redeemScript, Transaction.SigHash hashType, boolean anyoneCanPay)
hashForSignature(int, byte[], Transaction.SigHash, boolean)
followed by ECKey.sign(Sha256Hash)
and then returning a new TransactionSignature
.inputIndex
- Which input to calculate the signature for, as an index.key
- The private key used to calculate the signature.redeemScript
- The scriptPubKey that is being satisfied, or the P2SH redeem script.hashType
- Signing mode, see the enum for documentation.anyoneCanPay
- Signing mode, see the SigHash enum for documentation.public TransactionSignature calculateSignature(int inputIndex, ECKey key, @Nullable org.bouncycastle.crypto.params.KeyParameter aesKey, byte[] redeemScript, Transaction.SigHash hashType, boolean anyoneCanPay)
hashForSignature(int, byte[], Transaction.SigHash, boolean)
followed by ECKey.sign(Sha256Hash)
and then returning a new TransactionSignature
. The key
must be usable for signing as-is: if the key is encrypted it must be decrypted first external to this method.inputIndex
- Which input to calculate the signature for, as an index.key
- The private key used to calculate the signature.aesKey
- The AES key to use for decryption of the private key. If null then no decryption is required.redeemScript
- Byte-exact contents of the scriptPubKey that is being satisfied, or the P2SH redeem script.hashType
- Signing mode, see the enum for documentation.anyoneCanPay
- Signing mode, see the SigHash enum for documentation.public TransactionSignature calculateSignature(int inputIndex, ECKey key, @Nullable org.bouncycastle.crypto.params.KeyParameter aesKey, Script redeemScript, Transaction.SigHash hashType, boolean anyoneCanPay)
hashForSignature(int, byte[], Transaction.SigHash, boolean)
followed by ECKey.sign(Sha256Hash)
and then returning a new TransactionSignature
.inputIndex
- Which input to calculate the signature for, as an index.key
- The private key used to calculate the signature.aesKey
- The AES key to use for decryption of the private key. If null then no decryption is required.redeemScript
- The scriptPubKey that is being satisfied, or the P2SH redeem script.hashType
- Signing mode, see the enum for documentation.anyoneCanPay
- Signing mode, see the SigHash enum for documentation.public Sha256Hash hashForSignature(int inputIndex, byte[] redeemScript, Transaction.SigHash type, boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction. How exactly the transaction is simplified is specified by the type and anyoneCanPay parameters.
This is a low level API and when using the regular Wallet
class you don't have to call this yourself.
When working with more complex transaction types and contracts, it can be necessary. When signing a P2SH output
the redeemScript should be the script encoded into the scriptSig field, for normal transactions, it's the
scriptPubKey of the output you're signing for.
inputIndex
- input the signature is being calculated for. Tx signatures are always relative to an input.redeemScript
- the bytes that should be in the given input during signing.type
- Should be SigHash.ALLanyoneCanPay
- should be false.public Sha256Hash hashForSignature(int inputIndex, Script redeemScript, Transaction.SigHash type, boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction. How exactly the transaction is simplified is specified by the type and anyoneCanPay parameters.
This is a low level API and when using the regular Wallet
class you don't have to call this yourself.
When working with more complex transaction types and contracts, it can be necessary. When signing a P2SH output
the redeemScript should be the script encoded into the scriptSig field, for normal transactions, it's the
scriptPubKey of the output you're signing for.
inputIndex
- input the signature is being calculated for. Tx signatures are always relative to an input.redeemScript
- the script that should be in the given input during signing.type
- Should be SigHash.ALLanyoneCanPay
- should be false.public Sha256Hash hashForSignature(int inputIndex, byte[] connectedScript, byte sigHashType)
public TransactionSignature calculateWitnessSignature(int inputIndex, ECKey key, byte[] scriptCode, Coin value, Transaction.SigHash hashType, boolean anyoneCanPay)
public TransactionSignature calculateWitnessSignature(int inputIndex, ECKey key, Script scriptCode, Coin value, Transaction.SigHash hashType, boolean anyoneCanPay)
public TransactionSignature calculateWitnessSignature(int inputIndex, ECKey key, @Nullable org.bouncycastle.crypto.params.KeyParameter aesKey, byte[] scriptCode, Coin value, Transaction.SigHash hashType, boolean anyoneCanPay)
public TransactionSignature calculateWitnessSignature(int inputIndex, ECKey key, @Nullable org.bouncycastle.crypto.params.KeyParameter aesKey, Script scriptCode, Coin value, Transaction.SigHash hashType, boolean anyoneCanPay)
public Sha256Hash hashForWitnessSignature(int inputIndex, byte[] scriptCode, Coin prevValue, Transaction.SigHash type, boolean anyoneCanPay)
public Sha256Hash hashForWitnessSignature(int inputIndex, Script scriptCode, Coin prevValue, Transaction.SigHash type, boolean anyoneCanPay)
Calculates a signature hash, that is, a hash of a simplified form of the transaction. How exactly the transaction is simplified is specified by the type and anyoneCanPay parameters.
This is a low level API and when using the regular Wallet
class you don't have to call this yourself.
When working with more complex transaction types and contracts, it can be necessary. When signing a Witness output
the scriptCode should be the script encoded into the scriptSig field, for normal transactions, it's the
scriptPubKey of the output you're signing for. (See BIP143: https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki)
inputIndex
- input the signature is being calculated for. Tx signatures are always relative to an input.scriptCode
- the script that should be in the given input during signing.prevValue
- the value of the coin being spenttype
- Should be SigHash.ALLanyoneCanPay
- should be false.public Sha256Hash hashForWitnessSignature(int inputIndex, byte[] scriptCode, Coin prevValue, byte sigHashType)
protected void bitcoinSerializeToStream(java.io.OutputStream stream) throws java.io.IOException
Message
bitcoinSerializeToStream
in class Message
java.io.IOException
protected void bitcoinSerializeToStream(java.io.OutputStream stream, boolean useSegwit) throws java.io.IOException
java.io.IOException
public long getLockTime()
public void setLockTime(long lockTime)
public long getVersion()
public void setVersion(int version)
public java.util.List<TransactionInput> getInputs()
public java.util.List<TransactionOutput> getOutputs()
public java.util.List<TransactionOutput> getWalletOutputs(TransactionBag transactionBag)
Returns the list of transacion outputs, whether spent or unspent, that match a wallet by address or that are watched by a wallet, i.e., transaction outputs whose script's address is controlled by the wallet and transaction outputs whose script is watched by the wallet.
transactionBag
- The wallet that controls addresses and watches scripts.public void shuffleOutputs()
public TransactionInput getInput(long index)
public TransactionOutput getOutput(long index)
public TransactionConfidence getConfidence()
TxConfidenceTable
referenced by the implicit Context
.public TransactionConfidence getConfidence(Context context)
TxConfidenceTable
referenced by the given Context
.public TransactionConfidence getConfidence(TxConfidenceTable table)
TxConfidenceTable
public boolean hasConfidence()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int getSigOpCount() throws ScriptException
ScriptException
public void checkCoinBaseHeight(int height) throws VerificationException
VerificationException
public Sha256Hash findWitnessCommitment()
public void verify() throws VerificationException
Checks the transaction contents for sanity, in ways that can be done in a standalone manner. Does not perform all checks on a transaction such as whether the inputs are already spent. Specifically this method verifies:
VerificationException
public boolean isTimeLocked()
A transaction is time-locked if at least one of its inputs is non-final and it has a lock time. A transaction can
also have a relative lock time which this method doesn't tell. Use hasRelativeLockTime()
to find out.
To check if this transaction is final at a given height and time, see isFinal(int, long)
public boolean hasRelativeLockTime()
TransactionInput.SEQUENCE_LOCKTIME_DISABLE_FLAG
cleared.public boolean isOptInFullRBF()
public boolean isFinal(int height, long blockTimeSeconds)
Returns true if this transaction is considered finalized and can be placed in a block. Non-finalized transactions won't be included by miners and can be replaced with newer versions using sequence numbers. This is useful in certain types of contracts, such as micropayment channels.
Note that currently the replacement feature is disabled in Bitcoin Core and will need to be re-activated before this functionality is useful.
public java.util.Date estimateLockTime(AbstractBlockChain chain)
public Transaction.Purpose getPurpose()
Transaction.Purpose
for more
information on the point of this field and what it can be.public void setPurpose(Transaction.Purpose purpose)
Transaction.Purpose
for more
information on the point of this field and what it can be.@Nullable public ExchangeRate getExchangeRate()
exchangeRate
.public void setExchangeRate(ExchangeRate exchangeRate)
exchangeRate
.@Nullable public java.lang.String getMemo()
memo
.public void setMemo(java.lang.String memo)
memo
. It can be used to record the memo of the payment request that initiated the
transaction.