wf.bitcoin.javabitcoindrpcclient

Interface BitcoindRpcClient

All Known Implementing Classes:

BitcoinJSONRPCClient

public interface BitcoindRpcClient

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BitcoindRpcClient.Address
static interface	BitcoindRpcClient.AddressValidationResult
static class	BitcoindRpcClient.BasicTxInput
static class	BitcoindRpcClient.BasicTxOutput
static interface	BitcoindRpcClient.Block
static interface	BitcoindRpcClient.BlockChainInfo
static interface	BitcoindRpcClient.DecodedScript
static class	BitcoindRpcClient.ExtendedTxInput
static interface	BitcoindRpcClient.Info
static interface	BitcoindRpcClient.MiningInfo
static interface	BitcoindRpcClient.MultiSig
static interface	BitcoindRpcClient.NetTotals
static interface	BitcoindRpcClient.Network
static interface	BitcoindRpcClient.NetworkInfo
static interface	BitcoindRpcClient.NodeInfo
static interface	BitcoindRpcClient.PeerInfoResult
static interface	BitcoindRpcClient.RawTransaction
static interface	BitcoindRpcClient.ReceivedAddress
static interface	BitcoindRpcClient.SmartFeeResult
static interface	BitcoindRpcClient.Transaction returned by listsinceblock and listtransactions
static interface	BitcoindRpcClient.TransactionsSinceBlock
static interface	BitcoindRpcClient.TxInput
static interface	BitcoindRpcClient.TxOut
static interface	BitcoindRpcClient.TxOutput
static interface	BitcoindRpcClient.TxOutSetInfo
static interface	BitcoindRpcClient.Unspent
static interface	BitcoindRpcClient.WalletInfo

Method Summary

Modifier and Type	Method and Description
String	addMultiSigAddress(int nRequired, List<String> keyObject)
String	addMultiSigAddress(int nRequired, List<String> keyObject, String account)
void	addNode(String node, String command)
void	backupWallet(String destination)
BitcoindRpcClient.MultiSig	createMultiSig(int nRequired, List<String> keys)
String	createRawTransaction(List<BitcoindRpcClient.TxInput> inputs, List<BitcoindRpcClient.TxOutput> outputs)
BitcoindRpcClient.DecodedScript	decodeScript(String hex)
String	dumpPrivKey(String address)
void	dumpWallet(String filename)
void	encryptWallet(String passPhrase)
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<BitcoindRpcClient.NodeInfo>	getAddedNodeInfo(boolean dummy, String node)
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)
long	getConnectionCount()
double	getDifficulty()
double	getEstimateFee(int nBlocks)
double	getEstimatePriority(int nBlocks)
BitcoindRpcClient.SmartFeeResult	getEstimateSmartFee(int blocks)
boolean	getGenerate()
BitcoindRpcClient.Info	getInfo()
BitcoindRpcClient.MiningInfo	getMiningInfo()
BitcoindRpcClient.NetTotals	getNetTotals()
double	getNetworkHashPs()
BitcoindRpcClient.NetworkInfo	getNetworkInfo()
String	getNewAddress()
String	getNewAddress(String account)
List<BitcoindRpcClient.PeerInfoResult>	getPeerInfo()
String	getRawBlock(String blockHash)
String	getRawChangeAddress()
List<String>	getRawMemPool()
BitcoindRpcClient.RawTransaction	getRawTransaction(String txId)
String	getRawTransactionHex(String txId)
BigDecimal	getReceivedByAccount(String account)
double	getReceivedByAddress(String address)
double	getReceivedByAddress(String address, int minConf) Returns the total amount received by <bitcoinaddress> in transactions with at least [minconf] confirmations.
BitcoindRpcClient.TxOut	getTxOut(String txId, long vout)
BitcoindRpcClient.TxOutSetInfo	getTxOutSetInfo()
double	getUnconfirmedBalance()
BitcoindRpcClient.WalletInfo	getWalletInfo()
Object	importAddress(String address, String label, boolean rescan)
void	importPrivKey(String bitcoinPrivKey)
void	importPrivKey(String bitcoinPrivKey, String label)
void	importPrivKey(String bitcoinPrivKey, String label, boolean rescan)
void	importWallet(String filename)
void	invalidateBlock(String hash) In regtest mode, invalidates a block to create an orphan chain
void	keyPoolRefill()
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)
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)
void	ping()
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 doGenerate)
boolean	setTxFee(BigDecimal amount)
String	signMessage(String bitcoinAdress, String message)
String	signRawTransaction(String hex, List<BitcoindRpcClient.ExtendedTxInput> inputs, List<String> privateKeys)
void	stop()
void	submitBlock(String hexData)
BitcoindRpcClient.AddressValidationResult	validateAddress(String address)
boolean	verifyChain()
boolean	verifyMessage(String bitcoinAddress, String signature, String message)
void	walletPassPhrase(String passPhrase, long timeOut)

