org.bitcoinj.core

Class LegacyAddress

java.lang.Object

org.bitcoinj.core.PrefixedChecksummedBytes

org.bitcoinj.core.Address

org.bitcoinj.core.LegacyAddress

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Address>

public class LegacyAddress
extends Address

A Bitcoin address looks like 1MsScoe2fTJoq4ZPdQgqyhgWeoNamYPevy and is derived from an elliptic curve public key plus a set of network parameters. Not to be confused with a PeerAddress or AddressMessage which are about network (TCP) addresses.

A standard address is built by taking the RIPE-MD160 hash of the public key bytes, with a version prefix and a checksum suffix, then encoding it textually as base58. The version prefix is used to both denote the network for which the address is valid (see NetworkParameters, and also to indicate how the bytes inside the address should be interpreted. Whilst almost all addresses today are hashes of public keys, another (currently unsupported type) can contain a hash of a script instead.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH An address is a RIPEMD160 hash of a public key, therefore is always 160 bits or 20 bytes.
boolean	p2sh True if P2SH, false if P2PKH.

Fields inherited from class org.bitcoinj.core.PrefixedChecksummedBytes

bytes, params

Method Summary

Modifier and Type	Method and Description
LegacyAddress	clone() This implementation narrows the return type to PrefixedChecksummedBytes and allows subclasses to throw CloneNotSupportedException even though it is never thrown by this implementation.
int	compareTo(Address o) Comparison field order for addresses is: NetworkParameters.getId() Legacy vs.
boolean	equals(java.lang.Object o)
static LegacyAddress	fromBase58(NetworkParameters params, java.lang.String base58) Construct a LegacyAddress from its base58 form.
static LegacyAddress	fromKey(NetworkParameters params, ECKey key) Construct a LegacyAddress that represents the public part of the given ECKey.
static LegacyAddress	fromPubKeyHash(NetworkParameters params, byte[] hash160) Construct a LegacyAddress that represents the given pubkey hash.
static LegacyAddress	fromScriptHash(NetworkParameters params, byte[] hash160) Construct a LegacyAddress that represents the given P2SH script hash.
byte[]	getHash() The (big endian) 20 byte hash that is the core of a Bitcoin address.
Script.ScriptType	getOutputScriptType() Get the type of output script that will be used for sending to the address.
static NetworkParameters	getParametersFromAddress(java.lang.String address) Given an address, examines the version byte and attempts to find a matching NetworkParameters.
int	getVersion() Get the version header of an address.
int	hashCode()
java.lang.String	toBase58() Returns the base58-encoded textual form, including version and checksum bytes.
java.lang.String	toString()

Methods inherited from class org.bitcoinj.core.Address

compareAddressPartial, fromKey, fromString

Methods inherited from class org.bitcoinj.core.PrefixedChecksummedBytes

getParameters

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH

public static final int LENGTH

An address is a RIPEMD160 hash of a public key, therefore is always 160 bits or 20 bytes.

See Also:

Constant Field Values

p2sh

public final boolean p2sh

True if P2SH, false if P2PKH.

Method Detail

fromPubKeyHash

public static LegacyAddress fromPubKeyHash(NetworkParameters params,
                                           byte[] hash160)
                                    throws AddressFormatException

Construct a LegacyAddress that represents the given pubkey hash. The resulting address will be a P2PKH type of address.

Parameters:

params - network this address is valid for

hash160 - 20-byte pubkey hash

Returns:

constructed address

Throws:

AddressFormatException

fromKey

public static LegacyAddress fromKey(NetworkParameters params,
                                    ECKey key)

Construct a LegacyAddress that represents the public part of the given ECKey. Note that an address is derived from a hash of the public key and is not the public key itself.

Parameters:

params - network this address is valid for

key - only the public part is used

Returns:

constructed address

fromScriptHash

public static LegacyAddress fromScriptHash(NetworkParameters params,
                                           byte[] hash160)
                                    throws AddressFormatException

Construct a LegacyAddress that represents the given P2SH script hash.

Parameters:

params - network this address is valid for

hash160 - P2SH script hash

Returns:

constructed address

Throws:

AddressFormatException

fromBase58

public static LegacyAddress fromBase58(@Nullable
                                       NetworkParameters params,
                                       java.lang.String base58)
                                throws AddressFormatException,
                                       AddressFormatException.WrongNetwork

Construct a LegacyAddress from its base58 form.

Parameters:

params - expected network this address is valid for, or null if if the network should be derived from the base58

base58 - base58-encoded textual form of the address

Throws:

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

AddressFormatException.WrongNetwork - if the given address is valid but for a different chain (eg testnet vs mainnet)

getVersion

public int getVersion()

Get the version header of an address. This is the first byte of a base58 encoded address.

Returns:

version header as one byte

toBase58

public java.lang.String toBase58()

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

Returns:

textual form

getHash

public byte[] getHash()

The (big endian) 20 byte hash that is the core of a Bitcoin address.

Specified by:

getHash in class Address

Returns:

hash that is encoded in the address

getOutputScriptType

public Script.ScriptType getOutputScriptType()

Get the type of output script that will be used for sending to the address. This is either Script.ScriptType.P2PKH or Script.ScriptType.P2SH.

Specified by:

getOutputScriptType in class Address

Returns:

type of output script

getParametersFromAddress

public static NetworkParameters getParametersFromAddress(java.lang.String address)
                                                  throws AddressFormatException

Given an address, examines the version byte and attempts to find a matching NetworkParameters. If you aren't sure which network the address is intended for (eg, it was provided by a user), you can use this to decide if it is compatible with the current wallet.

Returns:

network the address is valid for

Throws:

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PrefixedChecksummedBytes

hashCode

public int hashCode()

Overrides:

hashCode in class PrefixedChecksummedBytes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public LegacyAddress clone()
                    throws java.lang.CloneNotSupportedException

Description copied from class: PrefixedChecksummedBytes

This implementation narrows the return type to PrefixedChecksummedBytes and allows subclasses to throw CloneNotSupportedException even though it is never thrown by this implementation.

Overrides:

clone in class PrefixedChecksummedBytes

Throws:

java.lang.CloneNotSupportedException

compareTo

public int compareTo(Address o)

Comparison field order for addresses is:

1. NetworkParameters.getId()
2. Legacy vs. Segwit
3. (Legacy only) Version byte
4. remaining bytes

Implementations may use compareAddressPartial for tests 1 and 2.

Specified by:

compareTo in interface java.lang.Comparable<Address>

Specified by:

compareTo in class Address

Parameters:

o - other Address object

Returns:

comparison result