Package Exports

ethereumjs-util
ethereumjs-util/dist/account
ethereumjs-util/dist/account.js
ethereumjs-util/dist/bytes
ethereumjs-util/dist/bytes.js
ethereumjs-util/dist/hash
ethereumjs-util/dist/hash.js
ethereumjs-util/dist/object
ethereumjs-util/dist/object.js
ethereumjs-util/dist/signature
ethereumjs-util/dist/signature.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ethereumjs-util) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SYNOPSIS

A collection of utility functions for Ethereum. It can be used in Node.js and in the browser with browserify.

INSTALL

npm install ethereumjs-util

USAGE

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
- Account class
- Private/public key and address-related functionality (creation, validation, conversion)
address
- Address class and type
bytes
- Byte-related helper and conversion functions
constants
- Exposed constants
  - e.g. KECCAK256_NULL_S for string representation of Keccak-256 hash of null
hash
- Hash functions
object
- Helper function for creating a binary object (DEPRECATED)
signature
- Signing, signature validation, conversion, recovery
types
- Helpful TypeScript types
externals
- Helper methods from ethjs-util
- Re-exports of BN, rlp

Also see API docs.

ethjs-util methods

The following methods are available by an internalized version of the ethjs-util package (MIT license), see internal.ts. The original package is not maintained any more and the original functionality will be replaced by own implementations over time (starting with the v7.1.3 release, October 2021).

arrayContainsArray
getBinarySize
stripHexPrefix
isHexPrefixed
isHexString
padToEven
fromAscii
fromUtf8
toUtf8
toAscii
getKeys

They can be imported by name:

import { stripHexPrefix } from 'ethereumjs-util'

Re-Exports

ethereumjs-util re-exports the following commonly-used libraries:

BN.js (version 5.x)
rlp (version 2.x)

EthereumJS

See our organizational documentation 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.

LICENSE

MPL-2.0