Package Exports

embark-ens

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (embark-ens) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`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