dawsbot / 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

# OR

yarn add satoshi-bitcoin

Usage

Node.js

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

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

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

Web

<!-- package injected as "sb" -->
<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 problem. So satoshi-bitcoin uses a tiny bignum library (big.js) to ensure accurate conversions!

Tests

npm test

License

MIT © Dawson Botsford

satoshi-bitcoin's Issues

Provide motivation

• Move FAQ higher up in README
• Show before and after library usage (to emphasize floating point errors)

Rounding Error

Possible Solutions:

• https://github.com/guipn/sinful.js/blob/master/sinful.js
• https://www.npmjs.com/package/big.js

fix problem

4.6*100000000
"459999999.99999994"
(4.6*100000000).toFixed()
"460000000"

Bring eslint into repo

• Move .eslint into repo
• Remove link from readme to eslint
• Add linting tests to test suite

Support for millisats

Any plans on working on it?

Refactor README ordering

Per this tutorial

• Add donate badge
• Make gif