@appliedblockchain/bdash
v0.2.1
Published
Bdash – Utility library for DApps
Downloads
7
Maintainers
Readme
Table of Contents
Library
Bdash is a collection of utility functions missing from lodash (javascript's most loved utility library) for decentralised applications (DApps). Bdash is meant to used alongside libraries like lodash in your apps/libraries.
Requirements
Node
The app requires Node.js and npm (npm comes prebundled with node). The source code is written in ES2015 so Node.js V6+ is recommended. Node.js version can be checked using the node -v
cli command.
Browser Support
| Chrome | Safari | IE* / Edge | Firefox | Opera | | ------ | ------ | ---------- | ------- | ----- | | Yes | Yes | 9+ | Yes | Yes |
Installation
This module is distributed via npm which is bundled
with node and should be installed as one of your
project's dependencies
Using npm
> npm install --save @appliedblockchain/bdash
Using yarn
> yarn add @appliedblockchain/bdash
Documentation
checksumAddress()
Convert a address to a checksum address.
Arguments
| Argument | Type | Default | Optional |
|:--------:|----------|---------|----------|
| address | string
| – | No |
Returns
(string)
: Retuns checksummed address.
Example
import { checksumAddress } from '@appliedblockchain/bdash'
checksumAddress('0xa15fa373a93f40696b7ec9231411a862529318a7')
// -> 0xa15fa373a93f40696B7eC9231411a862529318A7
isAddress()
Check if given a value is a valid wallet address.
Arguments
| Argument | Type | Default | Optional |
|:--------:|--------|---------|----------|
| value | *
| – | No |
Returns
(boolean)
: Returns true
if value is a valid ethereum address else false
.
Example
import { isAddress } from '@appliedblockchain/bdash'
isAddress('0xa15fa373a93f40696b7ec9231411a862529318a7')
// -> true
isAddress('0xa15fa373a93f4069')
// -> false
isChecksumAddress()
Checks if given value is a checksummed ethereum address.
Arguments
| Argument | Type | Default | Optional |
|:--------:|--------|---------|----------|
| value | *
| – | No |
Returns
(boolean)
: Returns true
if value is a valid checksummed ethereum address else false
.
Example
import { isAddress } from '@appliedblockchain/bdash'
isChecksumAddress('0xa15fa373a93f40696B7eC9231411a862529318A7')
// -> true
isChecksumAddress('0xa15fa373a93f40696b7ec9231411a862529318a7')
// -> false
isHex()
Checks if given value is a hexidecimal string.
Arguments
| Argument | Type | Default | Optional |
|:--------:|--------|---------|----------|
| value | *
| – | No |
Returns
(boolean)
: Returns true
if value is a hexidecimal string else false
.
Example
import { isHex } from '@appliedblockchain/bdash'
isHex('0xa15f')
// -> true
isHex('a15f')
// -> true
isHex('a15')
// -> false
isPrefixedHex()
Checks if given value is a hexidecimal string that is prefixed (0x).
Arguments
| Argument | Type | Default | Optional |
|:--------:|--------|---------|----------|
| value | *
| – | No |
Returns
(boolean)
: Returns true
if value is a prefixed hexidecimal string else false
.
Example
import { isPrefixedHex } from '@appliedblockchain/bdash'
isPrefixedHex('0xa15f')
// -> true
isPrefixedHex('a15f')
// -> false
isUnprefixedHex()
Checks if given value is a hexidecimal string that is not prefixed (0x).
Arguments
| Argument | Type | Default | Optional |
|:--------:|--------|---------|----------|
| value | *
| – | No |
Returns
(boolean)
: Returns true
if value is a unprefixed hexidecimal string else false
.
Example
import { isUnprefixedHex } from '@appliedblockchain/bdash'
isUnprefixedHex('0xa15f')
// -> false
isUnprefixedHex('a15f')
// -> true
prefixHex()
Prefix a hexidecimal string.
Arguments
| Argument | Type | Default | Optional |
|:--------:|----------|---------|----------|
| hex | string
| – | No |
Returns
(string)
: Returns prefixed hexidecimal string.
Example
import { prefixHex } from '@appliedblockchain/bdash'
prefixHex('a15f')
// -> 0xa15f
unprefixHex()
Unprefix a hexidecimal string.
Arguments
| Argument | Type | Default | Optional |
|:--------:|----------|---------|----------|
| hex | string
| – | No |
Returns
(string)
: Returns unprefixed hexidecimal string.
Example
import { unprefixHex } from '@appliedblockchain/bdash'
unprefixHex('0xa15f')
// -> a15f
Contributors
License
MIT