1.1.1 • Published 3 years ago

wei-caculate v1.1.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

wei-caculate

Quick Start

Installation package

npm i wei-caculate -S

Just export the function directly from the library and use it

import { valueToWei } from 'wei-caculate'

const wei = valueToWei(1, 18)

consle.log(wei) // 1000000000000000000

Parameter Analysis

Since most project-based tools for blockchain calculations involve precision-related calculations, they all default to discarding the remainder all together after the exact bit, rather than rounding up

ParametersTypeDefault ValueExplanation
argnumber | string | Bignumber/Pass in a custom target value
decimalsnumber/Enter the precision to be offset
fixednumber4The final result is accurate to the number of decimal places, and if there are not enough places, the actual value will prevail.

Method

valueToWei

Function Definition

fn: ( 
    arg: number | string | Bignumber,
    decimals: number
    fixed?: number
) => string

Example

import { valueToWei } from 'wei-caculate'

const wei = valueToWei(1, 18)
const wei2 = valueToWei(52.4651516516456, 6)

consle.log(wei) // 1000000000000000000
consle.log(wei2) // 52465151.6516

valueFromWei

Function Definition

fn: ( 
    arg: number | string | Bignumber,
    decimals: number
    fixed?: number
) => string

Example

import { valueFromWei } from 'wei-caculate'

const val = valueFromWei(1000000000000000000, 18)
const val2 = valueFromWei(52465151.6516, 6)

consle.log(val) // 1
consle.log(val) // 52.4651516516456

weiAdd

Function Definition

fn: ( 
    arg1: number | string | Bignumber,
    arg2: number | string | Bignumber,
    fixed?: number
) => string

Example

import { weiAdd } from 'wei-caculate'

const val = weiAdd(100, "1")

consle.log(val) // 101

weiSub

Function Definition

fn: ( 
    arg1: number | string | Bignumber,
    arg2: number | string | Bignumber,
    fixed?: number
) => string

Example

import { weiSub } from 'wei-caculate'

const val = weiSub(100, "1")

consle.log(val) // 99

weiMul

Function Definition

fn: ( 
    arg1: number | string | Bignumber,
    arg2: number | string | Bignumber,
    fixed?: number
) => string

Example

import { weiMul } from 'wei-caculate'

const val = weiMul(0.6, "3")

consle.log(0.6 * 3) // 1.7999999999999998
consle.log(val) // 1.8

weiDiv

Function Definition

fn: ( 
    arg1: number | string | Bignumber,
    arg2: number | string | Bignumber,
    fixed?: number
) => string

Example

import { weiDiv } from 'wei-caculate'

const val = weiDiv(99, "33")

consle.log(val) // 3

1.1.1

3 years ago

1.1.0

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago