# platon-web3-utils

> Collection of utility functions used in web3.js.

Latest version **1.2.5** (published 2021-12-28) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install platon-web3-utils
pnpm add platon-web3-utils
yarn add platon-web3-utils
bun add platon-web3-utils
```

## Health

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

Positive: has types; no vulnerabilities; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2021-12-28 |
| First published | 2021-12-28 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 8 |
| Unpacked size | 135.7 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19908 |
| Maintainers | rileyge |

## Links

- npm: https://www.npmjs.com/package/platon-web3-utils
- Repository: https://github.com/ethereum/web3.js/tree/1.x/packages/web3-utils
- npm.io page: https://npm.io/package/platon-web3-utils

## Dependencies (8)

- [utf8](https://npm.io/package/utf8.md) 3.0.0
- [bn.js](https://npm.io/package/bn.js.md) 4.11.8
- [eth-lib](https://npm.io/package/eth-lib.md) 0.2.7
- [ethjs-unit](https://npm.io/package/ethjs-unit.md) 0.1.6
- [underscore](https://npm.io/package/underscore.md) 1.9.1
- [randombytes](https://npm.io/package/randombytes.md) ^2.1.0
- [number-to-bn](https://npm.io/package/number-to-bn.md) 1.7.0
- [ethereum-bloom-filters](https://npm.io/package/ethereum-bloom-filters.md) ^1.0.6

## Recent versions

- 1.2.5 (latest) — 2021-12-28
- 1.2.7-beta.0 (beta) — 2021-12-29
- 1.2.6 — 2021-12-28

## README

# web3-utils

This is a sub package of [web3.js][repo]

This contains useful utility functions for Dapp developers.  
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-utils
```

### In the Browser

Build running the following in the [web3.js][repo] repository:

```bash
npm run-script build-all
```

Then include `dist/web3-utils.js` in your html file.
This will expose the `Web3Utils` object on the window object.

## Usage

```js
// in node.js
var Web3Utils = require('web3-utils');
console.log(Web3Utils);
{
    sha3: function(){},
    soliditySha3: function(){},
    isAddress: function(){},
    ...
}
```

## Types

All the typescript typings are placed in the types folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

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