Package foundation.omni.netapi.omniwallet

Class OmniwalletAbstractClient

java.lang.Object

foundation.omni.netapi.omniwallet.OmniwalletAbstractClient

All Implemented Interfaces:

ConsensusService, OmniBalanceService, RxOmniWalletClient, ConsensusFetcher, Closeable, AutoCloseable, ChainTipService

Direct Known Subclasses:

OmniwalletClient, OmniwalletModernJDKClient

public abstract class OmniwalletAbstractClient
extends Object
implements ConsensusService, RxOmniWalletClient, Closeable

Base class for Omniwallet Client implementations TODO: We should probably use composition rather than inheritance and have a RawOmniwallet interface and inject an implementation of that into the constructor of an OmniwalletConsensusService type.

Nested Class Summary

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

ConsensusFetcher.IndeterminateSnapshotException

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BALANCES_FOR_ADDRESSES_MAX_ADDR
protected final URI	baseURI
protected final Map<CurrencyID,PropertyType>	cachedPropertyTypes
static final int	CONNECT_TIMEOUT_MILLIS
protected boolean	debug
protected final org.bitcoinj.base.Network	network	netParams, if non-null, is used for validating addresses during deserialization
static final URI	omniExplorerApiBase
static final URI	omniwalletApiBase
static final URI	omniwalletBase	Deprecated.
static final int	READ_TIMEOUT_MILLIS
static final URI	stagingBase
protected boolean	strictMode

Constructor Summary

Constructors

Constructor	Description
OmniwalletAbstractClient(URI baseURI, boolean debug, boolean strictMode)
OmniwalletAbstractClient(URI baseURI, boolean debug, boolean strictMode, org.bitcoinj.base.Network network)

Method Summary

Modifier and Type	Method	Description
protected WalletAddressBalance	balanceEntryMapper(OmniwalletAddressBalance owb)
protected abstract CompletableFuture<Map<org.bitcoinj.base.Address,OmniwalletAddressBalance>>	balanceMapForAddress(org.bitcoinj.base.Address address)
protected abstract CompletableFuture<Map<org.bitcoinj.base.Address,OmniwalletAddressBalance>>	balanceMapForAddresses(List<org.bitcoinj.base.Address> addresses)
protected AddressBalanceEntry	balanceMapper(AddressVerifyInfo item, PropertyType propertyType)
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()
protected URI	consensusURI(CurrencyID currencyID)
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
protected PropertyType	divisibleToPropertyType(boolean divisible)
CompletableFuture<ChainTip>	getActiveChainTip()	Return current ChainTip
SortedMap<org.bitcoinj.base.Address,BalanceEntry>	getConsensusForCurrency(CurrencyID currencyID)	Fetch a consensus balance-map for a currency.
CompletableFuture<SortedMap<org.bitcoinj.base.Address,BalanceEntry>>	getConsensusForCurrencyAsync(CurrencyID currencyID)	Get a sorted map of consensus information for a currency.
CompletableFuture<List<OmniPropertyInfo>>	listSmartProperties()	Get a list of smart properties asynchronously.
protected CompletableFuture<PropertyType>	lookupPropertyType(CurrencyID propertyID)	Get the property type for a propertyId.
protected SmartPropertyListInfo	mapToSmartPropertyListInfo(OmniwalletPropertyInfo property)
protected abstract CompletableFuture<OmniwalletPropertiesListResponse>	propertiesList()
abstract CompletableFuture<RevisionInfo>	revisionInfo()
void	start()
protected OmniDivisibleValue	toOmniDivisibleValue(String inputStr)
protected OmniDivisibleValue	toOmniDivisibleValue(BigDecimal input)
protected OmniIndivisibleValue	toOmniIndivisibleValue(String input)
protected OmniIndivisibleValue	toOmniIndivisibleValue(BigInteger input)
protected OmniValue	toOmniValue(String input, PropertyType type)
protected abstract CompletableFuture<List<AddressVerifyInfo>>	verifyAddresses(CurrencyID currencyID)

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, getConsensusSnapshot, getConsensusSnapshotAsync

Methods inherited from interface foundation.omni.netapi.OmniBalanceService

balancesForAddress, balancesForAddresses

Methods inherited from interface foundation.omni.netapi.omniwallet.RxOmniWalletClient

currentChainTipMaybe, pollChainTipOnce

Field Details

omniwalletBase

@Deprecated
public static final URI omniwalletBase

Deprecated.

This endpoint has an older (and now slightly incompatible) API

omniwalletApiBase

public static final URI omniwalletApiBase

omniExplorerApiBase

public static final URI omniExplorerApiBase

stagingBase

public static final URI stagingBase

