Package org.bitcoinj.wallet

Class Wallet

java.lang.Object
org.bitcoinj.utils.BaseTaggableObject
org.bitcoinj.wallet.Wallet
All Implemented Interfaces:
AddressParser, NewBestBlockListener, ReorganizeListener, TransactionReceivedInBlockListener, PeerFilterProvider, TransactionBag, TaggableObject, KeyBag
public class Wallet extends BaseTaggableObject implements NewBestBlockListener, TransactionReceivedInBlockListener, PeerFilterProvider, KeyBag, TransactionBag, ReorganizeListener, AddressParser

A Wallet stores keys and a record of transactions that send and receive value from those keys. Using these, it is able to create new transactions that spend the recorded transactions, and this is the fundamental operation of the Bitcoin protocol.

To learn more about this class, read working with the wallet.

To fill up a Wallet with transactions, you need to use it in combination with a BlockChain and various other objects, see the Getting started tutorial on the website to learn more about how to set everything up.

Wallets can be serialized using protocol buffers. You need to save the wallet whenever it changes, there is an auto-save feature that simplifies this for you although you're still responsible for manually triggering a save when your app is about to quit because the auto-save feature waits a moment before actually committing to disk to avoid IO thrashing when the wallet is changing very fast (e.g. due to a block chain sync). See autosaveToFile(File, long, TimeUnit, WalletFiles.Listener) for more information about this.

  • Field Details

  • Constructor Details

  • Method Details

    • createDeterministic

      public static Wallet createDeterministic(Network network, ScriptType outputScriptType)
      Creates a new, empty wallet with a randomly chosen seed and no transactions. Make sure to provide for sufficient backup! Any keys will be derived from the seed. If you want to restore a wallet from disk instead, see loadFromFile(java.io.File, org.bitcoinj.wallet.WalletExtension...).
      Parameters:
      network - network wallet will operate on
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      Returns:
      A new empty wallet

    • createDeterministic

      @Deprecated public static Wallet createDeterministic(NetworkParameters params, ScriptType outputScriptType)
      Deprecated.
      use createDeterministic(Network, ScriptType)

    • createDeterministic

      public static Wallet createDeterministic(Network network, ScriptType outputScriptType, KeyChainGroupStructure keyChainGroupStructure)
      Creates a new, empty wallet with a randomly chosen seed and no transactions. Make sure to provide for sufficient backup! Any keys will be derived from the seed. If you want to restore a wallet from disk instead, see loadFromFile(java.io.File, org.bitcoinj.wallet.WalletExtension...).
      Parameters:
      network - network wallet will operate on
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      keyChainGroupStructure - structure (e.g. BIP32 or BIP43)
      Returns:
      A new empty wallet

    • createDeterministic

      @Deprecated public static Wallet createDeterministic(NetworkParameters params, ScriptType outputScriptType, KeyChainGroupStructure keyChainGroupStructure)
      Deprecated.
      use createDeterministic(Network, ScriptType, KeyChainGroupStructure)

    • createBasic

      public static Wallet createBasic(Network network)
      Creates a new, empty wallet with just a basic keychain and no transactions. No deterministic chains will be created automatically. This is meant for when you just want to import a few keys and operate on them.
      Parameters:
      network - network wallet will operate on

    • createBasic

      @Deprecated public static Wallet createBasic(NetworkParameters params)
      Deprecated.
      use createBasic(Network)

    • fromSeed

      public static Wallet fromSeed(Network network, DeterministicSeed seed, ScriptType outputScriptType)
      Parameters:
      network - network wallet will operate on
      seed - deterministic seed
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      Returns:
      a wallet from a deterministic seed with a default account path

    • fromSeed

      @Deprecated public static Wallet fromSeed(NetworkParameters params, DeterministicSeed seed, ScriptType outputScriptType)
      Deprecated.
      use fromSeed(Network, DeterministicSeed, ScriptType)

    • fromSeed

      public static Wallet fromSeed(Network network, DeterministicSeed seed, ScriptType outputScriptType, KeyChainGroupStructure structure)
      Parameters:
      network - network wallet will operate on
      seed - deterministic seed
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      structure - structure for your wallet
      Returns:
      a wallet from a deterministic seed with a default account path

    • fromSeed

      @Deprecated public static Wallet fromSeed(NetworkParameters params, DeterministicSeed seed, ScriptType outputScriptType, KeyChainGroupStructure structure)
      Deprecated.
      use fromSeed(Network, DeterministicSeed, ScriptType, KeyChainGroupStructure)

    • fromSeed

      public static Wallet fromSeed(Network network, DeterministicSeed seed, ScriptType outputScriptType, List<ChildNumber> accountPath)
      Parameters:
      network - network wallet will operate on
      seed - deterministic seed
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      accountPath - account path to generate receiving addresses on
      Returns:
      an instance of a wallet from a deterministic seed.

    • fromSeed

      @Deprecated public static Wallet fromSeed(NetworkParameters params, DeterministicSeed seed, ScriptType outputScriptType, List<ChildNumber> accountPath)
      Deprecated.
      use fromSeed(Network, DeterministicSeed, ScriptType, List)

    • fromWatchingKey

      public static Wallet fromWatchingKey(Network network, DeterministicKey watchKey, ScriptType outputScriptType)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given watching key. This HAS to be an account key as returned by DeterministicKeyChain.getWatchingKey().

    • fromWatchingKey

      @Deprecated public static Wallet fromWatchingKey(NetworkParameters params, DeterministicKey watchKey, ScriptType outputScriptType)
      Deprecated.
      use fromWatchingKey(Network, DeterministicKey, ScriptType)

    • fromWatchingKeyB58

      public static Wallet fromWatchingKeyB58(Network network, String watchKeyB58, Instant creationTime)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given watching key. The account path is specified.
      Parameters:
      network - network wallet will operate on
      watchKeyB58 - The key in base58 notation
      creationTime - creation time of the key (if unknown use fromWatchingKeyB58(Network, String)
      Returns:
      a new wallet

    • fromWatchingKeyB58

      @Deprecated public static Wallet fromWatchingKeyB58(NetworkParameters params, String watchKeyB58, Instant creationTime)
      Deprecated.
      use fromWatchingKeyB58(Network, String, Instant)

    • fromWatchingKeyB58

      public static Wallet fromWatchingKeyB58(Network network, String watchKeyB58)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given watching key. The account path is specified. The key's creation time will be set to DeterministicHierarchy.BIP32_STANDARDISATION_TIME
      Parameters:
      network - network wallet will operate on
      watchKeyB58 - The key in base58 notation
      Returns:
      a new wallet

    • fromWatchingKeyB58

      @Deprecated public static Wallet fromWatchingKeyB58(NetworkParameters params, String watchKeyB58)
      Deprecated.
      use fromWatchingKeyB58(Network, String)

    • fromWatchingKeyB58

      @Deprecated public static Wallet fromWatchingKeyB58(NetworkParameters params, String watchKeyB58, long creationTimeSeconds)
      Deprecated.
      Use fromWatchingKeyB58(Network, String, Instant) or fromWatchingKeyB58(Network, String)

    • fromSpendingKey

      public static Wallet fromSpendingKey(Network network, DeterministicKey spendKey, ScriptType outputScriptType)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given spending key. This HAS to be an account key as returned by DeterministicKeyChain.getWatchingKey(). This wallet can also spend.
      Parameters:
      network - network wallet will operate on

    • fromSpendingKey

      @Deprecated public static Wallet fromSpendingKey(NetworkParameters params, DeterministicKey spendKey, ScriptType outputScriptType)
      Deprecated.
      use fromSpendingKey(Network, DeterministicKey, ScriptType)

    • fromSpendingKeyB58

      public static Wallet fromSpendingKeyB58(Network network, String spendingKeyB58, Instant creationTime)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given spending key.
      Parameters:
      network - network wallet will operate on
      spendingKeyB58 - The key in base58 notation
      creationTime - creation time of the key (if unknown use fromWatchingKeyB58(Network, String)
      Returns:
      a new wallet

    • fromSpendingKeyB58

      @Deprecated public static Wallet fromSpendingKeyB58(NetworkParameters params, String spendingKeyB58, Instant creationTime)
      Deprecated.
      use fromWatchingKeyB58(Network, String, Instant)

    • fromSpendingKeyB58

      public static Wallet fromSpendingKeyB58(Network network, String spendingKeyB58)
      Creates a wallet that tracks payments to and from the HD key hierarchy rooted by the given spending key. The key's creation time will be set to DeterministicHierarchy.BIP32_STANDARDISATION_TIME.
      Parameters:
      network - network wallet will operate on
      spendingKeyB58 - The key in base58 notation
      Returns:
      a new wallet

    • fromSpendingKeyB58

      @Deprecated public static Wallet fromSpendingKeyB58(NetworkParameters params, String spendingKeyB58)
      Deprecated.
      use fromSpendingKeyB58(Network, String)

    • fromSpendingKeyB58

      @Deprecated public static Wallet fromSpendingKeyB58(NetworkParameters params, String spendingKeyB58, long creationTimeSeconds)
      Deprecated.
      Use fromSpendingKeyB58(Network, String, Instant) or fromSpendingKeyB58(Network, String)

    • fromMasterKey

      public static Wallet fromMasterKey(Network network, DeterministicKey masterKey, ScriptType outputScriptType, ChildNumber accountNumber)
      Creates a spending wallet that tracks payments to and from a BIP32-style HD key hierarchy rooted by masterKey and accountNumber. The account path must be directly below the master key as in BIP-32.

      This method should not be used for BIP-43 compliant wallets or accounts not of the form m/accountNumber'.

      This wallet will not store the masterKey, only the account key.

      Parameters:
      network - network the wallet will operate on
      masterKey - root private key (e.g. path m)
      outputScriptType - type of addresses (aka output scripts) to generate for receiving
      accountNumber - account number to append, resulting in an account path of m/accountNumber'
      Returns:
      newly created Wallet object

    • fromMasterKey

      @Deprecated public static Wallet fromMasterKey(NetworkParameters params, DeterministicKey masterKey, ScriptType outputScriptType, ChildNumber accountNumber)
      Deprecated.
      use fromMasterKey(Network, DeterministicKey, ScriptType, ChildNumber)

    • network

      public Network network()

    • getNetworkParameters

      @Deprecated public NetworkParameters getNetworkParameters()
      Deprecated.
      Use network()

    • parseAddress

      public Address parseAddress(String addressString) throws AddressFormatException
      Parse an address string using all formats this wallet knows about for the wallet's network type
      Specified by:
      parseAddress in interface AddressParser
      Parameters:
      addressString - Address string to parse
      Returns:
      A validated address
      Throws:
      AddressFormatException - if invalid string

    • getActiveKeyChains

      public List<DeterministicKeyChain> getActiveKeyChains()
      Gets the active keychains via KeyChainGroup.getActiveKeyChains(Instant).

    • getActiveKeyChain

      public DeterministicKeyChain getActiveKeyChain()
      Gets the default active keychain via KeyChainGroup.getActiveKeyChain().

    • addTransactionSigner

      public final void addTransactionSigner(TransactionSigner signer)

      Adds given transaction signer to the list of signers. It will be added to the end of the signers list, so if this wallet already has some signers added, given signer will be executed after all of them.

      Transaction signer should be fully initialized before adding to the wallet, otherwise IllegalStateException will be thrown

    • getTransactionSigners

      public List<TransactionSigner> getTransactionSigners()

    • currentKey

      public DeterministicKey currentKey(KeyChain.KeyPurpose purpose)
      Returns a key that hasn't been seen in a transaction yet, and which is suitable for displaying in a wallet user interface as "a convenient key to receive funds on" when the purpose parameter is KeyChain.KeyPurpose.RECEIVE_FUNDS. The returned key is stable until it's actually seen in a pending or confirmed transaction, at which point this method will start returning a different key (for each purpose independently).

    • currentReceiveKey

      public DeterministicKey currentReceiveKey()
      An alias for calling currentKey(KeyChain.KeyPurpose) with KeyChain.KeyPurpose.RECEIVE_FUNDS as the parameter.

    • currentAddress

      public Address currentAddress(KeyChain.KeyPurpose purpose)
      Returns address for a currentKey(KeyChain.KeyPurpose)

    • currentReceiveAddress

      public Address currentReceiveAddress()
      An alias for calling currentAddress(KeyChain.KeyPurpose) with KeyChain.KeyPurpose.RECEIVE_FUNDS as the parameter.

    • freshKey

      public DeterministicKey freshKey(KeyChain.KeyPurpose purpose)
      Returns a key that has not been returned by this method before (fresh). You can think of this as being a newly created key, although the notion of "create" is not really valid for a DeterministicKeyChain. When the parameter is KeyChain.KeyPurpose.RECEIVE_FUNDS the returned key is suitable for being put into a receive coins wizard type UI. You should use this when the user is definitely going to hand this key out to someone who wishes to send money.

    • freshKeys

      public List<DeterministicKey> freshKeys(KeyChain.KeyPurpose purpose, int numberOfKeys)
      Returns a key/s that has not been returned by this method before (fresh). You can think of this as being a newly created key/s, although the notion of "create" is not really valid for a DeterministicKeyChain. When the parameter is KeyChain.KeyPurpose.RECEIVE_FUNDS the returned key is suitable for being put into a receive coins wizard type UI. You should use this when the user is definitely going to hand this key/s out to someone who wishes to send money.

    • freshReceiveKey

      public DeterministicKey freshReceiveKey()
      An alias for calling freshKey(KeyChain.KeyPurpose) with KeyChain.KeyPurpose.RECEIVE_FUNDS as the parameter.

    • freshAddress

      public Address freshAddress(KeyChain.KeyPurpose purpose)
      Returns address for a freshKey(KeyChain.KeyPurpose)

    • freshReceiveAddress

      public Address freshReceiveAddress()
      An alias for calling freshAddress(KeyChain.KeyPurpose) with KeyChain.KeyPurpose.RECEIVE_FUNDS as the parameter.

    • freshReceiveAddress

      public Address freshReceiveAddress(ScriptType scriptType)

      Returns a fresh receive address for a given ScriptType.

      This method is meant for when you really need a fallback address. Normally, you should be using freshAddress(KeyChain.KeyPurpose) or currentAddress(KeyChain.KeyPurpose).

    • getIssuedReceiveKeys

      public List<ECKey> getIssuedReceiveKeys()
      Returns only the keys that have been issued by freshReceiveKey(), freshReceiveAddress(), currentReceiveKey() or currentReceiveAddress().

    • getIssuedReceiveAddresses

      public List<Address> getIssuedReceiveAddresses()
      Returns only the addresses that have been issued by freshReceiveKey(), freshReceiveAddress(), currentReceiveKey() or currentReceiveAddress().

    • upgradeToDeterministic

      public void upgradeToDeterministic(ScriptType outputScriptType, @Nullable AesKey aesKey) throws DeterministicUpgradeRequiresPassword
      Upgrades the wallet to be deterministic (BIP32). You should call this, possibly providing the users encryption key, after loading a wallet produced by previous versions of bitcoinj. If the wallet is encrypted the key must be provided, due to the way the seed is derived deterministically from private key bytes: failing to do this will result in an exception being thrown. For non-encrypted wallets, the upgrade will be done for you automatically the first time a new key is requested (this happens when spending due to the change address).
      Throws:
      DeterministicUpgradeRequiresPassword

    • upgradeToDeterministic

      public void upgradeToDeterministic(ScriptType outputScriptType, KeyChainGroupStructure structure, @Nullable AesKey aesKey) throws DeterministicUpgradeRequiresPassword
      Upgrades the wallet to be deterministic (BIP32). You should call this, possibly providing the users encryption key, after loading a wallet produced by previous versions of bitcoinj. If the wallet is encrypted the key must be provided, due to the way the seed is derived deterministically from private key bytes: failing to do this will result in an exception being thrown. For non-encrypted wallets, the upgrade will be done for you automatically the first time a new key is requested (this happens when spending due to the change address).
      Throws:
      DeterministicUpgradeRequiresPassword

    • isDeterministicUpgradeRequired

      public boolean isDeterministicUpgradeRequired(ScriptType outputScriptType)
      Returns true if the wallet contains random keys and no HD chains, in which case you should call upgradeToDeterministic(ScriptType, AesKey) before attempting to do anything that would require a new address or key.

    • getWatchedScripts

      public List<Script> getWatchedScripts()
      Returns a snapshot of the watched scripts. This view is not live.

    • removeKey

      public boolean removeKey(ECKey key)
      Removes the given key from the basicKeyChain. Be very careful with this - losing a private key destroys the money associated with it.
      Returns:
      Whether the key was removed or not.

    • getKeyChainGroupSize

      public int getKeyChainGroupSize()
      Returns the number of keys in the key chain group, including lookahead keys.

    • getKeyChainGroupCombinedKeyLookaheadEpochs

      public int getKeyChainGroupCombinedKeyLookaheadEpochs()

    • getImportedKeys

      public List<ECKey> getImportedKeys()
      Returns a list of the non-deterministic keys that have been imported into the wallet, or the empty list if none.

    • currentChangeAddress

      public Address currentChangeAddress()
      Returns the address used for change outputs. Note: this will probably go away in future.

    • importKey

      public boolean importKey(ECKey key)

      Imports the given ECKey to the wallet.

      If the wallet is configured to auto save to a file, triggers a save immediately. Runs the onKeysAdded event handler. If the key already exists in the wallet, does nothing and returns false.

    • importKeys

      public int importKeys(List<ECKey> keys)
      Imports the given keys to the wallet. If autosaveToFile(File, long, TimeUnit, WalletFiles.Listener) has been called, triggers an auto save bypassing the normal coalescing delay and event handlers. Returns the number of keys added, after duplicates are ignored. The onKeyAdded event will be called for each key in the list that was not already present.

    • importKeysAndEncrypt

      public int importKeysAndEncrypt(List<ECKey> keys, CharSequence password)
      Takes a list of keys and a password, then encrypts and imports them in one step using the current keycrypter.

    • importKeysAndEncrypt

      public int importKeysAndEncrypt(List<ECKey> keys, AesKey aesKey)
      Takes a list of keys and an AES key, then encrypts and imports them in one step using the current keycrypter.

    • addAndActivateHDChain

      public void addAndActivateHDChain(DeterministicKeyChain chain)
      Add a pre-configured keychain to the wallet. Useful for setting up a complex keychain, such as for a married wallet (which is not supported any more).

    • getKeyChainGroupLookaheadSize

      public int getKeyChainGroupLookaheadSize()
      See DeterministicKeyChain.setLookaheadSize(int) for more info on this.

    • getKeyChainGroupLookaheadThreshold

      public int getKeyChainGroupLookaheadThreshold()
      See DeterministicKeyChain.setLookaheadThreshold(int) for more info on this.

    • getWatchingKey

      public DeterministicKey getWatchingKey()
      Returns a public-only DeterministicKey that can be used to set up a watching wallet: that is, a wallet that can import transactions from the block chain just as the normal wallet can, but which cannot spend. Watching wallets are very useful for things like web servers that accept payments. This key corresponds to the account zero key in the recommended BIP32 hierarchy.

    • isWatching

      public boolean isWatching()
      Returns whether this wallet consists entirely of watching keys (unencrypted keys with no private part). Mixed wallets are forbidden.
      Throws:
      IllegalStateException - if there are no keys, or if there is a mix between watching and non-watching keys.

    • isAddressWatched

      public boolean isAddressWatched(Address address)
      Return true if we are watching this address.

    • addWatchedAddress

      public boolean addWatchedAddress(Address address)
      Same as addWatchedAddress(Address, long) with the current time as the creation time.

    • addWatchedAddress

      public boolean addWatchedAddress(Address address, Instant creationTime)
      Adds the given address to the wallet to be watched. Outputs can be retrieved by getWatchedOutputs(boolean).
      Parameters:
      creationTime - creation time, for scanning the blockchain
      Returns:
      whether the address was added successfully (not already present)

    • addWatchedAddress

      @Deprecated public boolean addWatchedAddress(Address address, long creationTime)
      Deprecated.
      use addWatchedAddress(Address, Instant) or addWatchedAddress(Address)

    • addWatchedAddresses

      public int addWatchedAddresses(List<Address> addresses, Instant creationTime)
      Adds the given addresses to the wallet to be watched. Outputs can be retrieved by getWatchedOutputs(boolean).
      Parameters:
      addresses - addresses to be watched
      creationTime - creation time of the addresses
      Returns:
      how many addresses were added successfully

    • addWatchedAddresses

      public int addWatchedAddresses(List<Address> addresses)
      Adds the given addresses to the wallet to be watched. Outputs can be retrieved by getWatchedOutputs(boolean). Use this if the creation time of the addresses is unknown.
      Parameters:
      addresses - addresses to be watched
      Returns:
      how many addresses were added successfully

    • addWatchedAddresses

      @Deprecated public int addWatchedAddresses(List<Address> addresses, long creationTime)
      Deprecated.
      use addWatchedAddresses(List, Instant) or addWatchedAddresses(List)

    • addWatchedScripts

      public int addWatchedScripts(List<Script> scripts)
      Adds the given output scripts to the wallet to be watched. Outputs can be retrieved by getWatchedOutputs(boolean). If a script is already being watched, the object is replaced with the one in the given list. As Script equality is defined in terms of program bytes only this lets you update metadata such as creation time. Note that you should be careful not to add scripts with a creation time of zero (the default!) because otherwise it will disable the important wallet checkpointing optimisation.
      Returns:
      how many scripts were added successfully

    • removeWatchedAddress

      public boolean removeWatchedAddress(Address address)
      Removes the given output scripts from the wallet that were being watched.
      Returns:
      true if successful

    • removeWatchedAddresses

      public boolean removeWatchedAddresses(List<Address> addresses)
      Removes the given output scripts from the wallet that were being watched.
      Returns:
      true if successful

    • removeWatchedScripts

      public boolean removeWatchedScripts(List<Script> scripts)
      Removes the given output scripts from the wallet that were being watched.
      Returns:
      true if successful

    • getWatchedAddresses

      public List<Address> getWatchedAddresses()
      Returns all addresses watched by this wallet.

    • findKeyFromPubKeyHash

      @Nullable public ECKey findKeyFromPubKeyHash(byte[] pubKeyHash, @Nullable ScriptType scriptType)
      Locates a keypair from the basicKeyChain given the hash of the public key. This is needed when finding out which key we need to use to redeem a transaction output.
      Specified by:
      findKeyFromPubKeyHash in interface KeyBag
      Parameters:
      pubKeyHash - hash of the keypair to look for
      scriptType - only look for given usage (currently ScriptType.P2PKH or ScriptType.P2WPKH) or null if we don't care
      Returns:
      ECKey object or null if no such key was found.

    • hasKey

      public boolean hasKey(ECKey key)
      Returns true if the given key is in the wallet, false otherwise. Currently an O(N) operation.

    • isAddressMine

      public boolean isAddressMine(Address address)
      Returns true if the address is belongs to this wallet.

    • isPubKeyHashMine

      public boolean isPubKeyHashMine(byte[] pubKeyHash, @Nullable ScriptType scriptType)
      Description copied from interface: TransactionBag
      Look for a public key which hashes to the given hash and (optionally) is used for a specific script type.
      Specified by:
      isPubKeyHashMine in interface TransactionBag
      Parameters:
      pubKeyHash - hash of the public key to look for
      scriptType - only look for given usage (currently ScriptType.P2PKH or ScriptType.P2WPKH) or null if we don't care
      Returns:
      true if hash was found

    • isWatchedScript

      public boolean isWatchedScript(Script script)
      Description copied from interface: TransactionBag
      Returns true if this wallet is watching transactions for outputs with the script.
      Specified by:
      isWatchedScript in interface TransactionBag

    • findKeyFromAddress

      public ECKey findKeyFromAddress(Address address)
      Locates a keypair from the wallet given the corresponding address.
      Returns:
      ECKey or null if no such key was found.

    • findKeyFromPubKey

      @Nullable public ECKey findKeyFromPubKey(byte[] pubKey)
      Locates a keypair from the basicKeyChain given the raw public key bytes.
      Specified by:
      findKeyFromPubKey in interface KeyBag
      Returns:
      ECKey or null if no such key was found.

    • isPubKeyMine

      public boolean isPubKeyMine(byte[] pubKey)
      Description copied from interface: TransactionBag
      Returns true if this wallet contains a keypair with the given public key.
      Specified by:
      isPubKeyMine in interface TransactionBag

    • findRedeemDataFromScriptHash

      @Nullable public RedeemData findRedeemDataFromScriptHash(byte[] payToScriptHash)
      Locates a redeem data (redeem script and keys) from the keyChainGroup given the hash of the script. Returns RedeemData object or null if no such data was found.
      Specified by:
      findRedeemDataFromScriptHash in interface KeyBag

    • isPayToScriptHashMine

      public boolean isPayToScriptHashMine(byte[] payToScriptHash)
      Description copied from interface: TransactionBag
      Returns true if this wallet knows the script corresponding to the given hash.
      Specified by:
      isPayToScriptHashMine in interface TransactionBag

    • getKeyChainSeed

      public DeterministicSeed getKeyChainSeed()
      Returns the immutable seed for the current active HD chain.
      Throws:
      ECKey.MissingPrivateKeyException - if the seed is unavailable (watching wallet)

    • getKeyByPath

      public DeterministicKey getKeyByPath(List<ChildNumber> path)
      Returns a key for the given HD path, assuming it's already been derived. You normally shouldn't use this: use currentReceiveKey/freshReceiveKey instead.

    • encrypt

      public void encrypt(CharSequence password)
      Convenience wrapper around encrypt(KeyCrypter, AesKey) which uses the default Scrypt key derivation algorithm and parameters to derive a key from the given password.

    • encrypt

      public void encrypt(KeyCrypter keyCrypter, AesKey aesKey)
      Encrypt the wallet using the KeyCrypter and the AES key. A good default KeyCrypter to use is KeyCrypterScrypt.
      Parameters:
      keyCrypter - The KeyCrypter that specifies how to encrypt/ decrypt a key
      aesKey - AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
      Throws:
      KeyCrypterException - Thrown if the wallet encryption fails. If so, the wallet state is unchanged.

    • decrypt

      public void decrypt(CharSequence password) throws Wallet.BadWalletEncryptionKeyException
      Decrypt the wallet with the wallets keyCrypter and password.
      Throws:
      Wallet.BadWalletEncryptionKeyException - Thrown if the given password is wrong. If so, the wallet state is unchanged.
      KeyCrypterException - Thrown if the wallet decryption fails. If so, the wallet state is unchanged.

    • decrypt

      public void decrypt(AesKey aesKey) throws Wallet.BadWalletEncryptionKeyException
      Decrypt the wallet with the wallets keyCrypter and AES key.
      Parameters:
      aesKey - AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
      Throws:
      Wallet.BadWalletEncryptionKeyException - Thrown if the given aesKey is wrong. If so, the wallet state is unchanged.
      KeyCrypterException - Thrown if the wallet decryption fails. If so, the wallet state is unchanged.

    • checkPassword

      public boolean checkPassword(CharSequence password)
      Check whether the password can decrypt the first key in the wallet. This can be used to check the validity of an entered password.
      Returns:
      boolean true if password supplied can decrypt the first private key in the wallet, false otherwise.
      Throws:
      IllegalStateException - if the wallet is not encrypted.

    • checkAESKey

      public boolean checkAESKey(AesKey aesKey)
      Check whether the AES key can decrypt the first encrypted key in the wallet.
      Returns:
      boolean true if AES key supplied can decrypt the first encrypted private key in the wallet, false otherwise.

    • getKeyCrypter

      @Nullable public KeyCrypter getKeyCrypter()
      Get the wallet's KeyCrypter, or null if the wallet is not encrypted. (Used in encrypting/ decrypting an ECKey).

    • getEncryptionType

      public org.bitcoinj.protobuf.wallet.Protos.Wallet.EncryptionType getEncryptionType()
      Get the type of encryption used for this wallet. (This is a convenience method - the encryption type is actually stored in the keyCrypter).

    • isEncrypted

      public boolean isEncrypted()
      Returns true if the wallet is encrypted using any scheme, false if not.

    • changeEncryptionPassword

      public void changeEncryptionPassword(CharSequence currentPassword, CharSequence newPassword) throws Wallet.BadWalletEncryptionKeyException
      Changes wallet encryption password, this is atomic operation.
      Throws:
      Wallet.BadWalletEncryptionKeyException - Thrown if the given currentPassword is wrong. If so, the wallet state is unchanged.
      KeyCrypterException - Thrown if the wallet decryption fails. If so, the wallet state is unchanged.

    • changeEncryptionKey

      public void changeEncryptionKey(KeyCrypter keyCrypter, AesKey currentAesKey, AesKey newAesKey) throws Wallet.BadWalletEncryptionKeyException
      Changes wallet AES encryption key, this is atomic operation.
      Throws:
      Wallet.BadWalletEncryptionKeyException - Thrown if the given currentAesKey is wrong. If so, the wallet state is unchanged.
      KeyCrypterException - Thrown if the wallet decryption fails. If so, the wallet state is unchanged.

    • serializeKeyChainGroupToProtobuf

      @Deprecated public List<org.bitcoinj.protobuf.wallet.Protos.Key> serializeKeyChainGroupToProtobuf()
      Deprecated.

    • saveToFile

      public void saveToFile(File tempFile, File destFile) throws IOException
      Saves the wallet first to the given temporary file, then renames to the destination file. This is done to make the save an atomic operation.
      Parameters:
      tempFile - temporary file to use for saving the wallet
      destFile - file to save the wallet to
      Throws:
      FileNotFoundException - if directory doesn't exist
      IOException - if an error occurs while saving

    • saveToFile

      public void saveToFile(File f) throws IOException
      Uses protobuf serialization to save the wallet to the given file. To learn more about this file format, see WalletProtobufSerializer. Writes out first to a temporary file in the same directory and then renames once written.
      Parameters:
      f - File to save wallet
      Throws:
      FileNotFoundException - if directory doesn't exist
      IOException - if an error occurs while saving

    • setAcceptRiskyTransactions

      public void setAcceptRiskyTransactions(boolean acceptRiskyTransactions)

      Whether or not the wallet will ignore pending transactions that fail the selected RiskAnalysis. By default, if a transaction is considered risky then it won't enter the wallet and won't trigger any event listeners. If you set this property to true, then all transactions will be allowed in regardless of risk. For example, the DefaultRiskAnalysis checks for non-finality of transactions.

      Note that this property is not serialized. You have to set it each time a Wallet object is constructed, even if it's loaded from a protocol buffer.

    • isAcceptRiskyTransactions

      public boolean isAcceptRiskyTransactions()
      See setAcceptRiskyTransactions(boolean) for an explanation of this property.

    • setRiskAnalyzer

      public void setRiskAnalyzer(RiskAnalysis.Analyzer analyzer)
      Sets the RiskAnalysis implementation to use for deciding whether received pending transactions are risky or not. If the analyzer says a transaction is risky, by default it will be dropped. You can customize this behaviour with setAcceptRiskyTransactions(boolean).

    • getRiskAnalyzer

      public RiskAnalysis.Analyzer getRiskAnalyzer()
      Gets the current RiskAnalysis implementation. The default is DefaultRiskAnalysis.

    • autosaveToFile

      public WalletFiles autosaveToFile(File f, Duration delay, @Nullable WalletFiles.Listener eventListener)

      Sets up the wallet to auto-save itself to the given file, using temp files with atomic renames to ensure consistency. After connecting to a file, you no longer need to save the wallet manually, it will do it whenever necessary. Protocol buffer serialization will be used.

      A background thread will be created and the wallet will only be saved to disk every periodically. If no changes have occurred for the given time period, nothing will be written. In this way disk IO can be rate limited. It's a good idea to set this as otherwise the wallet can change very frequently, e.g. if there are a lot of transactions in it or during block sync, and there will be a lot of redundant writes. Note that when a new key is added, that always results in an immediate save regardless of delayTime. You should still save the wallet manually using saveToFile(File) when your program is about to shut down as the JVM will not wait for the background thread.

      An event listener can be provided. It will be called on a background thread with the wallet locked when an auto-save occurs.

      Parameters:
      f - The destination file to save to.
      delay - How much time to wait until saving the wallet on a background thread.
      eventListener - callback to be informed when the auto-save thread does things, or null

    • autosaveToFile

      @Deprecated public WalletFiles autosaveToFile(File f, long delayTime, TimeUnit timeUnit, @Nullable WalletFiles.Listener eventListener)
      Deprecated.
      use autosaveToFile(File, Duration, WalletFiles.Listener)

    • shutdownAutosaveAndWait

      public void shutdownAutosaveAndWait()

      Disables auto-saving, after it had been enabled with autosaveToFile(File, long, TimeUnit, WalletFiles.Listener) before. This method blocks until finished.

    • saveLater

      protected void saveLater()
      Requests an asynchronous save on a background thread

    • saveNow

      protected void saveNow()
      If auto saving is enabled, do an immediate sync write to disk ignoring any delays.

    • saveToFileStream

      public void saveToFileStream(OutputStream f) throws IOException
      Uses protobuf serialization to save the wallet to the given file stream. To learn more about this file format, see WalletProtobufSerializer.
      Throws:
      IOException

    • getParams

      @Deprecated public NetworkParameters getParams()
      Deprecated.
      Use network()
      Returns the parameters this wallet was created with.

    • loadFromFile

      public static Wallet loadFromFile(File file, @Nullable WalletExtension... walletExtensions) throws UnreadableWalletException
      Returns a wallet deserialized from the given file. Extensions previously saved with the wallet can be deserialized by calling @WalletExtension.deserializeWalletExtension(Wallet, byte[])}
      Parameters:
      file - the wallet file to read
      walletExtensions - extensions possibly added to the wallet.
      Returns:
      The Wallet
      Throws:
      UnreadableWalletException - if there was a problem loading or parsing the file

    • loadFromFile

      public static Wallet loadFromFile(File file, WalletProtobufSerializer.WalletFactory factory, boolean forceReset, boolean ignoreMandatoryExtensions, @Nullable WalletExtension... walletExtensions) throws UnreadableWalletException
      Returns a wallet deserialized from the given file. Extensions previously saved with the wallet can be deserialized by calling @WalletExtension.deserializeWalletExtension(Wallet, byte[])}
      Parameters:
      file - the wallet file to read
      factory - wallet factory
      forceReset - force a reset of the wallet
      ignoreMandatoryExtensions - if true, mandatory extensions will be ignored instead of causing load errors (not recommended)
      walletExtensions - extensions possibly added to the wallet.
      Returns:
      The Wallet
      Throws:
      UnreadableWalletException - if there was a problem loading or parsing the file

    • isConsistent

      public boolean isConsistent()
      Returns if this wallet is structurally consistent, so e.g. no duplicate transactions. First inconsistency and a dump of the wallet will be logged.

    • isConsistentOrThrow

      public void isConsistentOrThrow() throws IllegalStateException
      Variant of isConsistent() that throws an IllegalStateException describing the first inconsistency.
      Throws:
      IllegalStateException

    • loadFromFileStream

      public static Wallet loadFromFileStream(InputStream stream, @Nullable WalletExtension... walletExtensions) throws UnreadableWalletException
      Returns a wallet deserialized from the given input stream and wallet extensions.
      Parameters:
      stream - An open InputStream containing a ProtoBuf Wallet
      walletExtensions - extensions possibly added to the wallet.
      Returns:
      The Wallet
      Throws:
      UnreadableWalletException - if there was a problem reading or parsing the stream

    • loadFromFileStream

      public static Wallet loadFromFileStream(InputStream stream, WalletProtobufSerializer.WalletFactory factory, boolean forceReset, boolean ignoreMandatoryExtensions, @Nullable WalletExtension... walletExtensions) throws UnreadableWalletException
      Returns a wallet deserialized from the given input stream and wallet extensions.
      Parameters:
      stream - An open InputStream containing a ProtoBuf Wallet
      factory - wallet factory
      forceReset - if true, configure wallet to replay transactions from the blockchain
      ignoreMandatoryExtensions - if true, mandatory extensions will be ignored instead of causing load errors (not recommended)
      walletExtensions - extensions possibly added to the wallet.
      Returns:
      The Wallet
      Throws:
      UnreadableWalletException - if there was a problem reading or parsing the stream

    • notifyTransactionIsInBlock

      public boolean notifyTransactionIsInBlock(Sha256Hash txHash, StoredBlock block, AbstractBlockChain.NewBlockType blockType, int relativityOffset) throws VerificationException
      Called by the BlockChain when we receive a new filtered block that contains a transactions previously received by a call to receivePending(org.bitcoinj.core.Transaction, java.util.List<org.bitcoinj.core.Transaction>, boolean).

      This is necessary for the internal book-keeping Wallet does. When a transaction is received that sends us coins it is added to a pool so we can use it later to create spends. When a transaction is received that consumes outputs they are marked as spent so they won't be used in future.

      A transaction that spends our own coins can be received either because a spend we created was accepted by the network and thus made it into a block, or because our keys are being shared between multiple instances and some other node spent the coins instead. We still have to know about that to avoid accidentally trying to double spend.

      A transaction may be received multiple times if is included into blocks in parallel chains. The blockType parameter describes whether the containing block is on the main/best chain or whether it's on a presently inactive side chain. We must still record these transactions and the blocks they appear in because a future block might change which chain is best causing a reorganize. A re-org can totally change our balance!

      Specified by:
      notifyTransactionIsInBlock in interface TransactionReceivedInBlockListener
      Returns:
      whether the transaction is known about i.e. was considered relevant previously.
      Throws:
      VerificationException

    • receivePending

      public void receivePending(Transaction tx, @Nullable List<Transaction> dependencies, boolean overrideIsRelevant) throws VerificationException

      Called when we have found a transaction (via network broadcast or otherwise) that is relevant to this wallet and want to record it. Note that we cannot verify these transactions at all, they may spend fictional coins or be otherwise invalid. They are useful to inform the user about coins they can expect to receive soon, and if you trust the sender of the transaction you can choose to assume they are in fact valid and will not be double spent as an optimization.

      This is the same as receivePending(Transaction, List) but allows you to override the isPendingTransactionRelevant(Transaction) sanity-check to keep track of transactions that are not spendable or spend our coins. This can be useful when you want to keep track of transaction confidence on arbitrary transactions. Note that transactions added in this way will still be relayed to peers and appear in transaction lists like any other pending transaction (even when not relevant).

      Throws:
      VerificationException

    • isTransactionRisky

      public boolean isTransactionRisky(Transaction tx, @Nullable List<Transaction> dependencies)
      Given a transaction and an optional list of dependencies (recursive/flattened), returns true if the given transaction would be rejected by the analyzer, or false otherwise. The result of this call is independent of the value of isAcceptRiskyTransactions(). Risky transactions yield a logged warning. If you want to know the reason why a transaction is risky, create an instance of the RiskAnalysis yourself using the factory returned by getRiskAnalyzer() and use it directly.

    • receivePending

      public void receivePending(Transaction tx, @Nullable List<Transaction> dependencies) throws VerificationException

      Called when we have found a transaction (via network broadcast or otherwise) that is relevant to this wallet and want to record it. Note that we cannot verify these transactions at all, they may spend fictional coins or be otherwise invalid. They are useful to inform the user about coins they can expect to receive soon, and if you trust the sender of the transaction you can choose to assume they are in fact valid and will not be double spent as an optimization.

      Before this method is called, isPendingTransactionRelevant(Transaction) should have been called to decide whether the wallet cares about the transaction - if it does, then this method expects the transaction and any dependencies it has which are still in the memory pool.

      Throws:
      VerificationException

    • isPendingTransactionRelevant

      public boolean isPendingTransactionRelevant(Transaction tx) throws ScriptException
      This method is used by a Peer to find out if a transaction that has been announced is interesting, that is, whether we should bother downloading its dependencies and exploring the transaction to decide how risky it is. If this method returns true then receivePending(Transaction, List) will soon be called with the transactions dependencies as well.
      Throws:
      ScriptException

    • isTransactionRelevant

      public boolean isTransactionRelevant(Transaction tx) throws ScriptException

      Returns true if the given transaction sends coins to any of our keys, or has inputs spending any of our outputs, and also returns true if tx has inputs that are spending outputs which are not ours but which are spent by pending transactions.

      Note that if the tx has inputs containing one of our keys, but the connected transaction is not in the wallet, it will not be considered relevant.

      Throws:
      ScriptException

    • isTransactionMature

      public boolean isTransactionMature(Transaction tx)
      Determine if a transaction is mature. A coinbase transaction is mature if it has been confirmed at least NetworkParameters.getSpendableCoinbaseDepth() times. On BitcoinNetwork.MAINNET this value is 100. For purposes of this method, non-coinbase transactions are also considered mature.
      Parameters:
      tx - the transaction to evaluate
      Returns:
      true if it is a mature coinbase transaction or if it is not a coinbase transaction

    • receiveFromBlock

      public void receiveFromBlock(Transaction tx, StoredBlock block, AbstractBlockChain.NewBlockType blockType, int relativityOffset) throws VerificationException
      Called by the BlockChain when we receive a new block that sends coins to one of our addresses or spends coins from one of our addresses (note that a single transaction can do both).

      This is necessary for the internal book-keeping Wallet does. When a transaction is received that sends us coins it is added to a pool so we can use it later to create spends. When a transaction is received that consumes outputs they are marked as spent so they won't be used in future.

      A transaction that spends our own coins can be received either because a spend we created was accepted by the network and thus made it into a block, or because our keys are being shared between multiple instances and some other node spent the coins instead. We still have to know about that to avoid accidentally trying to double spend.

      A transaction may be received multiple times if is included into blocks in parallel chains. The blockType parameter describes whether the containing block is on the main/best chain or whether it's on a presently inactive side chain. We must still record these transactions and the blocks they appear in because a future block might change which chain is best causing a reorganize. A re-org can totally change our balance!

      Specified by:
      receiveFromBlock in interface TransactionReceivedInBlockListener
      Throws:
      VerificationException

    • notifyNewBestBlock

      public void notifyNewBestBlock(StoredBlock block) throws VerificationException

      Called by the BlockChain when a new block on the best chain is seen, AFTER relevant wallet transactions are extracted and sent to us UNLESS the new block caused a re-org, in which case this will not be called (the reorganize(StoredBlock, List, List) method will call this one in that case).

      Used to update confidence data in each transaction and last seen block hash. Triggers auto saving. Invokes the onWalletChanged event listener if there were any affected transactions.

      Specified by:
      notifyNewBestBlock in interface NewBestBlockListener
      Throws:
      VerificationException

    • maybeCommitTx

      public boolean maybeCommitTx(Transaction tx) throws VerificationException
      Updates the wallet with the given transaction: puts it into the pending pool, sets the spent flags and runs the onCoinsSent/onCoinsReceived event listener.

      Triggers an auto save (if enabled.)

      Unlike commitTx(org.bitcoinj.core.Transaction) this method does not throw an exception if the transaction was already added to the wallet, instead it will return false

      Parameters:
      tx - transaction to commit
      Returns:
      true if the tx was added to the wallet, or false if it was already in the pending pool
      Throws:
      VerificationException - If transaction fails to verify

    • commitTx

      public void commitTx(Transaction tx) throws VerificationException
      Updates the wallet with the given transaction: puts it into the pending pool, sets the spent flags and runs the onCoinsSent/onCoinsReceived event listener. Used in two situations:
      1. When we have just successfully transmitted the tx we created to the network.
      2. When we receive a pending transaction that didn't appear in the chain yet, and we did not create it.
      Triggers an auto save (if enabled.)

      Unlike maybeCommitTx(org.bitcoinj.core.Transaction) commitTx throws an exception if the transaction was already added to the wallet.

      Parameters:
      tx - transaction to commit
      Throws:
      VerificationException - if transaction was already in the pending pool

    • addChangeEventListener

      public void addChangeEventListener(WalletChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when something interesting happens, like receiving money. Runs the listener methods in the user thread.

    • addChangeEventListener

      public void addChangeEventListener(Executor executor, WalletChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when something interesting happens, like receiving money. The listener is executed by the given executor.

    • addCoinsReceivedEventListener

      public void addCoinsReceivedEventListener(WalletCoinsReceivedEventListener listener)
      Adds an event listener object called when coins are received. Runs the listener methods in the user thread.

    • addCoinsReceivedEventListener

      public void addCoinsReceivedEventListener(Executor executor, WalletCoinsReceivedEventListener listener)
      Adds an event listener object called when coins are received. The listener is executed by the given executor.

    • addCoinsSentEventListener

      public void addCoinsSentEventListener(WalletCoinsSentEventListener listener)
      Adds an event listener object called when coins are sent. Runs the listener methods in the user thread.

    • addCoinsSentEventListener

      public void addCoinsSentEventListener(Executor executor, WalletCoinsSentEventListener listener)
      Adds an event listener object called when coins are sent. The listener is executed by the given executor.

    • addKeyChainEventListener

      public void addKeyChainEventListener(KeyChainEventListener listener)
      Adds an event listener object. Methods on this object are called when keys are added. The listener is executed in the user thread.

    • addKeyChainEventListener

      public void addKeyChainEventListener(Executor executor, KeyChainEventListener listener)
      Adds an event listener object. Methods on this object are called when keys are added. The listener is executed by the given executor.

    • addCurrentKeyChangeEventListener

      public void addCurrentKeyChangeEventListener(CurrentKeyChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when a current key and/or address changes. The listener is executed in the user thread.

    • addCurrentKeyChangeEventListener

      public void addCurrentKeyChangeEventListener(Executor executor, CurrentKeyChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when a current key and/or address changes. The listener is executed by the given executor.

    • addReorganizeEventListener

      public void addReorganizeEventListener(WalletReorganizeEventListener listener)
      Adds an event listener object. Methods on this object are called when something interesting happens, like receiving money. Runs the listener methods in the user thread.

    • addReorganizeEventListener

      public void addReorganizeEventListener(Executor executor, WalletReorganizeEventListener listener)
      Adds an event listener object. Methods on this object are called when something interesting happens, like receiving money. The listener is executed by the given executor.

    • addScriptsChangeEventListener

      public void addScriptsChangeEventListener(ScriptsChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when scripts watched by this wallet change. Runs the listener methods in the user thread.

    • addScriptsChangeEventListener

      public void addScriptsChangeEventListener(Executor executor, ScriptsChangeEventListener listener)
      Adds an event listener object. Methods on this object are called when scripts watched by this wallet change. The listener is executed by the given executor.

    • addTransactionConfidenceEventListener

      public void addTransactionConfidenceEventListener(TransactionConfidenceEventListener listener)
      Adds an event listener object. Methods on this object are called when confidence of a transaction changes. Runs the listener methods in the user thread.

    • addTransactionConfidenceEventListener

      public void addTransactionConfidenceEventListener(Executor executor, TransactionConfidenceEventListener listener)
      Adds an event listener object. Methods on this object are called when confidence of a transaction changes. The listener is executed by the given executor.

    • removeChangeEventListener

      public boolean removeChangeEventListener(WalletChangeEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeCoinsReceivedEventListener

      public boolean removeCoinsReceivedEventListener(WalletCoinsReceivedEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeCoinsSentEventListener

      public boolean removeCoinsSentEventListener(WalletCoinsSentEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeKeyChainEventListener

      public boolean removeKeyChainEventListener(KeyChainEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeCurrentKeyChangeEventListener

      public boolean removeCurrentKeyChangeEventListener(CurrentKeyChangeEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeReorganizeEventListener

      public boolean removeReorganizeEventListener(WalletReorganizeEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeScriptsChangeEventListener

      public boolean removeScriptsChangeEventListener(ScriptsChangeEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • removeTransactionConfidenceEventListener

      public boolean removeTransactionConfidenceEventListener(TransactionConfidenceEventListener listener)
      Removes the given event listener object. Returns true if the listener was removed, false if that listener was never added.

    • maybeQueueOnWalletChanged

      protected void maybeQueueOnWalletChanged()

    • queueOnCoinsReceived

      protected void queueOnCoinsReceived(Transaction tx, Coin balance, Coin newBalance)

    • queueOnCoinsSent

      protected void queueOnCoinsSent(Transaction tx, Coin prevBalance, Coin newBalance)

    • queueOnReorganize

      protected void queueOnReorganize()

    • queueOnScriptsChanged

      protected void queueOnScriptsChanged(List<Script> scripts, boolean isAddingScripts)

    • getTransactions

      public Set<Transaction> getTransactions(boolean includeDead)
      Returns a set of all transactions in the wallet.
      Parameters:
      includeDead - If true, transactions that were overridden by a double spend are included.

    • getWalletTransactions

      public Iterable<WalletTransaction> getWalletTransactions()
      Returns a set of all WalletTransactions in the wallet.

    • addWalletTransaction

      public void addWalletTransaction(WalletTransaction wtx)
      Adds a transaction that has been associated with a particular wallet pool. This is intended for usage by deserialization code, such as the WalletProtobufSerializer class. It isn't normally useful for applications. It does not trigger auto saving.

    • getTransactionsByTime

      public List<Transaction> getTransactionsByTime()
      Returns all non-dead, active transactions ordered by recency.

    • getRecentTransactions

      public List<Transaction> getRecentTransactions(int numTransactions, boolean includeDead)

      Returns an list of N transactions, ordered by increasing age. Transactions on side chains are not included. Dead transactions (overridden by double spends) are optionally included.

      Note: the current implementation is O(num transactions in wallet). Regardless of how many transactions are requested, the cost is always the same. In future, requesting smaller numbers of transactions may be faster depending on how the wallet is implemented (e.g. if backed by a database).

    • getTransaction

      @Nullable public Transaction getTransaction(Sha256Hash hash)
      Returns a transaction object given its hash, if it exists in this wallet, or null otherwise.

    • getTransactionPool

      public Map<Sha256Hash,Transaction> getTransactionPool(WalletTransaction.Pool pool)
      Description copied from interface: TransactionBag
      Returns transactions from a specific pool.
      Specified by:
      getTransactionPool in interface TransactionBag

    • reset

      public void reset()
      Prepares the wallet for a blockchain replay. Removes all transactions (as they would get in the way of the replay) and makes the wallet think it has never seen a block. WalletChangeEventListener.onWalletChanged(org.bitcoinj.wallet.Wallet) will be fired.

    • clearTransactions

      public void clearTransactions(int fromHeight)
      Deletes transactions which appeared above the given block height from the wallet, but does not touch the keys. This is useful if you have some keys and wish to replay the block chain into the wallet in order to pick them up. Triggers auto saving.

    • getWatchedOutputs

      public List<TransactionOutput> getWatchedOutputs(boolean excludeImmatureCoinbases)
      Returns all the outputs that match addresses or scripts added via addWatchedAddress(Address) or addWatchedScripts(java.util.List).
      Parameters:
      excludeImmatureCoinbases - Whether to ignore outputs that are unspendable due to being immature.

    • cleanup

      public void cleanup()
      Clean up the wallet. Currently, it only removes risky pending transaction from the wallet and only if their outputs have not been spent.

    • getPoolSize

      public int getPoolSize(WalletTransaction.Pool pool)

    • poolContainsTxHash

      public boolean poolContainsTxHash(WalletTransaction.Pool pool, Sha256Hash txHash)

    • getUnspents

      public List<TransactionOutput> getUnspents()
      Returns a copy of the internal unspent outputs list

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(boolean includeLookahead, boolean includePrivateKeys, @Nullable AesKey aesKey, boolean includeTransactions, boolean includeExtensions, @Nullable AbstractBlockChain chain)
      Formats the wallet as a human-readable piece of text. Intended for debugging, the format is not meant to be stable or human-readable.
      Parameters:
      includeLookahead - Whether lookahead keys should be included.
      includePrivateKeys - Whether raw private key data should be included.
      aesKey - for decrypting private key data for if the wallet is encrypted.
      includeTransactions - Whether to print transaction data.
      includeExtensions - Whether to print extension data.
      chain - If set, will be used to estimate lock times for block time-locked transactions.
      Returns:
      Human-readable wallet debugging information

    • getPendingTransactions

      public Collection<Transaction> getPendingTransactions()
      Returns an immutable view of the transactions currently waiting for network confirmations.

    • earliestKeyCreationTime

      public Instant earliestKeyCreationTime()
      Returns the earliest creation time of keys or watched scripts in this wallet, ie the min of ECKey.getCreationTime(). This can return Instant.EPOCH if at least one key does not have that data (e.g. is an imported key with unknown timestamp).

      This method is most often used in conjunction with PeerGroup.setFastCatchupTime(Instant) in order to optimize chain download for new users of wallet apps. Backwards compatibility notice: if you get Instant.EPOCH from this method, you can instead use the time of the first release of your software, as it's guaranteed no users will have wallets pre-dating this time.

      If there are no keys in the wallet, Instant.MAX is returned.

      Specified by:
      earliestKeyCreationTime in interface PeerFilterProvider
      Returns:
      earliest creation times of keys in this wallet, Instant.EPOCH if at least one time is unknown, Instant.MAX if no keys in this wallet

    • getLastBlockSeenHash

      @Nullable public Sha256Hash getLastBlockSeenHash()
      Returns the hash of the last seen best-chain block, or null if the wallet is too old to store this data.

    • setLastBlockSeenHash

      public void setLastBlockSeenHash(@Nullable Sha256Hash lastBlockSeenHash)

    • setLastBlockSeenHeight

      public void setLastBlockSeenHeight(int lastBlockSeenHeight)

    • setLastBlockSeenTime

      public void setLastBlockSeenTime(Instant time)

    • clearLastBlockSeenTime

      public void clearLastBlockSeenTime()

    • setLastBlockSeenTimeSecs

      @Deprecated public void setLastBlockSeenTimeSecs(long timeSecs)
      Deprecated.
      use setLastBlockSeenTime(Instant) or clearLastBlockSeenTime()

    • lastBlockSeenTime

      public Optional<Instant> lastBlockSeenTime()
      Returns time extracted from the last best seen block header, or empty. This timestamp is not the local time at which the block was first observed by this application but rather what the block (i.e. miner) self declares. It is allowed to have some significant drift from the real time at which the block was found, although most miners do use accurate times. If this wallet is old and does not have a recorded time then this method returns zero.

    • getLastBlockSeenTimeSecs

      @Deprecated public long getLastBlockSeenTimeSecs()
      Deprecated.
      use lastBlockSeenTime()

    • getLastBlockSeenTime

      @Deprecated @Nullable public Date getLastBlockSeenTime()
      Deprecated.
      use lastBlockSeenTime()

    • getLastBlockSeenHeight

      public int getLastBlockSeenHeight()
      Returns the height of the last seen best-chain block. Can be 0 if a wallet is brand new or -1 if the wallet is old and doesn't have that data.

    • getVersion

      public int getVersion()
      Get the version of the Wallet. This is an int you can use to indicate which versions of wallets your code understands, and which come from the future (and hence cannot be safely loaded).

    • setVersion

      public void setVersion(int version)
      Set the version number of the wallet. See getVersion().

    • setDescription

      public void setDescription(String description)
      Set the description of the wallet. This is a Unicode encoding string typically entered by the user as descriptive text for the wallet.

    • getDescription

      public String getDescription()
      Get the description of the wallet. See setDescription(String)

    • getBalance

      public Coin getBalance()
      Returns the AVAILABLE balance of this wallet. See Wallet.BalanceType.AVAILABLE for details on what this means.

    • getBalance

      public Coin getBalance(Wallet.BalanceType balanceType)
      Returns the balance of this wallet as calculated by the provided balanceType.

    • getBalance

      public Coin getBalance(CoinSelector selector)
      Returns the balance that would be considered spendable by the given coin selector, including watched outputs (i.e. balance includes outputs we don't have the private keys for). Just asks it to select as many coins as possible and returns the total.

    • getBalanceFuture

      public ListenableCompletableFuture<Coin> getBalanceFuture(Coin value, Wallet.BalanceType type)

      Returns a future that will complete when the balance of the given type has becom equal or larger to the given value. If the wallet already has a large enough balance the future is returned in a pre-completed state. Note that this method is not blocking, if you want to actually wait immediately, you have to call .get() on the result.

      Also note that by the time the future completes, the wallet may have changed yet again if something else is going on in parallel, so you should treat the returned balance as advisory and be prepared for sending money to fail! Finally please be aware that any listeners on the future will run either on the calling thread if it completes immediately, or eventually on a background thread if the balance is not yet at the right level. If you do something that means you know the balance should be sufficient to trigger the future, you can use Threading.waitForUserCode() to block until the future had a chance to be updated.

    • getTotalReceived

      public Coin getTotalReceived()
      Returns the amount of bitcoin ever received via output. This is not the balance! If an output spends from a transaction whose inputs are also to our wallet, the input amounts are deducted from the outputs contribution, with a minimum of zero contribution. The idea behind this is we avoid double counting money sent to us.
      Returns:
      the total amount of satoshis received, regardless of whether it was spent or not.

    • getTotalSent

      public Coin getTotalSent()
      Returns the amount of bitcoin ever sent via output. If an output is sent to our own wallet, because of change or rotating keys or whatever, we do not count it. If the wallet was involved in a shared transaction, i.e. there is some input to the transaction that we don't have the key for, then we multiply the sum of the output values by the proportion of satoshi coming in to our inputs. Essentially we treat inputs as pooling into the transaction, becoming fungible and being equally distributed to all outputs.
      Returns:
      the total amount of satoshis sent by us

    • createSend

      public Transaction createSend(Address address, Coin value) throws InsufficientMoneyException, Wallet.CompletionException

      Statelessly creates a transaction that sends the given value to address. The change is sent to currentChangeAddress(), so you must have added at least one key.

      If you just want to send money quickly, you probably want sendCoins(TransactionBroadcaster, Address, Coin) instead. That will create the sending transaction, commit to the wallet and broadcast it to the network all in one go. This method is lower level and lets you see the proposed transaction before anything is done with it.

      This is a helper method that is equivalent to using SendRequest.to(Address, Coin) followed by completeTx(SendRequest) and returning the requests transaction object. Note that this means a fee may be automatically added if required, if you want more control over the process, just do those two steps yourself.

      IMPORTANT: This method does NOT update the wallet. If you call createSend again you may get two transactions that spend the same coins. You have to call commitTx(Transaction) on the created transaction to prevent this, but that should only occur once the transaction has been accepted by the network. This implies you cannot have more than one outstanding sending tx at once.

      You MUST ensure that the value is not smaller than TransactionOutput.getMinNonDustValue() or the transaction will almost certainly be rejected by the network as dust.

      Parameters:
      address - The Bitcoin address to send the money to.
      value - How much currency to send.
      Returns:
      either the created Transaction or null if there are insufficient coins.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • createSend

      public Transaction createSend(Address address, Coin value, boolean allowUnconfirmed) throws InsufficientMoneyException, Wallet.CompletionException

      Statelessly creates a transaction that sends the given value to address. The change is sent to currentChangeAddress(), so you must have added at least one key.

      If you just want to send money quickly, you probably want sendCoins(TransactionBroadcaster, Address, Coin) instead. That will create the sending transaction, commit to the wallet and broadcast it to the network all in one go. This method is lower level and lets you see the proposed transaction before anything is done with it.

      This is a helper method that is equivalent to using SendRequest.to(Address, Coin) followed by completeTx(SendRequest) and returning the requests transaction object. Note that this means a fee may be automatically added if required, if you want more control over the process, just do those two steps yourself.

      IMPORTANT: This method does NOT update the wallet. If you call createSend again you may get two transactions that spend the same coins. You have to call commitTx(Transaction) on the created transaction to prevent this, but that should only occur once the transaction has been accepted by the network. This implies you cannot have more than one outstanding sending tx at once.

      You MUST ensure that the value is not smaller than TransactionOutput.getMinNonDustValue() or the transaction will almost certainly be rejected by the network as dust.

      Parameters:
      address - The Bitcoin address to send the money to.
      value - How much currency to send.
      allowUnconfirmed - Whether to allow spending unconfirmed outputs.
      Returns:
      either the created Transaction or null if there are insufficient coins.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendCoinsOffline

      public Transaction sendCoinsOffline(SendRequest request) throws InsufficientMoneyException, Wallet.CompletionException
      Sends coins to the given address but does not broadcast the resulting pending transaction. It is still stored in the wallet, so when the wallet is added to a PeerGroup or Peer the transaction will be announced to the network. The given SendRequest is completed first using completeTx(SendRequest) to make it valid.
      Returns:
      the Transaction that was created
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      IllegalArgumentException - if you try and complete the same SendRequest twice
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendCoins

      public Wallet.SendResult sendCoins(TransactionBroadcaster broadcaster, Address to, Coin value) throws InsufficientMoneyException, Wallet.CompletionException

      Sends coins to the given address, via the given PeerGroup. Change is returned to currentChangeAddress(). Note that a fee may be automatically added if one may be required for the transaction to be confirmed.

      The returned object provides both the transaction, and a future that can be used to learn when the broadcast is complete. Complete means, if the PeerGroup is limited to only one connection, when it was written out to the socket. Otherwise when the transaction is written out and we heard it back from a different peer.

      Note that the sending transaction is committed to the wallet immediately, not when the transaction is successfully broadcast. This means that even if the network hasn't heard about your transaction you won't be able to spend those same coins again.

      You MUST ensure that value is not smaller than TransactionOutput.getMinNonDustValue() or the transaction will almost certainly be rejected by the network as dust.

      Parameters:
      broadcaster - a TransactionBroadcaster to use to send the transactions out.
      to - Which address to send coins to.
      value - How much value to send.
      Returns:
      An object containing the transaction that was created, and a future for the broadcast of it.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendCoins

      public Wallet.SendResult sendCoins(TransactionBroadcaster broadcaster, SendRequest request) throws InsufficientMoneyException, Wallet.CompletionException

      Sends coins according to the given request, via the given TransactionBroadcaster.

      The returned object provides both the transaction, and a future that can be used to learn when the broadcast is complete. Complete means, if the PeerGroup is limited to only one connection, when it was written out to the socket. Otherwise when the transaction is written out and we heard it back from a different peer.

      Note that the sending transaction is committed to the wallet immediately, not when the transaction is successfully broadcast. This means that even if the network hasn't heard about your transaction you won't be able to spend those same coins again.

      Parameters:
      broadcaster - the target to use for broadcast.
      request - the SendRequest that describes what to do, get one using static methods on SendRequest itself.
      Returns:
      An object containing the transaction that was created, and a future for the broadcast of it.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      IllegalArgumentException - if you try and complete the same SendRequest twice
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendCoins

      public Wallet.SendResult sendCoins(SendRequest request) throws InsufficientMoneyException, Wallet.CompletionException
      Satisfies the given SendRequest using the default transaction broadcaster configured either via PeerGroup.addWallet(Wallet) or directly with setTransactionBroadcaster(TransactionBroadcaster).
      Parameters:
      request - the SendRequest that describes what to do, get one using static methods on SendRequest itself.
      Returns:
      An object containing the transaction that was created, and a future for the broadcast of it.
      Throws:
      IllegalStateException - if no transaction broadcaster has been configured.
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      IllegalArgumentException - if you try and complete the same SendRequest twice
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendCoins

      public Transaction sendCoins(Peer peer, SendRequest request) throws InsufficientMoneyException, Wallet.CompletionException
      Sends coins to the given address, via the given Peer. Change is returned to currentChangeAddress(). If an exception is thrown by PeerSocketHandler.sendMessage(Message) the transaction is still committed, so the pending transaction must be broadcast by you at some other time. Note that a fee may be automatically added if one may be required for the transaction to be confirmed.
      Returns:
      The Transaction that was created or null if there was insufficient balance to send the coins.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      IllegalArgumentException - if you try and complete the same SendRequest twice
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • sendTransaction

      public CompletableFuture<TransactionBroadcast> sendTransaction(SendRequest sendRequest)
      Initiate sending the transaction in a SendRequest. Calls sendCoins(SendRequest) which performs the following significant operations internally:
      1. completeTx(SendRequest) -- calculate change and sign
      2. commitTx(Transaction) -- puts the transaction in the Wallet's pending pool
      3. TransactionBroadcaster.broadcastTransaction(Transaction) typically implemented by PeerGroup.broadcastTransaction(Transaction) -- queues requests to send the transaction to a single remote Peer
      This method will complete and return a TransactionBroadcast when the send to the remote peer occurs (is buffered.) The broadcast process includes the following steps:
      1. Wait until enough Peers are connected.
      2. Broadcast (buffer for send) the transaction to a single remote Peer
      3. Mark TransactionBroadcast.awaitSent() as complete
      4. Wait for a number of remote peers to confirm they have received the broadcast
      5. Mark TransactionBroadcast.awaitRelayed() as complete
      Parameters:
      sendRequest - transaction to send
      Returns:
      A future for the transaction broadcast

    • waitForConfirmation

      public CompletableFuture<TransactionConfidence> waitForConfirmation(Transaction tx)
      Wait for at least 1 confirmation on a transaction.
      Parameters:
      tx - the transaction we are waiting for
      Returns:
      a future for an object that contains transaction confidence information

    • waitForConfirmations

      public CompletableFuture<TransactionConfidence> waitForConfirmations(Transaction tx, int requiredConfirmations)
      Wait for a required number of confirmations on a transaction.
      Parameters:
      tx - the transaction we are waiting for
      requiredConfirmations - the minimum required confirmations before completing
      Returns:
      a future for an object that contains transaction confidence information

    • completeTx

      public void completeTx(SendRequest req) throws InsufficientMoneyException, Wallet.CompletionException
      Given a spend request containing an incomplete transaction, makes it valid by adding outputs and signed inputs according to the instructions in the request. The transaction in the request is modified by this method.
      Parameters:
      req - a SendRequest that contains the incomplete transaction and details for how to make it valid.
      Throws:
      InsufficientMoneyException - if the request could not be completed due to not enough balance.
      IllegalArgumentException - if you try and complete the same SendRequest twice
      Wallet.DustySendRequested - if the resultant transaction would violate the dust rules.
      Wallet.CouldNotAdjustDownwards - if emptying the wallet was requested and the output can't be shrunk for fees without violating a protocol rule.
      Wallet.ExceededMaxTransactionSize - if the resultant transaction is too big for Bitcoin to process.
      Wallet.MultipleOpReturnRequested - if there is more than one OP_RETURN output for the resultant transaction.
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.
      Wallet.CompletionException

    • signTransaction

      public void signTransaction(SendRequest req) throws Wallet.BadWalletEncryptionKeyException

      Given a send request containing transaction, attempts to sign it's inputs. This method expects transaction to have all necessary inputs connected or they will be ignored.

      Actual signing is done by pluggable signers and it's not guaranteed that transaction will be complete in the end.

      Throws:
      Wallet.BadWalletEncryptionKeyException - if the supplied SendRequest.aesKey is wrong.

    • calculateAllSpendCandidates

      public List<TransactionOutput> calculateAllSpendCandidates()
      Returns a list of the outputs that can potentially be spent, i.e. that we have the keys for and are unspent according to our knowledge of the block chain.

    • calculateAllSpendCandidates

      public List<TransactionOutput> calculateAllSpendCandidates(boolean excludeImmatureCoinbases, boolean excludeUnsignable)
      Returns a list of all outputs that are being tracked by this wallet either from the UTXOProvider (in this case the existence or not of private keys is ignored), or the wallets internal storage (the default) taking into account the flags.
      Parameters:
      excludeImmatureCoinbases - Whether to ignore coinbase outputs that we will be able to spend in future once they mature.
      excludeUnsignable - Whether to ignore outputs that we are tracking but don't have the keys to sign for.

    • canSignFor

      public boolean canSignFor(Script script)
      Returns true if this wallet has at least one of the private keys needed to sign for this scriptPubKey. Returns false if the form of the script is not known or if the script is OP_RETURN.

    • calculateAllSpendCandidatesFromUTXOProvider

      protected List<TransactionOutput> calculateAllSpendCandidatesFromUTXOProvider(boolean excludeImmatureCoinbases)
      Returns the spendable candidates from the UTXOProvider based on keys that the wallet contains.
      Returns:
      The list of candidates.

    • getStoredOutputsFromUTXOProvider

      protected List<UTXO> getStoredOutputsFromUTXOProvider() throws UTXOProviderException
      Get all the UTXO's from the UTXOProvider based on keys that the wallet contains.
      Returns:
      The list of stored outputs.
      Throws:
      UTXOProviderException

    • getCoinSelector

      public CoinSelector getCoinSelector()
      Returns the default CoinSelector object that is used by this wallet if no custom selector is specified.

    • getUTXOProvider

      @Nullable public UTXOProvider getUTXOProvider()
      Get the UTXOProvider.
      Returns:
      The UTXO provider.

    • setUTXOProvider

      public void setUTXOProvider(@Nullable UTXOProvider provider)
      Set the UTXOProvider.

      The wallet will query the provider for spendable candidates, i.e. outputs controlled exclusively by private keys contained in the wallet.

      Note that the associated provider must be reattached after a wallet is loaded from disk. The association is not serialized.

    • reorganize

      public void reorganize(StoredBlock splitPoint, List<StoredBlock> oldBlocks, List<StoredBlock> newBlocks) throws VerificationException

      Don't call this directly. It's not intended for API users.

      Called by the BlockChain when the best chain (representing total work done) has changed. This can cause the number of confirmations of a transaction to go higher, lower, drop to zero and can even result in a transaction going dead (will never confirm) due to a double spend.

      The oldBlocks/newBlocks lists are ordered height-wise from top first to bottom last.

      Specified by:
      reorganize in interface ReorganizeListener
      Throws:
      VerificationException

    • beginBloomFilterCalculation

      public void beginBloomFilterCalculation()
      Description copied from interface: PeerFilterProvider
      Called on all registered filter providers before PeerFilterProvider.getBloomFilterElementCount() and PeerFilterProvider.getBloomFilter(int, double, int) are called. Once called, the provider should ensure that the items it will want to insert into the filter don't change. The reason is that all providers will have their element counts queried, and then a filter big enough for all of them will be specified. So the provider must use consistent state. There is guaranteed to be a matching call to PeerFilterProvider.endBloomFilterCalculation() that can be used to e.g. unlock a lock.
      Specified by:
      beginBloomFilterCalculation in interface PeerFilterProvider

    • endBloomFilterCalculation

      public void endBloomFilterCalculation()
      Description copied from interface: PeerFilterProvider
      See PeerFilterProvider.beginBloomFilterCalculation().
      Specified by:
      endBloomFilterCalculation in interface PeerFilterProvider

    • getBloomFilterElementCount

      public int getBloomFilterElementCount()
      Returns the number of distinct data items (note: NOT keys) that will be inserted into a bloom filter, when it is constructed.
      Specified by:
      getBloomFilterElementCount in interface PeerFilterProvider

    • getBloomFilter

      public BloomFilter getBloomFilter(double falsePositiveRate)
      Gets a bloom filter that contains all of the public keys from this wallet, and which will provide the given false-positive rate. See the docs for BloomFilter for a brief explanation of anonymity when using filters.

    • getBloomFilter

      public BloomFilter getBloomFilter(int size, double falsePositiveRate, int nTweak)

      Gets a bloom filter that contains all of the public keys from this wallet, and which will provide the given false-positive rate if it has size elements. Keep in mind that you will get 2 elements in the bloom filter for each key in the wallet, for the public key and the hash of the public key (address form).

      This is used to generate a BloomFilter which can be BloomFilter.merge(BloomFilter)d with another. It could also be used if you have a specific target for the filter's size.

      See the docs for BloomFilter(int, double, int, BloomFilter.BloomUpdate) for a brief explanation of anonymity when using bloom filters.

      Specified by:
      getBloomFilter in interface PeerFilterProvider

    • checkForFilterExhaustion

      public boolean checkForFilterExhaustion(FilteredBlock block)
      Used by Peer to decide whether or not to discard this block and any blocks building upon it, in case the Bloom filter used to request them may be exhausted, that is, not have sufficient keys in the deterministic sequence within it to reliably find relevant transactions.

    • addExtension

      public void addExtension(WalletExtension extension)
      By providing an object implementing the WalletExtension interface, you can save and load arbitrary additional data that will be stored with the wallet. Each extension is identified by an ID, so attempting to add the same extension twice (or two different objects that use the same ID) will throw an IllegalStateException.

    • addOrGetExistingExtension

      public WalletExtension addOrGetExistingExtension(WalletExtension extension)
      Atomically adds extension or returns an existing extension if there is one with the same id already present.

    • addOrUpdateExtension

      public void addOrUpdateExtension(WalletExtension extension)
      Either adds extension as a new extension or replaces the existing extension if one already exists with the same id. This also triggers wallet auto-saving, so may be useful even when called with the same extension as is already present.

    • getExtensions

      public Map<String,WalletExtension> getExtensions()
      Returns a snapshot of all registered extension objects. The extensions themselves are not copied.

    • deserializeExtension

      public void deserializeExtension(WalletExtension extension, byte[] data) throws Exception
      Deserialize the wallet extension with the supplied data and then install it, replacing any existing extension that may have existed with the same ID. If an exception is thrown then the extension is removed from the wallet, if already present.
      Throws:
      Exception

    • setTag

      public void setTag(String tag, com.google.protobuf.ByteString value)
      Deprecated.
      Applications should use another mechanism to persist application state information
      Description copied from interface: TaggableObject
      Associates the given immutable byte array with the string tag. See the docs for TaggableObject to learn more.
      Specified by:
      setTag in interface TaggableObject
      Overrides:
      setTag in class BaseTaggableObject

    • setTransactionBroadcaster

      public void setTransactionBroadcaster(@Nullable TransactionBroadcaster broadcaster)

      Specifies that the given TransactionBroadcaster, typically a PeerGroup, should be used for sending transactions to the Bitcoin network by default. Some sendCoins methods let you specify a broadcaster explicitly, in that case, they don't use this broadcaster. If null is specified then the wallet won't attempt to broadcast transactions itself.

      You don't normally need to call this. A PeerGroup will automatically set itself as the wallets broadcaster when you use PeerGroup.addWallet(Wallet). A wallet can use the broadcaster when you ask it to send money, but in future also at other times to implement various features that may require asynchronous re-organisation of the wallet contents on the block chain. For instance, in future the wallet may choose to optimise itself to reduce fees or improve privacy.

    • setKeyRotationTime

      public void setKeyRotationTime(@Nullable Instant keyRotationTime)

      When a key rotation time is set, any money controlled by keys created before the given timestamp T will be respent to any key that was created after T. This can be used to recover from a situation where a set of keys is believed to be compromised. The rotation time is persisted to the wallet. You can stop key rotation by calling this method again with null as the argument.

      Once set up, calling doMaintenance(AesKey, boolean) will create and possibly send rotation transactions: but it won't be done automatically (because you might have to ask for the users password). This may need to be repeated regularly in case new coins keep coming in on rotating addresses/keys.

      The given time cannot be in the future.

      Parameters:
      keyRotationTime - rotate any keys created before this time, or null for no rotation

    • setKeyRotationTime

      @Deprecated public void setKeyRotationTime(long timeSecs)
      Deprecated.
      use setKeyRotationTime(Instant)

    • setKeyRotationTime

      @Deprecated public void setKeyRotationTime(@Nullable Date time)
      Deprecated.
      use setKeyRotationTime(Instant)

    • keyRotationTime

      public Optional<Instant> keyRotationTime()
      Returns the key rotation time, or empty if unconfigured. See setKeyRotationTime(Instant) for a description of the field.

    • getKeyRotationTime

      @Deprecated @Nullable public Date getKeyRotationTime()
      Deprecated.
      use keyRotationTime()

    • isKeyRotating

      public boolean isKeyRotating(ECKey key)
      Returns whether the keys creation time is before the key rotation time, if one was set.

    • doMaintenance

      public ListenableCompletableFuture<List<Transaction>> doMaintenance(@Nullable AesKey aesKey, boolean signAndSend) throws DeterministicUpgradeRequiresPassword
      A wallet app should call this from time to time in order to let the wallet craft and send transactions needed to re-organise coins internally. A good time to call this would be after receiving coins for an unencrypted wallet, or after sending money for an encrypted wallet. If you have an encrypted wallet and just want to know if some maintenance needs doing, call this method with andSend set to false and look at the returned list of transactions. Maintenance might also include internal changes that involve some processing or work but which don't require making transactions - these will happen automatically unless the password is required in which case an exception will be thrown.
      Parameters:
      aesKey - the users password, if any.
      signAndSend - if true, send the transactions via the tx broadcaster and return them, if false just return them.
      Returns:
      A list of transactions that the wallet just made/will make for internal maintenance. Might be empty.
      Throws:
      DeterministicUpgradeRequiresPassword - if key rotation requires the users password.

    • doMaintenance

      public ListenableCompletableFuture<List<Transaction>> doMaintenance(KeyChainGroupStructure structure, @Nullable AesKey aesKey, boolean signAndSend) throws DeterministicUpgradeRequiresPassword
      A wallet app should call this from time to time in order to let the wallet craft and send transactions needed to re-organise coins internally. A good time to call this would be after receiving coins for an unencrypted wallet, or after sending money for an encrypted wallet. If you have an encrypted wallet and just want to know if some maintenance needs doing, call this method with andSend set to false and look at the returned list of transactions. Maintenance might also include internal changes that involve some processing or work but which don't require making transactions - these will happen automatically unless the password is required in which case an exception will be thrown.
      Parameters:
      structure - to derive the account path from if a new seed needs to be created
      aesKey - the users password, if any.
      signAndSend - if true, send the transactions via the tx broadcaster and return them, if false just return them.
      Returns:
      A list of transactions that the wallet just made/will make for internal maintenance. Might be empty.
      Throws:
      DeterministicUpgradeRequiresPassword - if key rotation requires the users password.