HBAR
Constructor
Type
Description
new Hbar(<amount>)
Hbar
Initializes the Hbar object
HBAR from:
Construct HBAR from different representations.
Method
Type
Description
Hbar.from(<hbars>)
long / BigDecimal
Returns an Hbar whose value is equal to the specified value
Hbar.from(<hbars, unit>)
long / BigDecimal , HbarUnit
Returns an Hbar representing the value in the given units
Hbar.fromString(<text>)
CharSequence
Converts the provided string into an amount of hbars
Hbar.fromString(<text, unit>)
CharSequence, HbarUnit
Converts the provided string into an amount of hbars
Hbar.fromTinybars(<tinybars>)
long
Returns an Hbar converted from the specified number of tinybars
HBAR to:
Convert HBAR to a different unit/format.
Method
Type
Description
to(<unit>)
HbarUnit
Specify the unit of hbar to convert to. Use As
for Go.
toString(<unit>)
HbarUnit
String value of the hbar unit to convert to. Use String()
for Go.
toTinybars()
Long
Hbar value converted to tinybars
HBAR constants:
Provided constant values of HBAR.
Method
Type
Description
Hbar.MAX
Hbar
A constant value of the maximum number of hbars (50_000_000_000 hbars)
Hbar.MIN
Hbar
A constant value of the minimum number of hbars (-50_000_000_000 hbars)
Hbar.ZERO
Hbar
A constant value of zero hbars
HBAR units
Modify the HBAR representation to one of the HBAR denominations.
Function
Description
HbarUnit.TINYBAR
The atomic (smallest) unit of hbar, used natively by the Hedera network
HbarUnit.MICROBAR
Equivalent to 100 tinybar or 1⁄1,000,000 hbar.
HbarUnit.MILLIBAR
Equivalent to 100,000 tinybar or 1⁄1,000 hbar
HbarUnit.HBAR
The base unit of hbar, equivalent to 100 million tinybar.
HbarUnit.KILOBAR
Equivalent to 1 thousand hbar or 100 billion tinybar.HbarUnit.Megabar
HbarUnit.MEGABAR
Equivalent to 1 million hbar or 100 trillion tinybar.
HbarUnit.GIGABAR
Equivalent to 1 billion hbar or 100 quadrillion tinybar.
HBAR decimal places
The decimal precision of HBAR varies across the different Hedera APIs, with HAPI, JSON-RPC Relay, and Hedera Smart Contract Service (EVM) returning 8 decimal places, while JSON-RPC Relay msg.value
returns 18 decimal places.
Hedera API (HAPI) (Crypto + SCS Service (msg.value
))
8
Hedera Smart Contract Service (EVM)
8
JSON RPC Relay (passed as arguments)
8
JSON RPC Relay (msg.value
)
18
Note: The JSON-RPC Relay msg.value
uses 18 decimals when it returns HBAR. As a result, the gasPrice
also uses 18 decimal places since it is only utilized from the JSON-RPC Relay.
Last updated