BALANCES_FOR_ADDRESSES_MAX_ADDR

public static final int BALANCES_FOR_ADDRESSES_MAX_ADDR

See Also:

• Constant Field Values

CONNECT_TIMEOUT_MILLIS

public static final int CONNECT_TIMEOUT_MILLIS

See Also:

• Constant Field Values

READ_TIMEOUT_MILLIS

public static final int READ_TIMEOUT_MILLIS

See Also:

• Constant Field Values

baseURI

protected final URI baseURI

debug

protected boolean debug

strictMode

protected boolean strictMode

network

protected final org.bitcoinj.base.Network network

netParams, if non-null, is used for validating addresses during deserialization

cachedPropertyTypes

protected final Map<CurrencyID,PropertyType> cachedPropertyTypes

Constructor Details

OmniwalletAbstractClient

public OmniwalletAbstractClient(URI baseURI,
 boolean debug,
 boolean strictMode)

OmniwalletAbstractClient

public OmniwalletAbstractClient(URI baseURI,
 boolean debug,
 boolean strictMode,
 org.bitcoinj.base.Network network)

Method Details

start

public void start()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

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

revisionInfo

public abstract CompletableFuture<RevisionInfo> revisionInfo()

propertiesList

protected abstract CompletableFuture<OmniwalletPropertiesListResponse> propertiesList()

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:

A future list of property objects

getConsensusForCurrency

public SortedMap<org.bitcoinj.base.Address,BalanceEntry> getConsensusForCurrency(CurrencyID currencyID)
                                                                          throws InterruptedException,
ExecutionException

Description copied from interface: ConsensusFetcher

Fetch a consensus balance-map for a currency.

Specified by:

getConsensusForCurrency in interface ConsensusFetcher

Parameters:

currencyID - The currency to fetch a balance map for

Returns:

A map of balances sorted by address

Throws:

InterruptedException - if something went wrong

ExecutionException - if something went wrong

getConsensusForCurrencyAsync

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

Get a sorted map of consensus information for a currency. Internally we use an CompletableFuture.thenCombine(java.util.concurrent.CompletionStage<? extends U>, java.util.function.BiFunction<? super T, ? super U, ? extends V>) to make an async call to lookupPropertyType(foundation.omni.CurrencyID) which if it doesn't find the property type in the cache may result in a network I/O to get the property list.

Specified by:

getConsensusForCurrencyAsync in interface ConsensusFetcher

Parameters:

currencyID - the currency.

Returns:

A future for a sorted map of address-balance consensus information

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

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

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

chainTipPublisher

public ChainTipPublisher chainTipPublisher()

Specified by:

chainTipPublisher in interface ChainTipService

balanceMapForAddress

protected abstract CompletableFuture<Map<org.bitcoinj.base.Address,OmniwalletAddressBalance>> balanceMapForAddress(org.bitcoinj.base.Address address)

balanceMapForAddresses

protected abstract CompletableFuture<Map<org.bitcoinj.base.Address,OmniwalletAddressBalance>> balanceMapForAddresses(List<org.bitcoinj.base.Address> addresses)

verifyAddresses

protected abstract CompletableFuture<List<AddressVerifyInfo>> verifyAddresses(CurrencyID currencyID)

balanceMapper

protected AddressBalanceEntry balanceMapper(AddressVerifyInfo item,
 PropertyType propertyType)

mapToSmartPropertyListInfo

protected SmartPropertyListInfo mapToSmartPropertyListInfo(OmniwalletPropertyInfo property)

lookupPropertyType

protected CompletableFuture<PropertyType> lookupPropertyType(CurrencyID propertyID)

Get the property type for a propertyId. Is asynchronous using CompletableFuture because if the value isn't in the cache, we'll need to fetch a list of properties from the server. TODO: Should we consider making this method more general and returning OmniPropertyInfo?

Parameters:

propertyID - The propertyId to lookup

Returns:

The property type.

balanceEntryMapper

protected WalletAddressBalance balanceEntryMapper(OmniwalletAddressBalance owb)

consensusURI

protected URI consensusURI(CurrencyID currencyID)

toOmniValue

protected OmniValue toOmniValue(String input,
 PropertyType type)

toOmniDivisibleValue

protected OmniDivisibleValue toOmniDivisibleValue(String inputStr)

toOmniDivisibleValue

protected OmniDivisibleValue toOmniDivisibleValue(BigDecimal input)

toOmniIndivisibleValue

protected OmniIndivisibleValue toOmniIndivisibleValue(String input)

toOmniIndivisibleValue

protected OmniIndivisibleValue toOmniIndivisibleValue(BigInteger input)

divisibleToPropertyType

protected PropertyType divisibleToPropertyType(boolean divisible)