wf.bitcoin.javabitcoindrpcclient

Class BitcoinJSONRPCClient

java.lang.Object

wf.bitcoin.javabitcoindrpcclient.BitcoinJSONRPCClient

All Implemented Interfaces:

BitcoindRpcClient

public class BitcoinJSONRPCClient
extends Object
implements BitcoindRpcClient

Author:

Mikhail Yevchenko m.ṥῥẚɱ.ѓѐḿởύḙ at azazar.com Small modifications by Alessandro Polverini polverini at gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface wf.bitcoin.javabitcoindrpcclient.BitcoindRpcClient

BitcoindRpcClient.AddressValidationResult, BitcoindRpcClient.BasicTxInput, BitcoindRpcClient.BasicTxOutput, BitcoindRpcClient.Block, BitcoindRpcClient.BlockChainInfo, BitcoindRpcClient.Info, BitcoindRpcClient.PeerInfoResult, BitcoindRpcClient.RawTransaction, BitcoindRpcClient.ReceivedAddress, BitcoindRpcClient.Transaction, BitcoindRpcClient.TransactionsSinceBlock, BitcoindRpcClient.TxInput, BitcoindRpcClient.TxOutput, BitcoindRpcClient.Unspent

Field Summary

Fields

Modifier and Type	Field and Description
static URL	DEFAULT_JSONRPC_TESTNET_URL
static URL	DEFAULT_JSONRPC_URL
static Charset	QUERY_CHARSET
URL	rpcURL

Constructor Summary

Constructors

Constructor and Description
BitcoinJSONRPCClient()
BitcoinJSONRPCClient(boolean testNet)
BitcoinJSONRPCClient(String rpcUrl)
BitcoinJSONRPCClient(URL rpc)

Method Summary