Method Detail

createRawTransaction

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

Throws:

GenericRpcException

dumpPrivKey

String dumpPrivKey(String address)
            throws GenericRpcException

Throws:

GenericRpcException

getAccount

String getAccount(String address)
           throws GenericRpcException

Throws:

GenericRpcException

getAccountAddress

String getAccountAddress(String address)
                  throws GenericRpcException

Throws:

GenericRpcException

getAddressesByAccount

List<String> getAddressesByAccount(String account)
                            throws GenericRpcException

Throws:

GenericRpcException

getBalance

double getBalance()
           throws GenericRpcException

Returns:

returns the server's total available balance

Throws:

GenericRpcException

getBalance

double getBalance(String account)
           throws GenericRpcException

Parameters:

account -

Returns:

returns the balance in the account

Throws:

GenericRpcException

getBalance

double getBalance(String account,
                  int minConf)
           throws GenericRpcException

Parameters:

account -

minConf -

Returns:

returns the balance in the account

Throws:

GenericRpcException

getInfo

BitcoindRpcClient.Info getInfo()
                        throws GenericRpcException

Returns:

infos about the bitcoind instance

Throws:

GenericRpcException

getMiningInfo

BitcoindRpcClient.MiningInfo getMiningInfo()
                                    throws GenericRpcException

Returns:

miningInfo about the bitcoind instance

Throws:

GenericRpcException

createMultiSig

BitcoindRpcClient.MultiSig createMultiSig(int nRequired,
                                          List<String> keys)
                                   throws GenericRpcException

Throws:

GenericRpcException

getNetworkInfo

BitcoindRpcClient.NetworkInfo getNetworkInfo()
                                      throws GenericRpcException

Throws:

GenericRpcException

getTxOutSetInfo

BitcoindRpcClient.TxOutSetInfo getTxOutSetInfo()

getWalletInfo

BitcoindRpcClient.WalletInfo getWalletInfo()

getBlock

BitcoindRpcClient.Block getBlock(int height)
                          throws GenericRpcException

Throws:

GenericRpcException

getBlock

BitcoindRpcClient.Block getBlock(String blockHash)
                          throws GenericRpcException

Throws:

GenericRpcException

getRawBlock

String getRawBlock(String blockHash)
            throws GenericRpcException

Throws:

GenericRpcException

getBlockHash

String getBlockHash(int height)
             throws GenericRpcException

Throws:

GenericRpcException

getBlockChainInfo

BitcoindRpcClient.BlockChainInfo getBlockChainInfo()
                                            throws GenericRpcException

Throws:

GenericRpcException

getBlockCount

int getBlockCount()
           throws GenericRpcException

Throws:

GenericRpcException

getNewAddress

String getNewAddress()
              throws GenericRpcException

Throws:

GenericRpcException

getNewAddress

