embarklabs/embark
2
0
Fork 0
mirror of https://github.com/embarklabs/embark.git synced 2025-02-17 08:07:51 +00:00
Code Issues Projects Releases Wiki Activity
embark/packages/plugins/ens
History
Michael Bradley, Jr 9f2a5949c2 build: specify missing test action in relevant package.json "qa" scripts 
It's a relevant `package.json` if the package has a test suite. If `test` isn't
specified then the tests won't run in CI (they have't been running).

Include a fix for one failing test in `packages/plugins/ens` and two failing
test in `packages/stack/deployment`. In all three cases, the mock embark
object's config needed a `blockchainConfig` section with `{ enabled: true }`.
2019-12-11 14:01:12 -06:00
..
src
fix(@cockpit/ens): ensure default account is set when registering subdomains
2019-12-11 11:30:58 -05:00
test
build: specify missing test action in relevant package.json "qa" scripts
2019-12-11 14:01:12 -06:00
.npmrc
move embarkjs packages & remove embark- prefix from some folders (#1879)
2019-09-06 18:26:08 -04:00
CHANGELOG.md
chore(release): 5.0.0-alpha.3
2019-12-06 06:15:07 -05:00
package.json
build: specify missing test action in relevant package.json "qa" scripts
2019-12-11 14:01:12 -06:00
README.md
build: tidy up the monorepo in prep for v5.0.0-alpha.0
2019-10-01 13:29:53 -05:00

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 otherwise
  • address - address associated to the ens name given

command: ens:isENSName - checks is it's a (valid) ENS name

arguments:

  • name - ens name to validate

response:

  • error - if an error occurs, null otherwise
  • result - true/false depending if name given is a valid ens name

command: storage:ens:associate - associates an hash to an ENS domain

arguments:

  • options
    • name - ens name
    • storageHash - 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 domain
  • address - address to associate

response:

{
  name: <ens name>
  address: <address>
}

Dependencies

  • async
  • eth-ens-namehash
  • embarkjs.utils
    • secureSend
  • embark utils
    • AddressUtils
    • hashTo32ByteHexString
    • recursiveMerge