baby636 / satoshi-bitcoin

Convert precisely between Satoshi and Bitcoin

satoshi-bitcoin

npm module to convert between Satoshi and Bitcoin with lightweight precision.

The Problem

Install

npm install --save satoshi-bitcoin

Usage

Node.js

var sb = require('satoshi-bitcoin');

sb.toSatoshi(1);
//=>100000000

sb.toBitcoin(100000000);
//=>1

Web

<script src="https://rawgit.com/dawsonbotsford/satoshi-bitcoin/master/index.bundle.js"></script>
<script>
  console.log('One Satoshi equals ' + sb.toBitcoin(1) + ' Bitcoin');
</script>

Or download it with npm install --save satoshi-bitcoin and reference it as:

<script src="node_modules/satoshi-bitcoin/index.bundle.js"></script>

Error Handling

try {
  sb.toSatoshi(false)); //Throws TypeError
} catch (err) {
  console.log(err);
}

API

sb.toSatoshi(number || string)
sb.toBitcoin(number || string)

Read more on the Wiki

FAQ

• What is a Satoshi?

  • Satoshi is to Bitcoin as pennies are to the dollar. Except that there are 100,000,000 Satoshi in one Bitcoin.

• Why do I need a module when I can just divide or multiply by 100,000,000?

  • See here - Floating point errors are a bitch. So satoshi-bitcoin uses a bignum library to ensure accurate conversions!

Tests

npm test

License

MIT © Dawson Botsford