Package foundation.omni.netapi.omnicore

Class OmniCoreClient

java.lang.Object

foundation.omni.netapi.omnicore.OmniCoreClient

All Implemented Interfaces:

ConsensusService, OmniBalanceService, ConsensusFetcher, AutoCloseable, RichListService<OmniValue,CurrencyID>, ChainTipService

Direct Known Subclasses:

OmniCoreConsensusTool

public class OmniCoreClient
extends Object
implements ConsensusService, RichListService<OmniValue,CurrencyID>, AutoCloseable

Omni Core "REST" client that implements same interfaces as Omniwallet REST client

Nested Class Summary

Nested classes/interfaces inherited from interface foundation.omni.rpc.ConsensusFetcher

ConsensusFetcher.IndeterminateSnapshotException

Field Summary

Fields

Modifier and Type	Field	Description
protected final OmniClient	client

Constructor Summary

Constructors

Constructor	Description
OmniCoreClient(OmniClient client)	Constructor that takes an existing RxOmniClient
OmniCoreClient(SSLContext sslContext, org.bitcoinj.base.Network network, URI coreURI, String user, String pass)
OmniCoreClient(SSLContext sslContext, org.bitcoinj.base.Network network, URI coreURI, String user, String pass, boolean useZmq, boolean isOmniProxy)
OmniCoreClient(org.bitcoinj.base.Network network, URI coreURI, String user, String pass)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<WalletAddressBalance>	balancesForAddressAsync(org.bitcoinj.base.Address address)	Get balances for a single addresses asynchronously
CompletableFuture<OmniJBalances>	balancesForAddressesAsync(List<org.bitcoinj.base.Address> addresses)	Get balances for multiple addresses asynchronously
ChainTipPublisher	chainTipPublisher()
void	close()
ConsensusSnapshot	createSnapshot(CurrencyID id, int blockHeight, SortedMap<org.bitcoinj.base.Address,BalanceEntry> entries)	Create a ConsensusSnapshot record.
CompletableFuture<Integer>	currentBlockHeightAsync()	Fetch the current block height
CompletableFuture<ChainTip>	getActiveChainTip()	Return current ChainTip
CompletableFuture<SortedMap<org.bitcoinj.base.Address,BalanceEntry>>	getConsensusForCurrencyAsync(CurrencyID currencyID)	Asynchronously get a sorted address-balance map for currency
protected static SSLContext	getDefaultSSLContext()	Return the default SSLContext without declaring a checked exception
OmniClient	getOmniClient()	Deprecated. use getRxOmniClient
OmniClient	getRxOmniClient()
List<org.bitcoinj.base.Address>	getWalletAddresses()	Get all addresses in a wallet Requires wallet support to be active
CompletableFuture<List<OmniPropertyInfo>>	listSmartProperties()	Get a list of smart properties asynchronously.
io.reactivex.rxjava3.core.Single<TokenRichList<OmniValue,CurrencyID>>	richList(CurrencyID id, int n)
org.reactivestreams.Publisher<TokenRichList<OmniValue,CurrencyID>>	richListUpdates(CurrencyID id, int n)

Methods inherited from class java.lang.Object

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

Methods inherited from interface foundation.omni.rpc.ConsensusFetcher

attemptConsensusSnapshotAsync, completeOrRetryConsensusSnapshot, getConsensusForCurrency, getConsensusSnapshot, getConsensusSnapshotAsync

Methods inherited from interface foundation.omni.netapi.OmniBalanceService

balancesForAddress, balancesForAddresses

Field Details

client

protected final OmniClient client

Constructor Details

OmniCoreClient

public OmniCoreClient(OmniClient client)

Constructor that takes an existing RxOmniClient

Parameters:

client - An existing client instance

OmniCoreClient

public OmniCoreClient(SSLContext sslContext,
 org.bitcoinj.base.Network network,
 URI coreURI,
 String user,
 String pass,
 boolean useZmq,
 boolean isOmniProxy)

OmniCoreClient

public OmniCoreClient(SSLContext sslContext,
 org.bitcoinj.base.Network network,
 URI coreURI,
 String user,
 String pass)

