mirror of https://github.com/embarklabs/embark.git
3693ebd90d
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`).
|
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| .npmrc | ||
| CHANGELOG.md | ||
| README.md | ||
| index.js | ||
| package.json | ||
| tsconfig.json | ||
README.md
embark-snark
Snark plugin for Embark
Compiles circom circuits and generate solidity proofs in an Embark DApp.
Installation
In your embark dapp directory:
npm install embark-snark --save
Then add embark-snark to the plugins section in embark.json:
"plugins": {
"embark-snark": {
"circuits": ["app/circuits/**"],
"inputs": {
"multiplier": {
"a": 3,
"b": 11
}
}
}
}
You can defined where your circuits will be and what are the inputs.
Now you can create your first circuits, for example,
app/circuits/multiplier.circom:
template Multiplier() {
signal private input a;
signal private input b;
signal output c; c <== a*b;
}
component main = Multiplier();
Embark will now compile the circuits and generate a solidity contracts to verify the proof as well as deploy it.
Requirements
- Embark 5.0.0-alpha.0 or later
Visit framework.embarklabs.io to get started with Embark.