String getNewAddress(String account)
              throws GenericRpcException

Throws:

GenericRpcException

getRawMemPool

List<String> getRawMemPool()
                    throws GenericRpcException

Throws:

GenericRpcException

getBestBlockHash

String getBestBlockHash()
                 throws GenericRpcException

Throws:

GenericRpcException

getRawTransactionHex

String getRawTransactionHex(String txId)
                     throws GenericRpcException

Throws:

GenericRpcException

getRawTransaction

BitcoindRpcClient.RawTransaction getRawTransaction(String txId)
                                            throws GenericRpcException

Throws:

GenericRpcException

getReceivedByAddress

double getReceivedByAddress(String address)
                     throws GenericRpcException

Throws:

GenericRpcException

getReceivedByAddress

double getReceivedByAddress(String address,
                            int minConf)
                     throws GenericRpcException

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.

Parameters:

address -

minConf -

Returns:

the total amount received by <bitcoinaddress>

Throws:

GenericRpcException

importPrivKey

void importPrivKey(String bitcoinPrivKey)
            throws GenericRpcException

Throws:

GenericRpcException

importPrivKey

void importPrivKey(String bitcoinPrivKey,
                   String label)
            throws GenericRpcException

Throws:

GenericRpcException

importPrivKey

void importPrivKey(String bitcoinPrivKey,
                   String label,
                   boolean rescan)
            throws GenericRpcException

Throws:

GenericRpcException

importAddress

Object importAddress(String address,
                     String label,
                     boolean rescan)
              throws GenericRpcException

Throws:

GenericRpcException

listAccounts

Map<String,Number> listAccounts()
                         throws GenericRpcException

listaccounts [minconf=1]

Returns:

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

Throws:

GenericRpcException

listAccounts

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

Throws:

GenericRpcException

listReceivedByAddress

List<BitcoindRpcClient.ReceivedAddress> listReceivedByAddress()
                                                       throws GenericRpcException

Throws:

GenericRpcException

listReceivedByAddress

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

Throws:

GenericRpcException

listReceivedByAddress

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

Throws:

GenericRpcException

listSinceBlock

BitcoindRpcClient.TransactionsSinceBlock listSinceBlock()
                                                 throws GenericRpcException

Throws:

GenericRpcException

listSinceBlock

BitcoindRpcClient.TransactionsSinceBlock listSinceBlock(String blockHash)
                                                 throws GenericRpcException

Throws:

GenericRpcException

listSinceBlock

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

Throws:

GenericRpcException

listTransactions

List<BitcoindRpcClient.Transaction> listTransactions()
                                              throws GenericRpcException

Throws:

GenericRpcException

listTransactions

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

Throws:

GenericRpcException

listTransactions

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

Throws:

GenericRpcException

listTransactions

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

Throws:

GenericRpcException

listUnspent

List<BitcoindRpcClient.Unspent> listUnspent()
                                     throws GenericRpcException

Throws:

GenericRpcException

listUnspent

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

Throws:

GenericRpcException

listUnspent

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

Throws:

GenericRpcException

listUnspent

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

Throws:

GenericRpcException

move

String move(String fromAccount,
            String toBitcoinAddress,
            double amount)
     throws GenericRpcException

Throws:

GenericRpcException

move

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

Throws:

GenericRpcException

move

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

Throws:

GenericRpcException

sendFrom

String sendFrom(String fromAccount,
                String toBitcoinAddress,
                double amount)
         throws GenericRpcException

Throws:

GenericRpcException

sendFrom

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

Throws:

GenericRpcException

sendFrom

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

Throws:

GenericRpcException

sendFrom

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

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

Parameters:

fromAccount -

toBitcoinAddress -

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

minConf -

comment -

commentTo -

Returns:

the transaction ID if successful

Throws:

GenericRpcException

sendRawTransaction

String sendRawTransaction(String hex)
                   throws GenericRpcException

Throws:

