Package foundation.omni.netapi

Interface OmniBalanceService

All Known Subinterfaces:

ConsensusService, RxOmniWalletClient

All Known Implementing Classes:

OmniCoreClient, OmniCoreConsensusTool, OmniwalletAbstractClient, OmniwalletClient, OmniwalletConsensusTool, OmniwalletModernJDKClient

public interface OmniBalanceService

Common interface for Omni Core JSON-RPC and Omniwallet for fetching balances for addresses

Method Summary

Modifier and Type	Method	Description
default WalletAddressBalance	balancesForAddress(org.bitcoinj.base.Address address)	Deprecated. Use balancesForAddressAsync(Address)
CompletableFuture<WalletAddressBalance>	balancesForAddressAsync(org.bitcoinj.base.Address address)	Get balances for a single addresses asynchronously
default OmniJBalances	balancesForAddresses(List<org.bitcoinj.base.Address> addresses)	Deprecated. Use balancesForAddressesAsync(List)
CompletableFuture<OmniJBalances>	balancesForAddressesAsync(List<org.bitcoinj.base.Address> addresses)	Get balances for multiple addresses asynchronously
CompletableFuture<ChainTip>	getActiveChainTip()	Return current ChainTip

Method Details

balancesForAddresses

@Deprecated
default OmniJBalances balancesForAddresses(List<org.bitcoinj.base.Address> addresses)
                                    throws InterruptedException,
IOException

Deprecated.

Use balancesForAddressesAsync(List)

Get balances for multiple addresses

Parameters:

addresses - List of addresses to query

Returns:

A map of maps containing each property balance for each address

Throws:

InterruptedException - something went wrong

IOException - an I/O exception or API transport error occurred

balancesForAddressesAsync

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

Get balances for multiple addresses asynchronously

Parameters:

addresses - List of addresses to query

Returns:

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

balancesForAddress

@Deprecated
default WalletAddressBalance balancesForAddress(org.bitcoinj.base.Address address)
                                         throws InterruptedException,
IOException

Deprecated.

Use balancesForAddressAsync(Address)

Get balances for a single addresses

Parameters:

address - Single address to query

Returns:

a map of currency IDs to balances

Throws:

InterruptedException - something went wrong

IOException - an I/O exception or API transport error occurred

balancesForAddressAsync

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

Get balances for a single addresses asynchronously

Parameters:

address - Single address to query

Returns:

a future for a map of currency IDs to balances

getActiveChainTip

CompletableFuture<ChainTip> getActiveChainTip()

Return current ChainTip

Returns:

"active" ChainTip