Package org.consensusj.bitcoin.jsonrpc.test

Class RegTestFundingSource

java.lang.Object

org.consensusj.bitcoin.jsonrpc.test.RegTestFundingSource

All Implemented Interfaces:

FundingSource

public class RegTestFundingSource
extends Object
implements FundingSource

FundingSource using RegTest mining, BitcoinExtendedClient (with getRegTestMiningAddress), and the server's default wallet for accumulating coins.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BitcoinExtendedClient	client

Constructor Summary

Constructors

Constructor	Description
RegTestFundingSource(BitcoinExtendedClient client)

Method Summary

Modifier and Type	Method	Description
org.bitcoinj.base.Address	createFundedAddress(org.bitcoinj.base.Coin amount)	Create an address and fund it with bitcoin.
TransactionIngredients	createIngredients(org.bitcoinj.base.Coin amount)	Create everything needed to assemble a custom transaction
void	fundingSourceMaintenance()	An opportunity to do any necessary housekeeping.
org.bitcoinj.base.Sha256Hash	requestBitcoin(org.bitcoinj.base.Address toAddress, org.bitcoinj.base.Coin requestAmount)	Generate blocks (if necessary) and fund an address with requested amount of BTC.

Methods inherited from class java.lang.Object

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

Field Details

client

protected final BitcoinExtendedClient client

Constructor Details

RegTestFundingSource

public RegTestFundingSource(BitcoinExtendedClient client)

Method Details

requestBitcoin

public org.bitcoinj.base.Sha256Hash requestBitcoin(org.bitcoinj.base.Address toAddress,
 org.bitcoinj.base.Coin requestAmount)
                                            throws JsonRpcException,
IOException

Generate blocks (if necessary) and fund an address with requested amount of BTC. This will create, sign, and transmit a transaction to fund an address with BTC. This method does not mine a block to confirm the transaction. A separate call to BitcoinExtendedClient.generateBlocks(int) or equivalent must be made to confirm the transaction.

Specified by:

requestBitcoin in interface FundingSource

Parameters:

toAddress - Address to fund with BTC

requestAmount - Amount of BTC to "mine" and send (minimum ending balance of toAddress?)

Returns:

The hash of an unconfirmed transaction that provides the funds.

Throws:

JsonRpcException

IOException

createFundedAddress

public org.bitcoinj.base.Address createFundedAddress(org.bitcoinj.base.Coin amount)
                                              throws Exception

Create an address and fund it with bitcoin. This will create, sign, and transmit a transaction to fund an address with BTC. This method does not mine a block to confirm the transaction. A separate call to BitcoinExtendedClient.generateBlocks(int) or equivalent must be made to confirm the transaction.

Specified by:

createFundedAddress in interface FundingSource

Parameters:

amount - requested amount of BTC

Returns:

Newly created address that will have the requested amount of bitcoin after the next block is mined

Throws:

Exception

createIngredients

public TransactionIngredients createIngredients(org.bitcoinj.base.Coin amount)
                                         throws JsonRpcException,
IOException

Create everything needed to assemble a custom transaction

Parameters:

amount - Amount of BTC to be available on new address

Returns:

An address, private key, and list of unspent outputs

Throws:

JsonRpcException

IOException

fundingSourceMaintenance

public void fundingSourceMaintenance()

Description copied from interface: FundingSource

An opportunity to do any necessary housekeeping. (e.g. consolidation)

Specified by:

fundingSourceMaintenance in interface FundingSource