Package org.bitcoinj.wallet

Class BasicKeyChain

java.lang.Object
org.bitcoinj.wallet.BasicKeyChain
All Implemented Interfaces:
EncryptableKeyChain, KeyChain
public class BasicKeyChain extends Object implements EncryptableKeyChain
A KeyChain that implements the simplest model possible: it can have keys imported into it, and just acts as a dumb bag of keys. It will, left to its own devices, always return the same key for usage by the wallet, although it will automatically add one to itself if it's empty or if encryption is requested.

  • Constructor Details

    • BasicKeyChain

      public BasicKeyChain()

    • BasicKeyChain

      public BasicKeyChain(@Nullable KeyCrypter crypter)

  • Method Details

    • getKeyCrypter

      @Nullable public KeyCrypter getKeyCrypter()
      Returns the KeyCrypter in use or null if the key chain is not encrypted.
      Specified by:
      getKeyCrypter in interface EncryptableKeyChain

    • getKey

      public ECKey getKey(@Nullable KeyChain.KeyPurpose ignored)
      Description copied from interface: KeyChain
      Obtains a key intended for the given purpose. The chain may create a new key, derive one, or re-use an old one.
      Specified by:
      getKey in interface KeyChain

    • getKeys

      public List<ECKey> getKeys(@Nullable KeyChain.KeyPurpose purpose, int numberOfKeys)
      Description copied from interface: KeyChain
      Obtains a number of key/s intended for the given purpose. The chain may create new key/s, derive, or re-use an old one.
      Specified by:
      getKeys in interface KeyChain

    • getKeys

      public List<ECKey> getKeys()
      Returns a copy of the list of keys that this chain is managing.

    • importKeys

      public int importKeys(ECKey... keys)

    • importKeys

      public int importKeys(List<? extends ECKey> keys)

    • importKey

      public void importKey(ECKey key)
      Imports a key to the key chain. If key is present in the key chain, ignore it.

    • findKeyFromPubHash

      public ECKey findKeyFromPubHash(byte[] pubKeyHash)

    • findKeyFromPubKey

      public ECKey findKeyFromPubKey(byte[] pubKey)

    • hasKey

      public boolean hasKey(ECKey key)
      Description copied from interface: KeyChain
      Returns true if the given key is in the chain.
      Specified by:
      hasKey in interface KeyChain

    • numKeys

      public int numKeys()
      Description copied from interface: KeyChain
      Returns the number of keys this key chain manages.
      Specified by:
      numKeys in interface KeyChain

    • isWatching

      public BasicKeyChain.State isWatching()
      Returns whether this chain consists of pubkey only (watching) keys, regular keys (usable for signing), or has no keys in it yet at all (thus we cannot tell).

    • removeKey

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

    • earliestKeyCreationTime

      public Instant earliestKeyCreationTime()
      Returns the earliest creation time of keys in this chain.
      Specified by:
      earliestKeyCreationTime in interface KeyChain
      Returns:
      earliest creation times of keys in this chain, Instant.EPOCH if at least one time is unknown, Instant.MAX if no keys in this chain

    • getListeners

      public List<ListenerRegistration<KeyChainEventListener>> getListeners()

    • serializeToProtobuf

      public List<org.bitcoinj.protobuf.wallet.Protos.Key> serializeToProtobuf()
      Serialize to a list of keys
      Specified by:
      serializeToProtobuf in interface KeyChain
      Returns:
      list of keys (treat as unmodifiable list, will change in future release)

    • fromProtobufUnencrypted

      public static BasicKeyChain fromProtobufUnencrypted(List<org.bitcoinj.protobuf.wallet.Protos.Key> keys) throws UnreadableWalletException
      Returns a new BasicKeyChain that contains all basic, ORIGINAL type keys extracted from the list. Unrecognised key types are ignored.
      Throws:
      UnreadableWalletException

    • fromProtobufEncrypted

      public static BasicKeyChain fromProtobufEncrypted(List<org.bitcoinj.protobuf.wallet.Protos.Key> keys, KeyCrypter crypter) throws UnreadableWalletException
      Returns a new BasicKeyChain that contains all basic, ORIGINAL type keys and also any encrypted keys extracted from the list. Unrecognised key types are ignored.
      Throws:
      UnreadableWalletException.BadPassword - if the password doesn't seem to match
      UnreadableWalletException - if the data structures are corrupted/inconsistent

    • addEventListener

      public void addEventListener(KeyChainEventListener listener)
      Description copied from interface: KeyChain
      Adds a listener for events that are run when keys are added, on the user thread.
      Specified by:
      addEventListener in interface KeyChain

    • addEventListener

      public void addEventListener(KeyChainEventListener listener, Executor executor)
      Description copied from interface: KeyChain
      Adds a listener for events that are run when keys are added, on the given executor.
      Specified by:
      addEventListener in interface KeyChain

    • removeEventListener

      public boolean removeEventListener(KeyChainEventListener listener)
      Description copied from interface: KeyChain
      Removes a listener for events that are run when keys are added.
      Specified by:
      removeEventListener in interface KeyChain

    • toEncrypted

      public BasicKeyChain toEncrypted(CharSequence password)
      Convenience wrapper around toEncrypted(KeyCrypter, AesKey) which uses the default Scrypt key derivation algorithm and parameters, derives a key from the given password and returns the created key.
      Specified by:
      toEncrypted in interface EncryptableKeyChain
      Returns:
      The derived key, in case you wish to cache it for future use.

    • toEncrypted

      public BasicKeyChain toEncrypted(KeyCrypter keyCrypter, AesKey aesKey)
      Encrypt the wallet using the KeyCrypter and the AES key. A good default KeyCrypter to use is KeyCrypterScrypt.
      Specified by:
      toEncrypted in interface EncryptableKeyChain
      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.

    • toDecrypted

      public BasicKeyChain toDecrypted(CharSequence password)
      Description copied from interface: EncryptableKeyChain
      Decrypts the key chain with the given password. See EncryptableKeyChain.toDecrypted(AesKey) for details.
      Specified by:
      toDecrypted in interface EncryptableKeyChain

    • toDecrypted

      public BasicKeyChain toDecrypted(AesKey aesKey)
      Description copied from interface: EncryptableKeyChain
      Decrypt the key chain with the given AES key and whatever KeyCrypter is already set. Note that if you just want to spend money from an encrypted wallet, don't decrypt the whole thing first. Instead, set the SendRequest.aesKey field before asking the wallet to build the send.
      Specified by:
      toDecrypted in interface EncryptableKeyChain
      Parameters:
      aesKey - AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)

    • checkPassword

      public boolean checkPassword(CharSequence password)
      Returns whether the given password is correct for this key chain.
      Specified by:
      checkPassword in interface EncryptableKeyChain
      Throws:
      IllegalStateException - if the chain is not encrypted at all.

    • checkAESKey

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

    • getFilter

      public BloomFilter getFilter(int size, double falsePositiveRate, int tweak)
      Description copied from interface: KeyChain

      Gets a bloom filter that contains all of the public keys from this chain, 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 key chain, for the public key and the hash of the public key (address form). For this reason size should be at least 2x the result of KeyChain.numKeys().

      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) for a brief explanation of anonymity when using bloom filters, and for the meaning of these parameters.

      Specified by:
      getFilter in interface KeyChain

    • numBloomFilterEntries

      public int numBloomFilterEntries()
      Description copied from interface: KeyChain
      Returns the number of elements this chain wishes to insert into the Bloom filter. The size passed to KeyChain.getFilter(int, double, int) should be at least this large.
      Specified by:
      numBloomFilterEntries in interface KeyChain

    • findOldestKeyAfter

      public Optional<ECKey> findOldestKeyAfter(Instant time)
      Returns the first ECKey created after the given time, or empty if there is none.

    • findOldestKeyAfter

      @Nullable @Deprecated public ECKey findOldestKeyAfter(long timeSecs)
      Deprecated.
      use findOldestKeyAfter(Instant)

    • findKeysBefore

      public List<ECKey> findKeysBefore(Instant time)
      Returns a list of all ECKeys created after the given time.

    • findKeysBefore

      @Deprecated public List<ECKey> findKeysBefore(long timeSecs)
      Deprecated.
      use findKeysBefore(Instant)

    • toString

      public String toString(boolean includePrivateKeys, @Nullable AesKey aesKey, Network network)

    • toString

      @Deprecated public String toString(boolean includePrivateKeys, @Nullable AesKey aesKey, NetworkParameters params)
      Deprecated.
      use toString(boolean, AesKey, Network)