Package org.bitcoinj.base

Interface Address

All Superinterfaces:

java.lang.Comparable<Address>

All Known Implementing Classes:

LegacyAddress, SegwitAddress

public interface Address
extends java.lang.Comparable<Address>

Interface for addresses, e.g. native segwit addresses (SegwitAddress) or legacy addresses (LegacyAddress).

Use AddressParser to construct any kind of address from its textual form.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Comparator<Address>	PARTIAL_ADDRESS_COMPARATOR	Comparator for the first two comparison fields in Address comparisons, see compareTo(Address).

Method Summary

Modifier and Type	Method	Description
int	compareTo(Address o)	Comparison field order for addresses is: Network.id() Legacy vs.
static int	compareTypes(Address a, Address b)
static Address	fromKey(NetworkParameters params, ECKey key, ScriptType outputScriptType)	Deprecated. Use ECKey.toAddress(ScriptType, Network)
static Address	fromString(NetworkParameters params, java.lang.String str)	Deprecated. Use Wallet.parseAddress(String) or AddressParser.parseAddress(String)
byte[]	getHash()	Get either the public key hash or script hash that is encoded in the address.
ScriptType	getOutputScriptType()	Get the type of output script that will be used for sending to the address.
default NetworkParameters	getParameters()	Deprecated. Use network()
Network	network()	Get the network this address is used on.

Field Detail

PARTIAL_ADDRESS_COMPARATOR

static final java.util.Comparator<Address> PARTIAL_ADDRESS_COMPARATOR

Comparator for the first two comparison fields in Address comparisons, see compareTo(Address). Used by LegacyAddress.compareTo(Address) and SegwitAddress.compareTo(Address). For use by implementing classes only.

Method Detail

fromString

@Deprecated
static Address fromString(@Nullable
                          NetworkParameters params,
                          java.lang.String str)
                   throws AddressFormatException

Deprecated.

Use Wallet.parseAddress(String) or AddressParser.parseAddress(String)

Construct an address from its textual form.

Parameters:

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

str - the textual form of the address, such as "17kzeh4N8g49GFvdDzSf8PjaPfyoD1MndL" or "bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4"

Returns:

constructed address

Throws:

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

AddressFormatException.WrongNetwork - if the given string is valid but not for the expected network (e.g. testnet vs mainnet)

fromKey

@Deprecated
static Address fromKey(NetworkParameters params,
                       ECKey key,
                       ScriptType outputScriptType)

Deprecated.

Use ECKey.toAddress(ScriptType, Network)

Construct an Address that represents the public part of the given ECKey.

Parameters:

params - network this address is valid for

key - only the public part is used

outputScriptType - script type the address should use

Returns:

constructed address

getParameters

@Deprecated
default NetworkParameters getParameters()

Deprecated.

Use network()

Returns:

network this data is valid for

getHash

byte[] getHash()

Get either the public key hash or script hash that is encoded in the address.

Returns:

hash that is encoded in the address

getOutputScriptType

ScriptType getOutputScriptType()

Get the type of output script that will be used for sending to the address.

Returns:

type of output script

compareTo

int compareTo(Address o)

Comparison field order for addresses is:

1. Network.id()
2. Legacy vs. Segwit
3. (Legacy only) Version byte
4. remaining bytes

Implementations use PARTIAL_ADDRESS_COMPARATOR for tests 1 and 2.

Specified by:

compareTo in interface java.lang.Comparable<Address>

Parameters:

o - other Address object

Returns:

comparison result

network

Network network()

Get the network this address is used on. Returns the normalized network (see below.)

Note: The network value returned is normalized. For example the address "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx" may be used on either BitcoinNetwork.TESTNET or BitcoinNetwork.SIGNET, but the value returned by this method will always be BitcoinNetwork.TESTNET. Similarly, the address "mnHUcqUVvrfi5kAaXJDQzBb9HsWs78b42R" may be used on BitcoinNetwork.TESTNET, BitcoinNetwork.REGTEST, or BitcoinNetwork.REGTEST, but the value returned by this method will always be BitcoinNetwork.TESTNET.

Returns:

the Network.

compareTypes

static int compareTypes(Address a,
                        Address b)