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-ens
Implements ENS support in Embark
This module:
- registers console commands to interact with ENS
- deploys & setups ENS contracts depending on the network
- implements ENS support in EmbarkJS
- setups generated code acording to the config
API
command: ens:resolve - returns the address of an ens name
arguments:
name- ens name to resolve
response:
error- if an error occurs, null otherwiseaddress- address associated to the ensnamegiven
command: ens:isENSName - checks is it's a (valid) ENS name
arguments:
name- ens name to validate
response:
error- if an error occurs, null otherwiseresult- true/false depending ifnamegiven is a valid ens name
command: storage:ens:associate - associates an hash to an ENS domain
arguments:
optionsname- ens namestorageHash- hash to associate
response:
error- if an error occurs, null otherwise
Web API
endpoint: GET /embark-api/ens/resolve - returns the address of an ens name
arguments:
name- ens name to resolve
response:
{
address: <address of ens name>
}
endpoint: GET /embark-api/ens/lookup - returns the ens name of an address
arguments:
address- address to query
response:
{
name: <ens name of address>
}
endpoint: POST /embark-api/ens/register registers a domain or subdomain
arguments:
subdomain- ens domainaddress- address to associate
response:
{
name: <ens name>
address: <address>
}
Dependencies
- async
- eth-ens-namehash
- embarkjs.utils
- secureSend
- embark utils
- AddressUtils
- hashTo32ByteHexString
- recursiveMerge