.ETH Registrar ENS

This package is a work in progress. Breaking changes are likely to be made.

Todo:

Create submitBid() method to combine shaBid() and newBid()
- shaBid() and newBid() don't need to be exposed once that's done.
Add fast forwarding on TestRPC
Add more tests for getEntry to check bid and reveal status within the auction period
Setup linting for the AirBnB js style guide
Create openAuction() which would automatically run startAuctions() with 9 random dummy bids alongside the one you actually wanted.
Create a bid object constructor to simplify bid management, the bid object contains at least
- name, hash, bid value, owner address, secret, and date submitted. Possibly also:
- reveal period start time, registration date.
Possibly connect submitBid() to openAuction(), and run if the auction is not already open before submitting.
Create a deed object constructor. The deed object contains all properties of a Deed contract, as well as the unhashed name (if known).
Anticipate and return errors for any inputs that would cause the contract to throw.

Overview

Registrar

Constructs a new Registrar instance, providing an easy-to-use interface to the Initial Registrar, which governs the .eth namespace. Either Registrar.init(), or registrar.initDefault() must be called

Example usage:

var Registrar = require('eth-registrar-ens');
var Web3 = require('web3');

var web3 = new Web3();
var registrar = new Registrar(web3)
 
// On Ropsten with the public ENS registry
registrar.init();
console.log(registrar.ens.registry.address);   // '0x112234455c3a32fd11230c42e7bccd4a84e02010'
console.log(registrar.rootNode);      // '0x93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae'

var name = 'foobarbaz';
registrar.startAuction(name);

var owner = web3.eth.accounts[0]
var value = web3.toWei(1, 'ether');

// generate a sealed bid
var bid = registrar.shaBid(name, owner, value, 'secret');
  
// submit a bid, and a deposit value. The parameters of your true bid are secret. 
var deposit = web3.toWei(2, 'ether');
registrar.newBid(bid, {value: deposit});

// reveal your bid during the reveal period
registrar.unsealBid(name, owner, value, 'secret');

// After the registration date has passed, assign ownership of the name
// in the ENS. In this case, the highest bidder would now own 'foobarbaz.eth'
registrar.finalizeAuction(name);

Throughout this module, the same optionally-asynchronous pattern as web3 is used: all functions that call web3 take a callback as an optional last argument; if supplied, the function returns nothing, but instead calls the callback with (err, result) when the operation completes.

Functions that create transactions also take an optional 'options' argument; this has the same parameters as web3.

Parameters

web3 object A web3 instance to use to communicate with the blockchain.
address address The address of the registrar.
min_length integer The minimum length of a name require by the registrar.
tld string The top level domain
ens string The address of the ENS instance

Meta

author: J Maurelian
license: LGPL

getEntry

Returns the properties of the entry for a given a name

Parameters

name string The name to get the entry for
callback function An optional callback; if specified, the function executes asynchronously.

Returns any An Entry object

startAuction

Converts a name to a hash string, and opens an auction on that hash.

Parameters

name string The name to start an auction on
params object An optional transaction object to pass to web3.
callback function An optional callback; if specified, the function executes asynchronously.

Returns any The txid if callback is not supplied.

startAuctions

Opens auctions for multiple names at once. Since names are registered as hashes, this helps to prevent other bidders from guessing which names you are interested in.

Parameters

names array An array of names to start auctions on
params object An optional transaction object to pass to web3.
callback function An optional callback; if specified, the function executes asynchronously.

Returns any The txid if callback is not supplied.

shaBid

Generates the "bid string" (hash) which representing a sealed bid. This does not submit the bid to the registrar, it only calls on the registrar's corresponding method.

ToDo: Make owner default to sender if not specified.

Parameters

name string The name to be bid on
address string An optional owner address
value number The value of your bid in wei
secret secret An optional random value
owner
callback

Returns any the sealed bid hash string