Package org.consensusj.bitcoin.services

Class WalletAppKitService

java.lang.Object

org.consensusj.bitcoin.services.WalletAppKitService

All Implemented Interfaces:

Closeable, AutoCloseable, BitcoinJsonRpc

Direct Known Subclasses:

MicronautWalletAppKitService

@Named
public class WalletAppKitService
extends Object
implements BitcoinJsonRpc, Closeable

Implement a subset of Bitcoin JSON RPC using a WalletAppKit

Field Summary

Fields

Modifier and Type	Field	Description
protected final HexFormat	hexFormat
protected final org.bitcoinj.kits.WalletAppKit	kit
protected final ObjectMapper	mapper
protected final org.bitcoinj.base.BitcoinNetwork	network

Fields inherited from interface org.consensusj.bitcoin.json.rpc.BitcoinJsonRpc

DEFAULT_MAX_CONF, DEFAULT_MIN_CONF

Constructor Summary

Constructors

Constructor	Description
WalletAppKitService(org.bitcoinj.kits.WalletAppKit walletAppKit)	Construct from an (un-started) WalletAppKit instance.

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<String>	createrawtransaction(List<Map<String,Object>> inputs, List<Map<String,String>> outputs)
static WalletAppKitService	createTemporary(org.bitcoinj.base.BitcoinNetwork network, org.bitcoinj.base.ScriptType scriptType, String walletBaseName)	Create an instance in a temporary directory.
static org.bitcoinj.kits.WalletAppKit	createTemporaryWallet(org.bitcoinj.base.BitcoinNetwork network, org.bitcoinj.base.ScriptType scriptType, String walletBaseName)
CompletableFuture<org.bitcoinj.base.Coin>	getbalance()
CompletableFuture<org.bitcoinj.base.Sha256Hash>	getbestblockhash()
CompletableFuture<JsonNode>	getblock(String blockHashString, Integer verbosity)	Partial implementation of `getblock` In the case where verbosity = 0, a block is returned without transactions (which is incorrect) For verbosity = 1, we return a BlockInfo, but some fields may be missing or incorrect, including a list of TXIDs For verbosity = 2, we are currently throwing an exception.
CompletableFuture<JsonNode>	getblock2(org.bitcoinj.base.Sha256Hash blockHash, Integer verbosity)
CompletableFuture<BlockChainInfo>	getblockchaininfo()
CompletableFuture<Integer>	getblockcount()
CompletableFuture<org.bitcoinj.base.Sha256Hash>	getblockhash(Integer blockNumber)	Placeholder -- currently throws `UnsupportedOperationException`
CompletableFuture<JsonNode>	getblockheader(String blockHashString, Boolean verbose)
CompletableFuture<JsonNode>	getblockheader2(org.bitcoinj.base.Sha256Hash blockHash, Boolean verbose)
CompletableFuture<BlockInfo>	getBlockInfo(org.bitcoinj.base.Sha256Hash blockHash, BlockInfo.IncludeTxFlag includeTx)
CompletableFuture<Integer>	getconnectioncount()
CompletableFuture<NetworkInfo>	getnetworkinfo()
CompletableFuture<org.bitcoinj.base.Address>	getnewaddress()
org.bitcoinj.core.PeerGroup	getPeerGroup()
CompletableFuture<String>	help()
CompletableFuture<List<UnspentOutput>>	listunspent(Integer minConf, Integer maxConf, List<String> addresses, Boolean includeUnsafe)
org.bitcoinj.base.Network	network()
protected <T> CompletableFuture<T>	result(T result)
CompletableFuture<org.bitcoinj.base.Sha256Hash>	sendrawtransaction(String hex)
CompletableFuture<org.bitcoinj.base.Sha256Hash>	sendtoaddress(String toAddressString, Double amountDouble)	Send coins to an address
CompletableFuture<SignedRawTransaction>	signrawtransactionwithwallet(String hex)	Currently all UTXOs must be present in the wallet and sighashtype defaults to "ALL".
void	start()
CompletableFuture<String>	stop()

Methods inherited from class java.lang.Object

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

Field Details

hexFormat

protected final HexFormat hexFormat

network

protected final org.bitcoinj.base.BitcoinNetwork network

kit

protected final org.bitcoinj.kits.WalletAppKit kit

mapper

protected final ObjectMapper mapper

Constructor Details

WalletAppKitService

@Inject
public WalletAppKitService(org.bitcoinj.kits.WalletAppKit walletAppKit)

Construct from an (un-started) WalletAppKit instance.

Parameters:

walletAppKit - instance

Method Details

createTemporary

public static WalletAppKitService createTemporary(org.bitcoinj.base.BitcoinNetwork network,
 org.bitcoinj.base.ScriptType scriptType,
 String walletBaseName)

Create an instance in a temporary directory. Useful for testing.

Parameters:

network - network to operate on

scriptType - script type for wallet

walletBaseName - base name for the two wallet files

Returns:

an un-started instance (use start() to start it)

