embark/packages/plugins/nethermind
Michael Bradley, Jr 3693ebd90d fix: ensure that packages properly specify their dependencies
Many packages in the monorepo did not specify all of their dependencies; they
were effectively relying on resolution in the monorepo's root
`node_modules`. In a production release of `embark` and `embark[js]-*` packages
this can lead to broken packages.

To fix the problem currently and to help prevent it from happening again, make
use of the `eslint-plugin-import` package's `import/no-extraneous-dependencies`
and `import/no-unresolved` rules. In the root `tslint.json` set
`"no-implicit-dependencies": true`, wich is the tslint equivalent of
`import/no-extraneous-dependencies`; there is no tslint equivalent for
`import/no-unresolved`, but we will eventually replace tslint with an eslint
configuration that checks both `.js` and `.ts` files.

For `import/no-unresolved` to work in our monorepo setup, in most packages add
an `index.js` that has:

```js
module.exports = require('./dist'); // or './dist/lib' in some cases
```

And point `"main"` in `package.json` to `"./index.js"`. Despite what's
indicated in npm's documentation for `package.json`, it's also necessary to add
`"index.js"` to the `"files"` array.

Make sure that all `.js` files that can and should be linted are in fact
linted. For example, files in `packages/embark/src/cmd/` weren't being linted
and many test suites weren't being linted.

Bump all relevant packages to `eslint@6.8.0`.

Fix all linter errors that arose after these changes.

Implement a `check-yarn-lock` script that's run as part of `"ci:full"` and
`"qa:full"`, and can manually be invoked via `yarn cylock` in the root of the
monorepo. The script exits with error if any specifiers are found in
`yarn.lock` for `embark[js][-*]` and/or `@embarklabs/*` (with a few exceptions,
cf. `scripts/check-yarn-lock.js`).
2020-02-25 14:52:10 -06:00
..
src feat(@embark/nethermind): add Nethermind blockchain client plugin 2020-01-16 10:15:18 -05:00
.npmrc feat(@embark/nethermind): add Nethermind blockchain client plugin 2020-01-16 10:15:18 -05:00
CHANGELOG.md chore(release): 5.2.2 2020-02-18 19:06:59 -06:00
README.md chore: update site urls 2020-01-28 12:07:17 -05:00
index.js fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
package.json fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00
tsconfig.json fix: ensure that packages properly specify their dependencies 2020-02-25 14:52:10 -06:00

README.md

embark-nethermind

Nethermind blockchain client plugin for Embark

Quick docs

To configure the Netherminds client, you can use the Embark configs as always, or for more control, use the Nethermind config files. To change them, go in your Netherminds directory, then in configs/. There, you will see all the configuration files for the different networks. If you ever need to run a different network than dev, testnet or mainnet, you can change it in the Embark blockchain configuration by changing the networkType to the name of the config file, without the .cfg. Eg: For the Goerli network, just put networkType: 'goerli Note: The dev mode of Netherminds is called ndm and the config file is ndm_consumer_local.cfg. Using miningMode: 'dev' automatically translates to using that config file.

Websocket support

Even though Nethermind supports Websocket connections, it does not support eth_subscribe, so you will not be able to use contract events. Also, please note that you will need to change the endpoint in the blockchain configuration to ws://localhost:8545/ws/json-rpc when working in local. Do change the port or the host to whatever you need.

Visit framework.embarklabs.io to get started with Embark.