OmniCoreClient

public OmniCoreClient(org.bitcoinj.base.Network network,
 URI coreURI,
 String user,
 String pass)

Method Details

getDefaultSSLContext

protected static SSLContext getDefaultSSLContext()

Return the default SSLContext without declaring a checked exception

Returns:

The default SSLContext

currentBlockHeightAsync

public CompletableFuture<Integer> currentBlockHeightAsync()

Description copied from interface: ConsensusFetcher

Fetch the current block height

Specified by:

currentBlockHeightAsync in interface ConsensusFetcher

Returns:

A future for the current block height of the remote consensus server

listSmartProperties

public CompletableFuture<List<OmniPropertyInfo>> listSmartProperties()

Description copied from interface: ConsensusFetcher

Get a list of smart properties asynchronously.

Specified by:

listSmartProperties in interface ConsensusFetcher

Returns:

List of OmniPropertyInfo including an entry for Bitcoin

getConsensusForCurrencyAsync

public CompletableFuture<SortedMap<org.bitcoinj.base.Address,BalanceEntry>> getConsensusForCurrencyAsync(CurrencyID currencyID)

Description copied from interface: ConsensusFetcher

Asynchronously get a sorted address-balance map for currency

Specified by:

getConsensusForCurrencyAsync in interface ConsensusFetcher

Parameters:

currencyID - the currency.

Returns:

a future for the address-balance map.

balancesForAddressesAsync

public CompletableFuture<OmniJBalances> balancesForAddressesAsync(List<org.bitcoinj.base.Address> addresses)

Description copied from interface: OmniBalanceService

Get balances for multiple addresses asynchronously

Specified by:

balancesForAddressesAsync in interface OmniBalanceService

Parameters:

addresses - List of addresses to query

Returns:

A future, for a map of maps containing each property balance for each address

createSnapshot

public ConsensusSnapshot createSnapshot(CurrencyID id,
 int blockHeight,
 SortedMap<org.bitcoinj.base.Address,BalanceEntry> entries)

Description copied from interface: ConsensusFetcher

Create a ConsensusSnapshot record. Fills in client-specific information.

Specified by:

createSnapshot in interface ConsensusFetcher

Parameters:

id - Currency ID

blockHeight - blockheight

entries - a map of BalanceEntry objects

Returns:

ConsensusSnapshot

balancesForAddressAsync

public CompletableFuture<WalletAddressBalance> balancesForAddressAsync(org.bitcoinj.base.Address address)

Description copied from interface: OmniBalanceService

Get balances for a single addresses asynchronously

Specified by:

balancesForAddressAsync in interface OmniBalanceService

Parameters:

address - Single address to query

Returns:

a future for a map of currency IDs to balances

getActiveChainTip

public CompletableFuture<ChainTip> getActiveChainTip()

Description copied from interface: OmniBalanceService

Return current ChainTip

Specified by:

getActiveChainTip in interface OmniBalanceService

Returns:

"active" ChainTip

getOmniClient

@Deprecated
public OmniClient getOmniClient()

Deprecated.

use getRxOmniClient

getRxOmniClient

public OmniClient getRxOmniClient()

richList

public io.reactivex.rxjava3.core.Single<TokenRichList<OmniValue,CurrencyID>> richList(CurrencyID id,
 int n)

Specified by:

richList in interface RichListService<OmniValue,CurrencyID>

richListUpdates

public org.reactivestreams.Publisher<TokenRichList<OmniValue,CurrencyID>> richListUpdates(CurrencyID id,
 int n)

Specified by:

richListUpdates in interface RichListService<OmniValue,CurrencyID>

chainTipPublisher

public ChainTipPublisher chainTipPublisher()

Specified by:

chainTipPublisher in interface ChainTipService

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getWalletAddresses

public List<org.bitcoinj.base.Address> getWalletAddresses()
                                                   throws JsonRpcStatusException,
IOException

Get all addresses in a wallet Requires wallet support to be active

Returns:

A list of addresses

Throws:

JsonRpcStatusException - JSON HTTP status was not 200

IOException - Exception at lower-level