# confluxjs-unit

> A simple module for handling Conflux units (e.g. 'drip', 'cfx', etc...)

Latest version **0.0.4** (published 2019-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install confluxjs-unit
pnpm add confluxjs-unit
yarn add confluxjs-unit
bun add confluxjs-unit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2019-04-08 |
| First published | 2019-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.5.0 |
| Dependencies | 2 |
| Unpacked size | 427.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | conflux-dev |
| Keywords | conflux, encoding, decoding |

## Links

- npm: https://www.npmjs.com/package/confluxjs-unit
- Repository: https://github.com/Conflux-Chain/confluxjs-unit
- Homepage: https://github.com/Conflux-Chain/confluxjs-unit#readme
- Issues: https://github.com/Conflux-Chain/confluxjs-unit/issues
- npm.io page: https://npm.io/package/confluxjs-unit

## Dependencies (2)

- [bn.js](https://npm.io/package/bn.js.md) 4.11.6
- [number-to-bn](https://npm.io/package/number-to-bn.md) 1.7.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2019-04-08
- 0.0.3 — 2019-04-08
- 0.0.2 — 2019-04-08
- 0.0.1 — 2019-04-08

## README

## confluxjs-unit

A simple module for handling Conflux unit conversion. Forked and modified from [ethjs-unit](https://github.com/ethjs/ethjs-unit).

## Install

```
npm install --save confluxjs-unit
```

## Usage

```js
const unit = require('confluxjs-unit');

var val1 = unit.toDrip(249824778, 'cfx');

// result <BN ...> 249824778000000000000000000

var val2 = unit.fromDrip('249824778000000000000000000', 'cfx');

// result '249824778'
```

## About

A module that just handles the unit conversion between the various types of Conflux currency units.

Note, the `toDrip` returns a BN instance while `fromDrip` always returns a string number.

## Methods Available & Objects

```
unitMap         { unitName: singleUnitDripValue, ... }
getValueOfUnit  <Function (unit) : (BN)>
toDrip           <Function (value, unit) : (BN)>
fromDrip         <Function (value, unit) : (String)>
```

## Supported Units

```
'drip':          '1',
'gdrip':         '1000000000',
'Gdrip':         '1000000000',
'cfx':           '1000000000000000000',
```

## Contributing

Please help better the ecosystem by submitting issues and pull requests to default. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.

## Licence

This project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.

```
The MIT License

Copyright (c) 2016 Nick Dodson. nickdodson.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```

---
_Source: https://npm.io/package/confluxjs-unit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._