org.bitcoinj.wallet

Interface KeyChainFactory

All Known Implementing Classes:

DefaultKeyChainFactory

public interface KeyChainFactory

Factory interface for creation keychains while de-serializing a wallet.

Method Summary

Modifier and Type	Method and Description
DeterministicKeyChain	makeKeyChain(Protos.Key key, Protos.Key firstSubKey, DeterministicSeed seed, KeyCrypter crypter, boolean isMarried, Script.ScriptType outputScriptType, com.google.common.collect.ImmutableList<ChildNumber> accountPath) Make a keychain (but not a watching one) with the specified account path
DeterministicKeyChain	makeSpendingKeyChain(Protos.Key key, Protos.Key firstSubKey, DeterministicKey accountKey, boolean isMarried, Script.ScriptType outputScriptType) Make a spending keychain.
DeterministicKeyChain	makeWatchingKeyChain(Protos.Key key, Protos.Key firstSubKey, DeterministicKey accountKey, boolean isFollowingKey, boolean isMarried, Script.ScriptType outputScriptType) Make a watching keychain.

Method Detail

makeKeyChain

DeterministicKeyChain makeKeyChain(Protos.Key key,
                                   Protos.Key firstSubKey,
                                   DeterministicSeed seed,
                                   KeyCrypter crypter,
                                   boolean isMarried,
                                   Script.ScriptType outputScriptType,
                                   com.google.common.collect.ImmutableList<ChildNumber> accountPath)

Make a keychain (but not a watching one) with the specified account path

Parameters:

key - the protobuf for the root key

firstSubKey - the protobuf for the first child key (normally the parent of the external subchain)

seed - the seed

crypter - the encrypted/decrypter

isMarried - whether the keychain is leading in a marriage

outputScriptType - type of addresses (aka output scripts) to generate for receiving

accountPath - account path to generate receiving addresses on

makeWatchingKeyChain

DeterministicKeyChain makeWatchingKeyChain(Protos.Key key,
                                           Protos.Key firstSubKey,
                                           DeterministicKey accountKey,
                                           boolean isFollowingKey,
                                           boolean isMarried,
                                           Script.ScriptType outputScriptType)
                                    throws UnreadableWalletException

Make a watching keychain.

isMarried and isFollowingKey must not be true at the same time.

Parameters:

key - the protobuf for the account key

firstSubKey - the protobuf for the first child key (normally the parent of the external subchain)

accountKey - the account extended public key

isFollowingKey - whether the keychain is following in a marriage

isMarried - whether the keychain is leading in a marriage

outputScriptType - type of addresses (aka output scripts) to generate for watching

Throws:

UnreadableWalletException

makeSpendingKeyChain

DeterministicKeyChain makeSpendingKeyChain(Protos.Key key,
                                           Protos.Key firstSubKey,
                                           DeterministicKey accountKey,
                                           boolean isMarried,
                                           Script.ScriptType outputScriptType)
                                    throws UnreadableWalletException

Make a spending keychain.

isMarried and isFollowingKey must not be true at the same time.

Parameters:

key - the protobuf for the account key

firstSubKey - the protobuf for the first child key (normally the parent of the external subchain)

accountKey - the account extended public key

isMarried - whether the keychain is leading in a marriage

outputScriptType - type of addresses (aka output scripts) to generate for spending

Throws:

UnreadableWalletException