@alayanetwork/ethjs-ens

    2.0.1 • Public • Published

    EthJS ENS

    CircleCI Coverage Status

    A convenience interface for using the Ethereum Name Service, based on the EthJS contract abstraction.

    Live Demo

    Installation

    Install from npm:

    npm install @alayanetwork/ethjs-ens --save

    Usage

    const ENS = require('@alayanetwork/ethjs-ens')
    const HttpProvider = require('ethjs-provider-http')
     
    // For MetaMask or Mist compatibility:
    if (typeof window === 'object' && typeof window.web3 !== 'undefined') {
      setupEns(web3.currentProvider)
    } else {
      const provider = new HttpProvider('https://ropsten.infura.io')
      setupEns(provider)
    }
     
    function setupEns (provider) {
     
      // Currently requires both provider and
      // either a network or registryAddress param
      const ens = new ENS({ provider, network: '3' })
     
      ens.lookup('vitalik.eth')
      .then((address) => {
        const expected = '0x5f8f68a0d1cbc75f6ef764a44619277092c32df0'
     
        if (address === expected) {
          alert("That's how you do it!")
        }
      })
      .catch((reason) => {
        // There was an issue!
        // Maybe the name wasn't registered!
        console.error(reason)
      })
    }

    Available APIs

    ens.lookup( name )

    Takes a valid ENS name, like vitalik.eth, or some.specialname.eth.

    Returns a Promise that resolves to a hex-prefixed hexadecimal string for the resolved address.

    If a matching name can not be found, will throw:

    new Error('ENS name not found.')

    ens.reverse( address )

    Takes an ethereum address (hex-encoded), and attempts to look up a corresponding name on the registry's reverse-registrar.

    Returns a promise that resolves a string if a name exists, or throws if it does not.

    ens.registry

    An ethjs contract instance initialized for the specified network's address.

    Implements the registry interface specified in EIP 137:

    function owner(bytes32 node) constant returns (address);
    Returns the owner (registrar) of the specified node.
    
    function resolver(bytes32 node) constant returns (address);
    Returns the resolver for the specified node.
    
    function ttl(bytes32 node) constant returns (uint64);
    

    Current Supported Networks

    Network support is added by adding a registry for that network to the network map.

    • Main net (id 1)
    • Ropsten (id 3)

    Licence

    This project is licensed under the MIT license, Copyright (c) 2016 Dan Finlay. For more information see LICENSE.md.

    The MIT License
    
    Copyright (c) 2017 Dan Finlay. danfinlay.com
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    

    Install

    npm i @alayanetwork/ethjs-ens

    DownloadsWeekly Downloads

    1

    Version

    2.0.1

    License

    ISC

    Unpacked Size

    1.1 MB

    Total Files

    18

    Last publish

    Collaborators

    • alayanetwork