# authereum

> Authereum library

Latest version **0.1.14** (published 2021-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install authereum
pnpm add authereum
yarn add authereum
bun add authereum
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.14 |
| Published | 2021-02-02 |
| First published | 2019-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | miguelmota, cwhinfrey, shanefontaine |

## Links

- npm: https://www.npmjs.com/package/authereum
- npm.io page: https://npm.io/package/authereum

## Dependencies (14)

- [pify](https://npm.io/package/pify.md) 4.0.1
- [async](https://npm.io/package/async.md) 3.2.0
- [bn.js](https://npm.io/package/bn.js.md) 5.1.2
- [store](https://npm.io/package/store.md) 2.0.12
- [ethers](https://npm.io/package/ethers.md) 4.0.47
- [penpal](https://npm.io/package/penpal.md) 4.1.1
- [to-hex](https://npm.io/package/to-hex.md) 0.0.11
- [uuidv4](https://npm.io/package/uuidv4.md) 6.0.6
- [is-buffer](https://npm.io/package/is-buffer.md) 2.0.4
- [web3-utils](https://npm.io/package/web3-utils.md) 1.2.1
- [querystring](https://npm.io/package/querystring.md) 0.2.0
- [eventemitter3](https://npm.io/package/eventemitter3.md) 4.0.0
- [web3-provider-engine](https://npm.io/package/web3-provider-engine.md) 15.0.4
- [ethereum-private-key-to-address](https://npm.io/package/ethereum-private-key-to-address.md) 0.0.3

## Recent versions

- 0.1.14 (latest) — 2021-02-02
- 0.1.13 — 2021-01-16
- 0.1.12 — 2020-11-30
- 0.1.11 — 2020-11-26
- 0.1.10 — 2020-11-25
- 0.1.9 — 2020-11-24
- 0.1.8 — 2020-11-20
- 0.1.7 — 2020-11-20
- 0.1.6 — 2020-11-11
- 0.1.5 — 2020-11-04
- 0.1.4 — 2020-11-03
- 0.1.3 — 2020-11-02
- 0.1.2 — 2020-10-29
- 0.1.1 — 2020-10-28
- 0.1.0 — 2020-10-06
- … 286 more at https://npm.io/package/authereum/versions

## README

# authereum

> The [Authereum](https://authereum.com) library

[![Documentation](https://img.shields.io/badge/documentation-available-green.svg?style=flat)](https://docs.authereum.com/)
[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/@authereum/authereum/master/LICENSE)
[![dependencies Status](https://david-dm.org/@authereum/authereum/status.svg)](https://david-dm.org/@authereum/authereum)
[![NPM version](https://badge.fury.io/js/authereum.svg)](http://badge.fury.io/js/authereum)

## Install

```bash
npm install authereum
```

## Getting started

Initializing SDK:

```js
import Authereum from 'authereum'

const authereum = new Authereum(/* options */)

authereum.login()
```

Getting web3 provider:

```js
import Web3 from 'web3'
import Authereum from 'authereum'

const authereum = new Authereum(/* options */)
const provider = authereum.getProvider()
const web3 = new Web3(provider)
```

Using Ethers.js Signer:

```js
import { AuthereumSigner } from 'authereum'

const signer = new AuthereumSigner(/* options */)

const tx = {
  gasPrice: '0x2540be400',
  gasLimit: '0x186a0',
  to: '0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1',
  value: '0x00',
  data: '0x',
}

const result = await signer.sendTransaction(tx)
console.log(result.hash)
```

Options:

- `mainnet`, `kovan`, `rinkeby`, `ropsten`, `goerli`


### CDN


[https://cdn.jsdelivr.net/npm/authereum@latest/authereum.js](jsDelivr CDN)


```html
<script src="https://cdn.jsdelivr.net/npm/authereum@latest/authereum.js"></script>
```

[https://unpkg.com/authereum@latest/authereum.js](unpkg CDN)

```html
<script src="https://unpkg.com/authereum@latest/authereum.js"></script>
```


## Full Documentation

Full documentation is available on our [docs page](https://docs.authereum.com/).


## Development

Watch and build:

```bash
npm run dev
```

Build:

```bash
npm run build
```

Lint:

```bash
npm run lint
```

## Test

```bash
npm test
```

## License

[MIT](LICENSE)

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