You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
60 lines
1.7 KiB
60 lines
1.7 KiB
10 years ago
|
# Unit
|
||
|
|
|
||
|
|
Unit it's a utility for handling and converting bitcoins units. We strongly
|
||
|
|
recommend you to always use satoshis to represent amount inside your application
|
||
|
|
and only convert them to other units in the front-end.
|
||
|
|
|
||
|
|
The supported units are BTC, mBTC, bits and satoshis. The codes for each unit
|
||
|
|
can be found as members of the Unit class.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var btcCode = Unit.BTC;
|
||
|
|
var mbtcCode = Unit.mBTC;
|
||
|
|
var bitsCode = Unit.bits;
|
||
|
|
var satsCode = Unit.satoshis;
|
||
|
|
```
|
||
|
|
|
||
|
|
There are two ways for creating a unit instance. You can instanciate the class
|
||
|
|
using a value and a unit code; alternatively if the unit it's fixed you could
|
||
|
|
you some of the static methods. Check some examples below:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var unit;
|
||
|
|
var amount = 100;
|
||
|
|
|
||
|
|
// using a unit code
|
||
|
|
var unitPreference = Unit.BTC;
|
||
|
|
unit = new Unit(amount, unitPreference);
|
||
|
|
|
||
|
|
// using a known unit
|
||
|
|
unit = Unit.fromBTC(amount);
|
||
|
|
unit = Unit.fromMilis(amount);
|
||
|
|
unit = Unit.fromBits(amount);
|
||
|
|
unit = Unit.fromSatoshis(amount);
|
||
|
|
```
|
||
|
|
|
||
|
|
Once you have a unit instance, you can check it's representantion in all the
|
||
|
|
available units. For your convinience the classes expose three ways to acomplish
|
||
|
|
this. Using the `.to(unitCode)` method, using a fixed unit like `.toSatoshis()`
|
||
|
|
or by using the accessors.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var unit;
|
||
|
|
|
||
|
|
// using a unit code
|
||
|
|
var unitPreference = Unit.BTC;
|
||
|
|
value = Unit.fromSatoshis(amount).to(unitPreference);
|
||
|
|
|
||
|
|
// using a known unit
|
||
|
|
value = Unit.fromBTC(amount).toBTC();
|
||
|
|
value = Unit.fromBTC(amount).toMilis();
|
||
|
|
value = Unit.fromBTC(amount).toBits();
|
||
|
|
value = Unit.fromBTC(amount).toSatoshis();
|
||
|
|
|
||
|
|
// using accessors
|
||
|
|
value = Unit.fromBTC(amount).BTC;
|
||
|
|
value = Unit.fromBTC(amount).mBTC;
|
||
|
|
value = Unit.fromBTC(amount).bits;
|
||
|
|
value = Unit.fromBTC(amount).satoshis;
|
||
|
|
```
|