Modifier and Type	Method and Description
String	createRawTransaction(List<BitcoindRpcClient.TxInput> inputs, List<BitcoindRpcClient.TxOutput> outputs)
String	dumpPrivKey(String address)
List<String>	generate(int numBlocks) Used in regtest mode to generate an arbitrary number of blocks
String	getAccount(String address)
String	getAccountAddress(String address)
List<String>	getAddressesByAccount(String account)
double	getBalance()
double	getBalance(String account)
double	getBalance(String account, int minConf)
String	getBestBlockHash()
BitcoindRpcClient.Block	getBlock(int height)
BitcoindRpcClient.Block	getBlock(String blockHash)
BitcoindRpcClient.BlockChainInfo	getBlockChainInfo()
int	getBlockCount()
String	getBlockHash(int height)
double	getEstimateFee(int nBlocks)
double	getEstimatePriority(int nBlocks)
HostnameVerifier	getHostnameVerifier()
BitcoindRpcClient.Info	getInfo()
String	getNewAddress()
String	getNewAddress(String account)
List<BitcoindRpcClient.PeerInfoResult>	getPeerInfo()
List<String>	getRawMemPool()
BitcoindRpcClient.RawTransaction	getRawTransaction(String txId)
String	getRawTransactionHex(String txId)
double	getReceivedByAddress(String address)
double	getReceivedByAddress(String address, int minConf) Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations.
SSLSocketFactory	getSslSocketFactory()
void	importPrivKey(String bitcoinPrivKey)
void	importPrivKey(String bitcoinPrivKey, String label)
void	importPrivKey(String bitcoinPrivKey, String label, boolean rescan)
void	invalidateBlock(String hash) In regtest mode, invalidates a block to create an orphan chain
Map<String,Number>	listAccounts() listaccounts [minconf=1]
Map<String,Number>	listAccounts(int minConf)
List<BitcoindRpcClient.ReceivedAddress>	listReceivedByAddress()
List<BitcoindRpcClient.ReceivedAddress>	listReceivedByAddress(int minConf)
List<BitcoindRpcClient.ReceivedAddress>	listReceivedByAddress(int minConf, boolean includeEmpty)
BitcoindRpcClient.TransactionsSinceBlock	listSinceBlock()
BitcoindRpcClient.TransactionsSinceBlock	listSinceBlock(String blockHash)
BitcoindRpcClient.TransactionsSinceBlock	listSinceBlock(String blockHash, int targetConfirmations)
List<BitcoindRpcClient.Transaction>	listTransactions()
List<BitcoindRpcClient.Transaction>	listTransactions(String account)
List<BitcoindRpcClient.Transaction>	listTransactions(String account, int count)
List<BitcoindRpcClient.Transaction>	listTransactions(String account, int count, int from)
List<BitcoindRpcClient.Unspent>	listUnspent()
List<BitcoindRpcClient.Unspent>	listUnspent(int minConf)
List<BitcoindRpcClient.Unspent>	listUnspent(int minConf, int maxConf)
List<BitcoindRpcClient.Unspent>	listUnspent(int minConf, int maxConf, String... addresses)
Object	loadResponse(InputStream in, Object expectedID, boolean close)
String	move(String fromAccount, String toBitcoinAddress, double amount)
String	move(String fromAccount, String toBitcoinAddress, double amount, int minConf)
String	move(String fromAccount, String toBitcoinAddress, double amount, int minConf, String comment)
byte[]	prepareRequest(String method, Object... params)
Object	query(String method, Object... o)
void	reconsiderBlock(String hash) In regtest mode, undo the invalidation of a block, possibly making it on the top of the chain
String	sendFrom(String fromAccount, String toBitcoinAddress, double amount)
String	sendFrom(String fromAccount, String toBitcoinAddress, double amount, int minConf)
String	sendFrom(String fromAccount, String toBitcoinAddress, double amount, int minConf, String comment)
String	sendFrom(String fromAccount, String toBitcoinAddress, double amount, int minConf, String comment, String commentTo) Will send the given amount to the given address, ensuring the account has a valid balance using minConf confirmations.
String	sendRawTransaction(String hex)
String	sendToAddress(String toAddress, double amount)
String	sendToAddress(String toAddress, double amount, String comment)
String	sendToAddress(String toAddress, double amount, String comment, String commentTo)
void	setGenerate(boolean b)
void	setHostnameVerifier(HostnameVerifier hostnameVerifier)
void	setSslSocketFactory(SSLSocketFactory sslSocketFactory)
String	signRawTransaction(String hex)
BitcoindRpcClient.AddressValidationResult	validateAddress(String address)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rpcURL

public final URL rpcURL

DEFAULT_JSONRPC_URL

public static final URL DEFAULT_JSONRPC_URL

DEFAULT_JSONRPC_TESTNET_URL

public static final URL DEFAULT_JSONRPC_TESTNET_URL

QUERY_CHARSET

public static final Charset QUERY_CHARSET

Constructor Detail

BitcoinJSONRPCClient

public BitcoinJSONRPCClient(String rpcUrl)
                     throws MalformedURLException

Throws:

MalformedURLException

BitcoinJSONRPCClient

public BitcoinJSONRPCClient(URL rpc)

BitcoinJSONRPCClient

public BitcoinJSONRPCClient(boolean testNet)

BitcoinJSONRPCClient

public BitcoinJSONRPCClient()

Method Detail

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier hostnameVerifier)

getSslSocketFactory

public SSLSocketFactory getSslSocketFactory()

setSslSocketFactory

public void setSslSocketFactory(SSLSocketFactory sslSocketFactory)

prepareRequest

public byte[] prepareRequest(String method,
                             Object... params)

loadResponse

public Object loadResponse(InputStream in,
                           Object expectedID,
                           boolean close)
                    throws IOException,
                           BitcoinRpcException

Throws:

IOException

BitcoinRpcException

query

public Object query(String method,
                    Object... o)
             throws BitcoinRpcException

Throws:

BitcoinRpcException

createRawTransaction

public String createRawTransaction(List<BitcoindRpcClient.TxInput> inputs,
                                   List<BitcoindRpcClient.TxOutput> outputs)
                            throws BitcoinRpcException

Specified by:

createRawTransaction in interface BitcoindRpcClient

Throws:

BitcoinRpcException

dumpPrivKey

