# truffle-privatekey-provider

> Private Key Web3 provider

Latest version **1.5.0** (published 2020-09-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install truffle-privatekey-provider
pnpm add truffle-privatekey-provider
yarn add truffle-privatekey-provider
bun add truffle-privatekey-provider
```

## Health

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

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2020-09-02 |
| First published | 2018-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/truffle-privatekey-provider) |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 47 |
| Author | Alex Popov |
| Maintainers | nosuchip |
| Keywords | ethereum, private key, wallet, provider, truffle provider |

## Links

- npm: https://www.npmjs.com/package/truffle-privatekey-provider
- Repository: https://github.com/nosuchip/truffle-privatekey-provider
- Homepage: https://github.com/nosuchip/truffle-privatekey-provider#readme
- Issues: https://github.com/nosuchip/truffle-privatekey-provider/issues
- npm.io page: https://npm.io/package/truffle-privatekey-provider

## Dependencies (2)

- [ethereumjs-wallet](https://npm.io/package/ethereumjs-wallet.md) ^1.0.0
- [web3-provider-engine](https://npm.io/package/web3-provider-engine.md) ^15.0.12

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2020-09-02
- 1.4.0 — 2020-09-02
- 1.3.0 — 2019-06-21
- 1.2.0 — 2019-06-20
- 1.1.0 — 2019-02-09
- 1.0.0 — 2018-11-20
- 0.1.0 — 2018-05-24
- 0.0.6 — 2018-03-30
- 0.0.5 — 2018-02-13
- 0.0.4 — 2018-01-11
- 0.0.3 — 2018-01-11
- 0.0.2 — 2018-01-11
- 0.0.1 — 2018-01-11

## README

[![NPM](https://nodei.co/npm/truffle-privatekey-provider.png)](https://nodei.co/npm/truffle-privatekey-provider)

# truffle-privatekey-provider
Private Key provider for Web3. Used to sign transactions by provider private key

## Install

```
$ npm install truffle-privatekey-provider
```

# Usage
Provider can be used either with Web3 only or in Truffle infrastructure


## Web3 Usage


```javascript
var PrivateKeyProvider = require("truffle-privatekey-provider");
var privateKey = "62537136911bca3a7e2b....";
var provider = new PrivateKeyProvider(privateKey, "http://localhost:8545");

```

Parameters:

- `privateKey`: `string`. private key for account that would be used to sign transactions.
- `providerUri`: `string`. URI of Ethereum client to send Web3 requests.

## Truffle Usage


truffle.js
```javascript
var PrivateKeyProvider = require("truffle-privatekey-provider");

var privateKey = "62537136911bca3a7e2b....";

module.exports = {
  networks: {
    rinkeby: {
      provider: () => new PrivateKeyProvider(privateKey, "https://rinkeby.infura.io/"),
      network_id: 4
    },
    ....
  }
};
```

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