Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereumjs/ethereumjs-util
Project is in active development and has been moved to the EthereumJS monorepo.
https://github.com/ethereumjs/ethereumjs-util
address buffer ethereum ethereumjs hash hex javascript signature utilities utils
Last synced: 3 months ago
JSON representation
Project is in active development and has been moved to the EthereumJS monorepo.
- Host: GitHub
- URL: https://github.com/ethereumjs/ethereumjs-util
- Owner: ethereumjs
- License: mpl-2.0
- Archived: true
- Created: 2015-01-25T01:46:27.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-06-17T09:47:50.000Z (over 3 years ago)
- Last Synced: 2024-05-17T20:45:26.687Z (6 months ago)
- Topics: address, buffer, ethereum, ethereumjs, hash, hex, javascript, signature, utilities, utils
- Language: TypeScript
- Homepage: https://github.com/ethereumjs/ethereumjs-monorepo
- Size: 734 KB
- Stars: 602
- Watchers: 39
- Forks: 271
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-smart-contract-development - ethereumjs-util
README
# SYNOPSIS
[![NPM Status][npm-badge]][npm-link]
[![Actions Status][actions-badge]][actions-link]
[![Coverage Status][coverage-badge]][coverage-link]
[![Discord][discord-badge]][discord-link]
A collection of utility functions for Ethereum. It can be used in Node.js and in the browser with [browserify](http://browserify.org/).
# INSTALL
`npm install ethereumjs-util`
# USAGE
```js
import assert from 'assert'
import { isValidChecksumAddress, unpadBuffer, BN } from 'ethereumjs-util'
const address = '0x2F015C60E0be116B1f0CD534704Db9c92118FB6A'
assert.ok(isValidChecksumAddress(address))
assert.equal(unpadBuffer(Buffer.from('000000006600', 'hex')), Buffer.from('6600', 'hex'))
assert.equal(new BN('dead', 16).add(new BN('101010', 2)), 57047)
```
# API
## Documentation
### Modules
- [account](docs/modules/_account_.md)
- Account class
- Private/public key and address-related functionality (creation, validation, conversion)
- [address](docs/modules/_address_.md)
- Address class and type
- [bytes](docs/modules/_bytes_.md)
- Byte-related helper and conversion functions
- [constants](docs/modules/_constants_.md)
- Exposed constants
- e.g. KECCAK256_NULL_S for string representation of Keccak-256 hash of null
- [hash](docs/modules/_hash_.md)
- Hash functions
- [object](docs/modules/_object_.md)
- Helper function for creating a binary object (`DEPRECATED`)
- [signature](docs/modules/_signature_.md)
- Signing, signature validation, conversion, recovery
- [types](docs/modules/_types_.md)
- Helpful TypeScript types
- [externals](docs/modules/_externals_.md)
- Helper methods from `ethjs-util`
- Re-exports of `BN`, `rlp`
### ethjs-util methods
The following methods are available provided by [ethjs-util](https://github.com/ethjs/ethjs-util):
- arrayContainsArray
- toBuffer
- getBinarySize
- stripHexPrefix
- isHexPrefixed
- isHexString
- padToEven
- intToHex
- fromAscii
- fromUtf8
- toUtf8
- toAscii
- getKeys
They can be imported by name:
```js
import { intToHex, stripHexPrefix } from 'ethereumjs-util'
```
### Re-Exports
Additionally `ethereumjs-util` re-exports a few commonly-used libraries. These include:
- [BN.js](https://github.com/indutny/bn.js) (version `5.x`)
- [rlp](https://github.com/ethereumjs/rlp) (version `2.x`)
# EthereumJS
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices.
If you want to join for work or do improvements on the libraries have a look at our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html).
# LICENSE
MPL-2.0
[npm-badge]: https://img.shields.io/npm/v/ethereumjs-util.svg
[npm-link]: https://www.npmjs.org/package/ethereumjs-util
[actions-badge]: https://github.com/ethereumjs/ethereumjs-util/workflows/Build/badge.svg
[actions-link]: https://github.com/ethereumjs/ethereumjs-util/actions
[coverage-badge]: https://codecov.io/gh/ethereumjs/ethereumjs-util/branch/master/graph/badge.svg
[coverage-link]: https://codecov.io/gh/ethereumjs/ethereumjs-util
[discord-badge]: https://img.shields.io/static/v1?logo=discord&label=discord&message=Join&color=blue
[discord-link]: https://discord.gg/TNwARpR