public String dumpPrivKey(String address)
                   throws BitcoinRpcException

Specified by:

dumpPrivKey in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getAccount

public String getAccount(String address)
                  throws BitcoinRpcException

Specified by:

getAccount in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getAccountAddress

public String getAccountAddress(String address)
                         throws BitcoinRpcException

Specified by:

getAccountAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getAddressesByAccount

public List<String> getAddressesByAccount(String account)
                                   throws BitcoinRpcException

Specified by:

getAddressesByAccount in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBalance

public double getBalance()
                  throws BitcoinRpcException

Specified by:

getBalance in interface BitcoindRpcClient

Returns:

returns the server's total available balance

Throws:

BitcoinRpcException

getBalance

public double getBalance(String account)
                  throws BitcoinRpcException

Specified by:

getBalance in interface BitcoindRpcClient

Returns:

returns the balance in the account

Throws:

BitcoinRpcException

getBalance

public double getBalance(String account,
                         int minConf)
                  throws BitcoinRpcException

Specified by:

getBalance in interface BitcoindRpcClient

Returns:

returns the balance in the account

Throws:

BitcoinRpcException

getBlock

public BitcoindRpcClient.Block getBlock(int height)
                                 throws BitcoinRpcException

Specified by:

getBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBlock

public BitcoindRpcClient.Block getBlock(String blockHash)
                                 throws BitcoinRpcException

Specified by:

getBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBlockHash

public String getBlockHash(int height)
                    throws BitcoinRpcException

Specified by:

getBlockHash in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBlockChainInfo

public BitcoindRpcClient.BlockChainInfo getBlockChainInfo()
                                                   throws BitcoinRpcException

Specified by:

getBlockChainInfo in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBlockCount

public int getBlockCount()
                  throws BitcoinRpcException

Specified by:

getBlockCount in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getInfo

public BitcoindRpcClient.Info getInfo()
                               throws BitcoinRpcException

Specified by:

getInfo in interface BitcoindRpcClient

Returns:

infos about the bitcoind instance

Throws:

BitcoinRpcException

getNewAddress

public String getNewAddress()
                     throws BitcoinRpcException

Specified by:

getNewAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getNewAddress

public String getNewAddress(String account)
                     throws BitcoinRpcException

Specified by:

getNewAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getRawMemPool

public List<String> getRawMemPool()
                           throws BitcoinRpcException

Specified by:

getRawMemPool in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getBestBlockHash

public String getBestBlockHash()
                        throws BitcoinRpcException

Specified by:

getBestBlockHash in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getRawTransactionHex

public String getRawTransactionHex(String txId)
                            throws BitcoinRpcException

Specified by:

getRawTransactionHex in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getRawTransaction

public BitcoindRpcClient.RawTransaction getRawTransaction(String txId)
                                                   throws BitcoinRpcException

Specified by:

getRawTransaction in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getReceivedByAddress

public double getReceivedByAddress(String address)
                            throws BitcoinRpcException

Specified by:

getReceivedByAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getReceivedByAddress

public double getReceivedByAddress(String address,
                                   int minConf)
                            throws BitcoinRpcException

Description copied from interface: BitcoindRpcClient

Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations. While some might consider this obvious, value reported by this only considers *receiving* transactions. It does not check payments that have been made *from* this address. In other words, this is not "getaddressbalance". Works only for addresses in the local wallet, external addresses will always show 0.

Specified by:

getReceivedByAddress in interface BitcoindRpcClient

Returns:

the total amount received by <bitcoinaddress>

Throws:

BitcoinRpcException

importPrivKey

public void importPrivKey(String bitcoinPrivKey)
                   throws BitcoinRpcException

Specified by:

importPrivKey in interface BitcoindRpcClient

Throws:

BitcoinRpcException

importPrivKey

public void importPrivKey(String bitcoinPrivKey,
                          String label)
                   throws BitcoinRpcException

Specified by:

importPrivKey in interface BitcoindRpcClient

Throws:

BitcoinRpcException

importPrivKey

