io.nessus

Interface Wallet

All Known Implementing Classes:

AbstractWallet

public interface Wallet

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Wallet.Address

Field Summary

Fields

Modifier and Type	Field and Description
static java.math.BigDecimal	ALL_FUNDS
static java.lang.String	LABEL_CHANGE

Method Summary

Modifier and Type	Method and Description
Wallet.Address	findAddress(java.lang.String rawAddr) Find the address for a given raw address
Wallet.Address	getAddress(java.lang.String label) Get the default address for a given label
java.util.List<Wallet.Address>	getAddresses() Get all addresses.
java.util.List<Wallet.Address>	getAddresses(java.lang.String label) Get addresses for a given label.
java.math.BigDecimal	getBalance(java.lang.String label) Get the balance for a given label
java.math.BigDecimal	getBalance(Wallet.Address addr) Get the balance for a given address
Wallet.Address	getChangeAddress(java.lang.String label) Get a change address for a given label.
java.util.List<Wallet.Address>	getChangeAddresses(java.lang.String label) Get change addresses for a given label
java.util.List<java.lang.String>	getLabels() List available label
Tx	getTransaction(java.lang.String txId) Get the transaction for the given Id
Wallet.Address	importAddress(java.lang.String key, java.util.List<java.lang.String> labels) Add a watch only address to this wallet
void	importAddresses(Config config) Import addressses from configuration.
Wallet.Address	importPrivateKey(java.lang.String privKey, java.util.List<java.lang.String> labels) Add an address deriven from a private key to this wallet
boolean	isP2PKH(java.lang.String addr) True if the given address is a P2PKH address.
java.util.List<UTXO>	listLockUnspent(java.util.List<Wallet.Address> addrs) List locked UTXOs associated with a list of addresses The lock state of an UTXO is delegated to the underlying wallet implementation and may not survive wallet restart.
java.util.List<UTXO>	listUnspent(java.util.List<Wallet.Address> addrs) List UTXOs associated with a list of addresses
java.util.List<UTXO>	listUnspent(java.lang.String label) Get all unspent transaction outputs associated with the given label
boolean	lockUnspent(UTXO utxo, boolean unlock) Lock an unspent transaction output.
Wallet.Address	newAddress(java.lang.String label) Generate new address.
Wallet.Address	newChangeAddress(java.lang.String label) Generate new change address.
java.util.List<UTXO>	selectUnspent(java.util.List<Wallet.Address> addrs, java.math.BigDecimal amount) Select a list of unspent transaction outputs that satisfy the requested amount
java.util.List<UTXO>	selectUnspent(java.lang.String label, java.math.BigDecimal amount) Select a list of unspent transaction outputs that satisfy the requested amount
java.lang.String	sendFromAddress(Wallet.Address fromAddr, java.lang.String toAddr, java.math.BigDecimal amount) Sends funds associated with a given address to an address
java.lang.String	sendFromLabel(java.lang.String label, java.lang.String toAddr, java.math.BigDecimal amount) Sends funds associated with a given label to an address
java.lang.String	sendToAddress(java.lang.String toAddr, java.math.BigDecimal amount) Sends funds from the default account to an address
java.lang.String	sendToAddress(java.lang.String toAddr, java.lang.String changeAddr, java.math.BigDecimal amount, java.util.List<UTXO> utxos) Sends funds given by specific utxos to an address
java.lang.String	sendTx(Tx tx) Send a raw transaction to the network

Field Detail

LABEL_CHANGE

static final java.lang.String LABEL_CHANGE

See Also:

Constant Field Values

ALL_FUNDS

static final java.math.BigDecimal ALL_FUNDS

Method Detail

isP2PKH

boolean isP2PKH(java.lang.String addr)

True if the given address is a P2PKH address.

importAddresses

void importAddresses(Config config)

Import addressses from configuration.

importPrivateKey

Wallet.Address importPrivateKey(java.lang.String privKey,
                                java.util.List<java.lang.String> labels)

Add an address deriven from a private key to this wallet

importAddress

Wallet.Address importAddress(java.lang.String key,
                             java.util.List<java.lang.String> labels)

Add a watch only address to this wallet

newAddress

Wallet.Address newAddress(java.lang.String label)

Generate new address.

newChangeAddress

Wallet.Address newChangeAddress(java.lang.String label)

Generate new change address.

getLabels

java.util.List<java.lang.String> getLabels()

List available label

getAddresses

java.util.List<Wallet.Address> getAddresses()

Get all addresses.

getAddress

Wallet.Address getAddress(java.lang.String label)

Get the default address for a given label

findAddress

Wallet.Address findAddress(java.lang.String rawAddr)

Find the address for a given raw address

getAddresses

java.util.List<Wallet.Address> getAddresses(java.lang.String label)

Get addresses for a given label.

getChangeAddress

Wallet.Address getChangeAddress(java.lang.String label)

Get a change address for a given label. If there is no change address yet, it creates one.

getChangeAddresses

java.util.List<Wallet.Address> getChangeAddresses(java.lang.String label)

Get change addresses for a given label

getBalance

java.math.BigDecimal getBalance(java.lang.String label)

Get the balance for a given label

getBalance

java.math.BigDecimal getBalance(Wallet.Address addr)

Get the balance for a given address

sendToAddress

java.lang.String sendToAddress(java.lang.String toAddr,
                               java.math.BigDecimal amount)

Sends funds from the default account to an address

Returns:

The transaction id

sendFromAddress

java.lang.String sendFromAddress(Wallet.Address fromAddr,
                                 java.lang.String toAddr,
                                 java.math.BigDecimal amount)

Sends funds associated with a given address to an address

Returns:

The transaction id

sendFromLabel

java.lang.String sendFromLabel(java.lang.String label,
                               java.lang.String toAddr,
                               java.math.BigDecimal amount)

Sends funds associated with a given label to an address

Returns:

The transaction id

sendToAddress

java.lang.String sendToAddress(java.lang.String toAddr,
                               java.lang.String changeAddr,
                               java.math.BigDecimal amount,
                               java.util.List<UTXO> utxos)

Sends funds given by specific utxos to an address

Returns:

The transaction id

sendTx

java.lang.String sendTx(Tx tx)

Send a raw transaction to the network

Returns:

The transaction id

selectUnspent

java.util.List<UTXO> selectUnspent(java.lang.String label,
                                   java.math.BigDecimal amount)

Select a list of unspent transaction outputs that satisfy the requested amount

selectUnspent

java.util.List<UTXO> selectUnspent(java.util.List<Wallet.Address> addrs,
                                   java.math.BigDecimal amount)

Select a list of unspent transaction outputs that satisfy the requested amount

listUnspent

java.util.List<UTXO> listUnspent(java.lang.String label)

Get all unspent transaction outputs associated with the given label

listUnspent

java.util.List<UTXO> listUnspent(java.util.List<Wallet.Address> addrs)

List UTXOs associated with a list of addresses

listLockUnspent

java.util.List<UTXO> listLockUnspent(java.util.List<Wallet.Address> addrs)

List locked UTXOs associated with a list of addresses The lock state of an UTXO is delegated to the underlying wallet implementation and may not survive wallet restart.

lockUnspent

boolean lockUnspent(UTXO utxo,
                    boolean unlock)

Lock an unspent transaction output. The lock state of an UTXO is delegated to the underlying wallet implementation and may not survive wallet restart.

getTransaction

Tx getTransaction(java.lang.String txId)

Get the transaction for the given Id