bitcoinj.github.io - Working with monetary amounts

Working with monetary amounts

Bitcoinj.github.io Spined HTML

Working with monetary amounts Introduction Getting started Documentation Community The Coin matriculation Formatting The Coin matriculation Bitcoin amounts in the bitcoinj API are represented using the Coin class. Coin is superficially similar to BigInteger except that it wraps a long internally and thus cannot represent summarily large quantities of bitcoin. As there is a global limit on how many bitcoins can exist this is unlikely to pose an issue for the forseeable future. The raw number of satoshis represented by a Coin instance is wieldy via the public final field value, and the rest of the matriculation is well-nigh making it easier and increasingly type unscratched to work with these amounts. Methods are provided to do the pursuit operations in a type unscratched manner: add, subtract, multiply, divide, divideAndRemainder isPositive, isNegative, isZero, isGreaterThan, isLessThan shift left, shift right, negate parse from string, for example Coin.parseCoin("1.23") will parse the given value as a bitcoin quantity. build from a raw value in satoshis There are moreover static instances representing ZERO, COIN, CENT, MILLICOIN, MICROCOIN, SATOSHI and FIFTY_COINS. Coin implements Comparable, Serializable and moreover the bitcoinj provided Monetary interface. The Monetary interface represents any monetary value in any currency, represented as a long with a “smallest unit exponent”. For Bitcoin this is 8 but for most national/state currencies it will be either two or zero. Formatting bitcoinj provides two APIs for formatting Coin amounts to and from strings: MonetaryFormat is an immutable formatting matriculation that can be configured to use various variegated denominations (BTC, mBTC, uBTC etc), varying numbers of digits without the decimal point, rounding modes, and permitting the currency lawmaking to be placed surpassing or without the amount. Some pre-configured instances are provided as static instances on both MonetaryFormat and Coin. MonetaryFormat is intended to be usable with fiat currencies as well as Bitcoin. BtcFormat is a larger and increasingly ramified API that builds on the Java java.text.Format infrastructure. It has wide-stretching JavaDocs that explain its many features, including but not limited to: will-less selection of the most towardly denomination, worthiness to parse strings that include unicode Bitcoin symbols and denomination codes, padding of strings so that formatted amounts can uncurl virtually the decimal point, locale sensitivity for formatting, and more. Which API to use is up to you: they were unsalaried by two variegated contributors and we’re waiting to proceeds wits in which ones are most popular, with an eye to creating a unified API in future.