public void importPrivKey(String bitcoinPrivKey,
                          String label,
                          boolean rescan)
                   throws BitcoinRpcException

Specified by:

importPrivKey in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listAccounts

public Map<String,Number> listAccounts()
                                throws BitcoinRpcException

Description copied from interface: BitcoindRpcClient

listaccounts [minconf=1]

Specified by:

listAccounts in interface BitcoindRpcClient

Returns:

Map that has account names as keys, account balances as values

Throws:

BitcoinRpcException

listAccounts

public Map<String,Number> listAccounts(int minConf)
                                throws BitcoinRpcException

Specified by:

listAccounts in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listReceivedByAddress

public List<BitcoindRpcClient.ReceivedAddress> listReceivedByAddress()
                                                              throws BitcoinRpcException

Specified by:

listReceivedByAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listReceivedByAddress

public List<BitcoindRpcClient.ReceivedAddress> listReceivedByAddress(int minConf)
                                                              throws BitcoinRpcException

Specified by:

listReceivedByAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listReceivedByAddress

public List<BitcoindRpcClient.ReceivedAddress> listReceivedByAddress(int minConf,
                                                                     boolean includeEmpty)
                                                              throws BitcoinRpcException

Specified by:

listReceivedByAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listSinceBlock

public BitcoindRpcClient.TransactionsSinceBlock listSinceBlock()
                                                        throws BitcoinRpcException

Specified by:

listSinceBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listSinceBlock

public BitcoindRpcClient.TransactionsSinceBlock listSinceBlock(String blockHash)
                                                        throws BitcoinRpcException

Specified by:

listSinceBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listSinceBlock

public BitcoindRpcClient.TransactionsSinceBlock listSinceBlock(String blockHash,
                                                               int targetConfirmations)
                                                        throws BitcoinRpcException

Specified by:

listSinceBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listTransactions

public List<BitcoindRpcClient.Transaction> listTransactions()
                                                     throws BitcoinRpcException

Specified by:

listTransactions in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listTransactions

public List<BitcoindRpcClient.Transaction> listTransactions(String account)
                                                     throws BitcoinRpcException

Specified by:

listTransactions in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listTransactions

public List<BitcoindRpcClient.Transaction> listTransactions(String account,
                                                            int count)
                                                     throws BitcoinRpcException

Specified by:

listTransactions in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listTransactions

public List<BitcoindRpcClient.Transaction> listTransactions(String account,
                                                            int count,
                                                            int from)
                                                     throws BitcoinRpcException

Specified by:

listTransactions in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listUnspent

public List<BitcoindRpcClient.Unspent> listUnspent()
                                            throws BitcoinRpcException

Specified by:

listUnspent in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listUnspent

public List<BitcoindRpcClient.Unspent> listUnspent(int minConf)
                                            throws BitcoinRpcException

Specified by:

listUnspent in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listUnspent

public List<BitcoindRpcClient.Unspent> listUnspent(int minConf,
                                                   int maxConf)
                                            throws BitcoinRpcException

Specified by:

listUnspent in interface BitcoindRpcClient

Throws:

BitcoinRpcException

listUnspent

public List<BitcoindRpcClient.Unspent> listUnspent(int minConf,
                                                   int maxConf,
                                                   String... addresses)
                                            throws BitcoinRpcException

Specified by:

listUnspent in interface BitcoindRpcClient

Throws:

BitcoinRpcException

move

public String move(String fromAccount,
                   String toBitcoinAddress,
                   double amount)
            throws BitcoinRpcException

Specified by:

move in interface BitcoindRpcClient

Throws:

BitcoinRpcException

move

public String move(String fromAccount,
                   String toBitcoinAddress,
                   double amount,
                   int minConf)
            throws BitcoinRpcException

Specified by:

move in interface BitcoindRpcClient

Throws:

BitcoinRpcException

move

public String move(String fromAccount,
                   String toBitcoinAddress,
                   double amount,
                   int minConf,
                   String comment)
            throws BitcoinRpcException

Specified by:

move in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendFrom

public String sendFrom(String fromAccount,
                       String toBitcoinAddress,
                       double amount)
                throws BitcoinRpcException