GenericRpcException

sendToAddress

String sendToAddress(String toAddress,
                     double amount)
              throws GenericRpcException

Throws:

GenericRpcException

sendToAddress

String sendToAddress(String toAddress,
                     double amount,
                     String comment)
              throws GenericRpcException

Throws:

GenericRpcException

sendToAddress

String sendToAddress(String toAddress,
                     double amount,
                     String comment,
                     String commentTo)
              throws GenericRpcException

Parameters:

toAddress -

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

comment -

commentTo -

Returns:

the transaction ID <txid> if successful

Throws:

GenericRpcException

signRawTransaction

String signRawTransaction(String hex,
                          List<BitcoindRpcClient.ExtendedTxInput> inputs,
                          List<String> privateKeys)
                   throws GenericRpcException

Throws:

GenericRpcException

setGenerate

void setGenerate(boolean doGenerate)
          throws BitcoinRPCException

Parameters:

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

Throws:

BitcoinRPCException

generate

List<String> generate(int numBlocks)
               throws BitcoinRPCException

Used in regtest mode to generate an arbitrary number of blocks

Parameters:

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

Returns:

the list of hashes of the generated blocks

Throws:

BitcoinRPCException

validateAddress

BitcoindRpcClient.AddressValidationResult validateAddress(String address)
                                                   throws GenericRpcException

Throws:

GenericRpcException

getEstimateFee

double getEstimateFee(int nBlocks)
               throws GenericRpcException

Throws:

GenericRpcException

getEstimatePriority

double getEstimatePriority(int nBlocks)
                    throws GenericRpcException

Throws:

GenericRpcException

invalidateBlock

void invalidateBlock(String hash)
              throws GenericRpcException

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

Parameters:

hash -

Throws:

GenericRpcException

reconsiderBlock

void reconsiderBlock(String hash)
              throws GenericRpcException

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

Parameters:

hash -

Throws:

GenericRpcException

getPeerInfo

List<BitcoindRpcClient.PeerInfoResult> getPeerInfo()

stop

void stop()

getRawChangeAddress

String getRawChangeAddress()

getConnectionCount

long getConnectionCount()

getUnconfirmedBalance

double getUnconfirmedBalance()

getDifficulty

double getDifficulty()

ping

void ping()

decodeScript

BitcoindRpcClient.DecodedScript decodeScript(String hex)

getNetTotals

BitcoindRpcClient.NetTotals getNetTotals()

getGenerate

boolean getGenerate()

getNetworkHashPs

double getNetworkHashPs()

setTxFee

boolean setTxFee(BigDecimal amount)

addNode

void addNode(String node,
             String command)

backupWallet

void backupWallet(String destination)

signMessage

String signMessage(String bitcoinAdress,
                   String message)

dumpWallet

void dumpWallet(String filename)

importWallet

void importWallet(String filename)

keyPoolRefill

void keyPoolRefill()

getReceivedByAccount

BigDecimal getReceivedByAccount(String account)

encryptWallet

void encryptWallet(String passPhrase)

walletPassPhrase

void walletPassPhrase(String passPhrase,
                      long timeOut)

verifyMessage

boolean verifyMessage(String bitcoinAddress,
                      String signature,
                      String message)

addMultiSigAddress

String addMultiSigAddress(int nRequired,
                          List<String> keyObject)

addMultiSigAddress

String addMultiSigAddress(int nRequired,
                          List<String> keyObject,
                          String account)

verifyChain

boolean verifyChain()

getAddedNodeInfo

List<BitcoindRpcClient.NodeInfo> getAddedNodeInfo(boolean dummy,
                                                  String node)

submitBlock

void submitBlock(String hexData)

getTxOut

BitcoindRpcClient.TxOut getTxOut(String txId,
                                 long vout)

getEstimateSmartFee

BitcoindRpcClient.SmartFeeResult getEstimateSmartFee(int blocks)