org.bitcoinj.signers

Interface TransactionSigner

All Known Implementing Classes:

CustomTransactionSigner, KeyChainTransactionSigner, LocalTransactionSigner, MissingSigResolutionSigner, NopTransactionSigner, StatelessTransactionSigner

public interface TransactionSigner

Implementations of this interface are intended to sign inputs of the given transaction. Given transaction may already be partially signed or somehow altered by other signers.

To make use of the signer, you need to add it into the wallet by calling Wallet.addTransactionSigner(TransactionSigner). Signer will be serialized along with the wallet data. In order for a wallet to recreate signer after deserialization, each signer should have no-args constructor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TransactionSigner.MissingSignatureException
static class	TransactionSigner.ProposedTransaction This class wraps transaction proposed to complete keeping a metadata that may be updated, used and effectively shared by transaction signers.

Method Summary

Modifier and Type	Method and Description
void	deserialize(byte[] data) Uses given byte array of data to reconstruct internal state of this signer
boolean	isReady() Returns true if this signer is ready to be used.
byte[]	serialize() Returns byte array of data representing state of this signer.
boolean	signInputs(TransactionSigner.ProposedTransaction propTx, KeyBag keyBag) Signs given transaction's inputs.

Method Detail

isReady

boolean isReady()

Returns true if this signer is ready to be used.

serialize

byte[] serialize()

Returns byte array of data representing state of this signer. It's used to serialize/deserialize this signer

deserialize

void deserialize(byte[] data)

Uses given byte array of data to reconstruct internal state of this signer

signInputs

boolean signInputs(TransactionSigner.ProposedTransaction propTx,
                   KeyBag keyBag)

Signs given transaction's inputs. Returns true if signer is compatible with given transaction (can do something meaningful with it). Otherwise this method returns false