helium_py.currency.balance.Balance

class helium_py.currency.balance.Balance(balance_in_currency: Union[int, float, Decimal], currency_type: str)

Bases: object

Represents a balance in a particular currency.

__init__(balance_in_currency: Union[int, float, Decimal], currency_type: str)

Initialize balance with a currency type and amount.

Methods

__init__(balance_in_currency, currency_type)	Initialize balance with a currency type and amount.
divided_by(balance)	Divide two Balances of the same type together.
minus(balance)	Subtract two Balances of the same type together.
plus(balance)	Add two Balances of the same type together.
times(balance)	Multiply two Balances of the same type together.
to_data_credits([oracle_price])	Convert a balance to DATA_CREDITS.
to_network_tokens([oracle_price])	Convert a balance to NETWORK_TOKENS.
to_string([max_decimal_places, show_ticker])	Convert Balance objects to a string.
to_test_network_tokens([oracle_price])	Convert a balance to TEST_NETWORK_TOKENS.
to_usd([oracle_price])	Convert a balance to US_DOLLARS.

Attributes

currency_type
balance_in_currency

divided_by(balance: Balance) → Balance

Divide two Balances of the same type together.

minus(balance: Balance) → Balance

Subtract two Balances of the same type together.

plus(balance: Balance) → Balance

Add two Balances of the same type together.

times(balance: Balance) → Balance

Multiply two Balances of the same type together.

to_data_credits(oracle_price: Optional[Balance] = None) → Balance

Convert a balance to DATA_CREDITS.

to_network_tokens(oracle_price: Optional[Balance] = None) → Balance

Convert a balance to NETWORK_TOKENS.

to_string(max_decimal_places: Optional[int] = None, show_ticker: Optional[bool] = True) → str

Convert Balance objects to a string.

to_test_network_tokens(oracle_price: Optional[Balance] = None) → Balance

Convert a balance to TEST_NETWORK_TOKENS.

to_usd(oracle_price: Optional[Balance] = None) → Balance

Convert a balance to US_DOLLARS.