# @eth-optimism/ovm-truffle-provider-wrapper

> Optimism Truffle Provider Wrapper

Latest version **0.0.1-alpha.27** (published 2020-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eth-optimism/ovm-truffle-provider-wrapper
pnpm add @eth-optimism/ovm-truffle-provider-wrapper
yarn add @eth-optimism/ovm-truffle-provider-wrapper
bun add @eth-optimism/ovm-truffle-provider-wrapper
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.27 |
| Published | 2020-07-03 |
| First published | 2020-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6491 |
| Author | Optimism PBC |
| Maintainers | ben-chain, k-ho, karlfloersch, masonforest, will_optimism |
| Keywords | optimism, rollup, optimistic, ethereum, client |

## Links

- npm: https://www.npmjs.com/package/@eth-optimism/ovm-truffle-provider-wrapper
- Repository: https://github.com/ethereum-optimism/optimism-monorepo
- Homepage: https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages/ovm-truffle-provider-wrapper#readme
- Issues: https://github.com/ethereum-optimism/optimism-monorepo/issues
- npm.io page: https://npm.io/package/@eth-optimism/ovm-truffle-provider-wrapper

## Dependencies (1)

- [@eth-optimism/rollup-full-node](https://npm.io/package/@eth-optimism/rollup-full-node.md) ^0.0.1-alpha.28

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.0.1-alpha.27 (latest) — 2020-07-03
- 0.0.1-alpha.23 (alpha) — 2020-03-18
- 0.0.1-alpha.26 — 2020-07-03
- 0.0.1-alpha.25 — 2020-04-18
- 0.0.1-alpha.24 — 2020-03-20
- 0.0.1-alpha.21 — 2020-03-13
- 0.0.1-alpha.20 — 2020-03-12
- 0.0.1-alpha.19 — 2020-03-12
- 0.0.1-alpha.18 — 2020-03-11
- 0.0.1-alpha.17 — 2020-03-10
- 0.0.1-alpha.16 — 2020-03-10
- 0.0.1-alpha.15 — 2020-03-09
- 0.0.1-alpha.14 — 2020-03-05
- 0.0.1-alpha.13 — 2020-03-05
- 0.0.1-alpha.12 — 2020-02-26
- … 3 more at https://npm.io/package/@eth-optimism/ovm-truffle-provider-wrapper/versions

## README

# OVM Truffle Provider Wrapper
The OVM uses a specific `chainId`, which Truffle, at the moment, does not allow to be configured globally within a project, so this package simply wraps the provider that is used in order to set the `chainId` field on all transactions.

## Configuration
ChainId defaults to 108 but is configurable by setting the `OVM_CHAIN_ID` environment variable.
Note: you will also need to include `@eth-optimism/rollup-full-node` as a dependency if you would like to run a full node locally (or use ``ProviderWrapper.wrapProviderAndStartLocalNode(...)``).

## Example Usage in truffle-config.js:
```$javascript
const HDWalletProvider = require('truffle-hdwallet-provider');
const ProviderWrapper = require("@eth-optimism/ovm-truffle-provider-wrapper");
const mnemonic = 'candy maple cake sugar pudding cream honey rich smooth crumble sweet treat';

module.exports = {
  networks: {
    test: {
      provider: function () {
        return ProviderWrapper.wrapProviderAndStartLocalNode(new HDWalletProvider(mnemonic, "http://127.0.0.1:8545/", 0, 10));
      },
    },
    live_example: {
      provider: function () {
        return ProviderWrapper.wrapProvider(new HDWalletProvider(mnemonic, "http://127.0.0.1:8545/", 0, 10));
      },
    },
  },
  compilers: {
    solc: {
      // Add path to the solc-transpiler
      version: "../../node_modules/@eth-optimism/solc-transpiler",
    }
  }
}
```

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