Package org.bitcoinj.crypto

Class BIP38PrivateKey

java.lang.Object

org.bitcoinj.crypto.EncodedPrivateKey

org.bitcoinj.crypto.BIP38PrivateKey

public class BIP38PrivateKey
extends EncodedPrivateKey

Implementation of BIP 38 passphrase-protected private keys. Currently, only decryption is supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BIP38PrivateKey.BadPassphraseException

Field Summary

Fields

Modifier and Type	Field	Description
final byte[]	addressHash
final boolean	compressed
final byte[]	content
final boolean	ecMultiply
final boolean	hasLotAndSequence

Fields inherited from class org.bitcoinj.crypto.EncodedPrivateKey

bytes, network

Method Summary

Modifier and Type	Method	Description
ECKey	decrypt(String passphrase)
static BIP38PrivateKey	fromBase58(Network network, String base58)	Construct a password-protected private key from its Base58 representation.
static BIP38PrivateKey	fromBase58(NetworkParameters params, String base58)	Deprecated. use fromBase58(Network, String)
String	toBase58()	Returns the base58-encoded textual form, including version and checksum bytes.
String	toString()

Methods inherited from class org.bitcoinj.crypto.EncodedPrivateKey

equals, getParameters, hashCode, network

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ecMultiply

public final boolean ecMultiply

compressed

public final boolean compressed

hasLotAndSequence

public final boolean hasLotAndSequence

addressHash

public final byte[] addressHash

content

public final byte[] content

Method Details

fromBase58

public static BIP38PrivateKey fromBase58(Network network,
 String base58)
                                  throws AddressFormatException

Construct a password-protected private key from its Base58 representation.

Parameters:

network - The network of the chain that the key is for.

base58 - The textual form of the password-protected private key.

Throws:

AddressFormatException - if the given base58 doesn't parse or the checksum is invalid

fromBase58

@Deprecated
public static BIP38PrivateKey fromBase58(NetworkParameters params,
 String base58)
                                  throws AddressFormatException

Deprecated.

use fromBase58(Network, String)

Construct a password-protected private key from its Base58 representation.

Parameters:

params - The network of the chain that the key is for.

base58 - The textual form of the password-protected private key.

Throws:

AddressFormatException - if the given base58 doesn't parse or the checksum is invalid

toBase58

public String toBase58()

Returns the base58-encoded textual form, including version and checksum bytes.

Returns:

textual form

decrypt

public ECKey decrypt(String passphrase)
              throws BIP38PrivateKey.BadPassphraseException

Throws:

BIP38PrivateKey.BadPassphraseException

toString

public String toString()

Overrides:

toString in class Object