createTemporaryWallet

public static org.bitcoinj.kits.WalletAppKit createTemporaryWallet(org.bitcoinj.base.BitcoinNetwork network,
 org.bitcoinj.base.ScriptType scriptType,
 String walletBaseName)

start

@PostConstruct
public void start()

network

public org.bitcoinj.base.Network network()

getPeerGroup

public org.bitcoinj.core.PeerGroup getPeerGroup()

help

public CompletableFuture<String> help()

Specified by:

help in interface BitcoinJsonRpc

stop

public CompletableFuture<String> stop()

Specified by:

stop in interface BitcoinJsonRpc

getblockcount

public CompletableFuture<Integer> getblockcount()

Specified by:

getblockcount in interface BitcoinJsonRpc

getbestblockhash

public CompletableFuture<org.bitcoinj.base.Sha256Hash> getbestblockhash()

Specified by:

getbestblockhash in interface BitcoinJsonRpc

getblockheader

public CompletableFuture<JsonNode> getblockheader(String blockHashString,
 Boolean verbose)

Specified by:

getblockheader in interface BitcoinJsonRpc

getblockheader2

public CompletableFuture<JsonNode> getblockheader2(org.bitcoinj.base.Sha256Hash blockHash,
 Boolean verbose)

getblock

public CompletableFuture<JsonNode> getblock(String blockHashString,
 Integer verbosity)

Partial implementation of `getblock` In the case where verbosity = 0, a block is returned without transactions (which is incorrect) For verbosity = 1, we return a BlockInfo, but some fields may be missing or incorrect, including a list of TXIDs For verbosity = 2, we are currently throwing an exception.

Specified by:

getblock in interface BitcoinJsonRpc

Parameters:

blockHashString - The hash of the block we are to return (as hex)

verbosity - Specifies the format to return (currently only `1` halfway works)

Returns:

Either a `Block` or `BlockInfo` depending upon verbosity.

getblock2

public CompletableFuture<JsonNode> getblock2(org.bitcoinj.base.Sha256Hash blockHash,
 Integer verbosity)

getblockhash

public CompletableFuture<org.bitcoinj.base.Sha256Hash> getblockhash(Integer blockNumber)

Placeholder -- currently throws `UnsupportedOperationException`

Specified by:

getblockhash in interface BitcoinJsonRpc

Parameters:

blockNumber - The block height of the desired block

Returns:

The Sha256Hash of the specified block

getconnectioncount

public CompletableFuture<Integer> getconnectioncount()

Specified by:

getconnectioncount in interface BitcoinJsonRpc

getblockchaininfo

public CompletableFuture<BlockChainInfo> getblockchaininfo()

Specified by:

getblockchaininfo in interface BitcoinJsonRpc

getnetworkinfo

public CompletableFuture<NetworkInfo> getnetworkinfo()

Specified by:

getnetworkinfo in interface BitcoinJsonRpc

createrawtransaction

public CompletableFuture<String> createrawtransaction(List<Map<String,Object>> inputs,
 List<Map<String,String>> outputs)

Specified by:

createrawtransaction in interface BitcoinJsonRpc

getnewaddress

public CompletableFuture<org.bitcoinj.base.Address> getnewaddress()

Specified by:

getnewaddress in interface BitcoinJsonRpc

getbalance

public CompletableFuture<org.bitcoinj.base.Coin> getbalance()

Specified by:

getbalance in interface BitcoinJsonRpc

listunspent

public CompletableFuture<List<UnspentOutput>> listunspent(Integer minConf,
 Integer maxConf,
 List<String> addresses,
 Boolean includeUnsafe)

Specified by:

listunspent in interface BitcoinJsonRpc

sendtoaddress

public CompletableFuture<org.bitcoinj.base.Sha256Hash> sendtoaddress(String toAddressString,
 Double amountDouble)

Send coins to an address

Specified by:

sendtoaddress in interface BitcoinJsonRpc

Parameters:

toAddressString - Address to send coins to

amountDouble - Amount to send

Returns:

future that completes with a transaction hash/id when the tx is successfully relayed

sendrawtransaction

public CompletableFuture<org.bitcoinj.base.Sha256Hash> sendrawtransaction(String hex)

Specified by:

sendrawtransaction in interface BitcoinJsonRpc

signrawtransactionwithwallet

public CompletableFuture<SignedRawTransaction> signrawtransactionwithwallet(String hex)

Description copied from interface: BitcoinJsonRpc

Currently all UTXOs must be present in the wallet and sighashtype defaults to "ALL".

Specified by:

signrawtransactionwithwallet in interface BitcoinJsonRpc

Parameters:

hex - hex-encoded unsigned raw transaction

Returns:

signed raw transaction

getBlockInfo

public CompletableFuture<BlockInfo> getBlockInfo(org.bitcoinj.base.Sha256Hash blockHash,
 BlockInfo.IncludeTxFlag includeTx)

result

protected <T> CompletableFuture<T> result(T result)

close

@PreDestroy
public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable