satoshi-bitcoin

KO | EN

gitlite — search

#javascript #ai #typescript #llm #go #golang #android #rust #deep-learning #macos #kubernetes #vue #security #pytorch

satoshi-bitcoin

(★ 42)

Convert precisely between Satoshi and Bitcoin

satoshi-bitcoin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# satoshi-bitcoin

[![bundle size](https://img.shields.io/bundlejs/size/satoshi-bitcoin)](https://bundlejs.com/?q=satoshi-bitcoin)
[![npm version](https://badge.fury.io/js/satoshi-bitcoin.svg)](https://badge.fury.io/js/satoshi-bitcoin)

[![node 8](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-8.yml/badge.svg)](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-8.yml)
[![node 12](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-12.yml/badge.svg)](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-12.yml)
[![node 16](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-16.yml/badge.svg)](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-16.yml)
[![node latest](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-latest.yml/badge.svg)](https://github.com/dawsbot/satoshi-bitcoin/actions/workflows/node-latest.yml)

> npm module to convert between Satoshi and Bitcoin <b>with lightweight precision</b>.

<br>

## The Problem

![The problem](https://i.imgur.com/H1Ck3bF.png)

<br>

## Install

```bash
npm install --save satoshi-bitcoin

# OR

yarn add satoshi-bitcoin
```

<br>

## Usage

#### Node.js

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

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

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

<br>

#### Web

```html

<script src="https://cdn.jsdelivr.net/npm/satoshi-bitcoin/index.bundle.js"></script>
<script>
  console.log("One Satoshi equals " + sb.toBitcoin(1) + " Bitcoin");
</script>
```

<br>

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

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

<br>

### Error Handling

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

<br>

## API

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

TypeScript definitions are included — both functions accept a `number` or `string` and return a `number`.

<br>

## 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](https://repl.it/zlF/4) - Floating point errors are a problem. So `satoshi-bitcoin` uses a tiny bignum library (big.js) to ensure accurate conversions!

<br>

## Tests

```bash
npm test
```

<br>

## License

satoshi-bitcoin

satoshi-bitcoin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

satoshi-bitcoin

satoshi-bitcoin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README