# Ethereum Utility package

<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![NPM @latest][npm-shield]][npm-url]
[![NPM @next][npm-next-shield]][npm-next-url]

# Description

A package which facilitates use of Ethereum addresses, signatures and standards with Frequency chain.

<!-- GETTING STARTED -->

## Getting Started

- `npm install @frequency-chain/ethereum-utils`

### Usage in browser

Simply include the library in your HTML from [jsDelivr](https://www.jsdelivr.com/package/npm/@frequency-chain/ethereum-utils) (update the version as needed):

```html
<script src="https://cdn.jsdelivr.net/npm/@frequency-chain/ethereum-utils@0.0.1/dist/browser/frequency-ethereum-utils.umd.min.js"></script>
```

## Upgrades and Matching Versions

Assuming you are using no deprecated methods, any release version of `@frequency-chain/ethereum-utils` should work against a release version of a Frequency node.
If you are working against a development node it is suggested that you match the package version against the commit hash using `v0.0.0-[First 6 of the commit hash]`.

Changelog is maintained in the [releases for Frequency](https://github.com/frequency-chain/frequency/releases).


<!-- CONTRIBUTING -->

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

<!-- LICENSE -->

## License

Distributed under the Apache 2.0 License. See `LICENSE` for more information.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/frequency-chain/frequency.svg?style=for-the-badge
[contributors-url]: https://github.com/frequency-chain/frequency/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/frequency-chain/frequency.svg?style=for-the-badge
[forks-url]: https://github.com/frequency-chain/frequency/network/members
[stars-shield]: https://img.shields.io/github/stars/frequency-chain/frequency.svg?style=for-the-badge
[stars-url]: https://github.com/frequency-chain/frequency/stargazers
[issues-shield]: https://img.shields.io/github/issues/frequency-chain/frequency.svg?style=for-the-badge
[issues-url]: https://github.com/frequency-chain/frequency/issues
[license-shield]: https://img.shields.io/github/license/frequency-chain/frequency.svg?style=for-the-badge
[license-url]: https://github.com/frequency-chain/frequency/blob/master/LICENSE
[npm-shield]: https://img.shields.io/npm/v/@frequency-chain/ethereum-utils?label=npm%20%40latest&style=for-the-badge
[npm-url]: https://www.npmjs.com/package/@frequency-chain/ethereum-utils
[npm-next-shield]: https://img.shields.io/npm/v/@frequency-chain/ethereum-utils/next?label=npm%20%40next&style=for-the-badge
[npm-next-url]: https://www.npmjs.com/package/@frequency-chain/ethereum-utils