Specified by:

sendFrom in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendFrom

public String sendFrom(String fromAccount,
                       String toBitcoinAddress,
                       double amount,
                       int minConf)
                throws BitcoinRpcException

Specified by:

sendFrom in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendFrom

public String sendFrom(String fromAccount,
                       String toBitcoinAddress,
                       double amount,
                       int minConf,
                       String comment)
                throws BitcoinRpcException

Specified by:

sendFrom in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendFrom

public String sendFrom(String fromAccount,
                       String toBitcoinAddress,
                       double amount,
                       int minConf,
                       String comment,
                       String commentTo)
                throws BitcoinRpcException

Description copied from interface: BitcoindRpcClient

Will send the given amount to the given address, ensuring the account has a valid balance using minConf confirmations.

Specified by:

sendFrom in interface BitcoindRpcClient

amount - is a real and is rounded to 8 decimal places

Returns:

the transaction ID if successful

Throws:

BitcoinRpcException

sendRawTransaction

public String sendRawTransaction(String hex)
                          throws BitcoinRpcException

Specified by:

sendRawTransaction in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendToAddress

public String sendToAddress(String toAddress,
                            double amount)
                     throws BitcoinRpcException

Specified by:

sendToAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendToAddress

public String sendToAddress(String toAddress,
                            double amount,
                            String comment)
                     throws BitcoinRpcException

Specified by:

sendToAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

sendToAddress

public String sendToAddress(String toAddress,
                            double amount,
                            String comment,
                            String commentTo)
                     throws BitcoinRpcException

Specified by:

sendToAddress in interface BitcoindRpcClient

amount - is a real and is rounded to 8 decimal places

Returns:

the transaction ID <txid> if successful

Throws:

BitcoinRpcException

signRawTransaction

public String signRawTransaction(String hex)
                          throws BitcoinRpcException

Specified by:

signRawTransaction in interface BitcoindRpcClient

Throws:

BitcoinRpcException

validateAddress

public BitcoindRpcClient.AddressValidationResult validateAddress(String address)
                                                          throws BitcoinRpcException

Specified by:

validateAddress in interface BitcoindRpcClient

Throws:

BitcoinRpcException

setGenerate

public void setGenerate(boolean b)
                 throws BitcoinRPCException

Specified by:

setGenerate in interface BitcoindRpcClient

Parameters:

b - a boolean indicating if blocks must be generated with the cpu

Throws:

BitcoinRPCException

generate

public List<String> generate(int numBlocks)
                      throws BitcoinRPCException

Description copied from interface: BitcoindRpcClient

Used in regtest mode to generate an arbitrary number of blocks

Specified by:

generate in interface BitcoindRpcClient

Parameters:

numBlocks - a boolean indicating if blocks must be generated with the cpu

Returns:

the list of hashes of the generated blocks

Throws:

BitcoinRPCException

getEstimateFee

public double getEstimateFee(int nBlocks)
                      throws BitcoinRpcException

Specified by:

getEstimateFee in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getEstimatePriority

public double getEstimatePriority(int nBlocks)
                           throws BitcoinRpcException

Specified by:

getEstimatePriority in interface BitcoindRpcClient

Throws:

BitcoinRpcException

invalidateBlock

public void invalidateBlock(String hash)
                     throws BitcoinRpcException

Description copied from interface: BitcoindRpcClient

In regtest mode, invalidates a block to create an orphan chain

Specified by:

invalidateBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

reconsiderBlock

public void reconsiderBlock(String hash)
                     throws BitcoinRpcException

Description copied from interface: BitcoindRpcClient

In regtest mode, undo the invalidation of a block, possibly making it on the top of the chain

Specified by:

reconsiderBlock in interface BitcoindRpcClient

Throws:

BitcoinRpcException

getPeerInfo

public List<BitcoindRpcClient.PeerInfoResult> getPeerInfo()
                                                   throws BitcoinRpcException

Specified by:

getPeerInfo in interface BitcoindRpcClient

Throws:

BitcoinRpcException