RSK Documentation
RSK Documentation
| 11 minutes to read | Edit |
Share
| Dark

Web3

To use web3 and interact with the contracts, we must instance web3 with a provider. To do so we can use RSK public nodes:

var Web3 = require('web3')

var web3 = new Web3()
web3.setProvider(new web3.providers.HttpProvider(config.node))

Registrar

Instance the Registrar contract and the RIF Token contract:

var registrarAbi = []
var registrarAddress = ''
var registrarInstance =  web3.eth.contract(registrarAbi)
var registrar = registrar.at(registrarAddress)

var rifAbi = []
var rifAddress = ''
var rifInstance = web3.eth.contract(rifAbi)
var rif = rifInstace.at(rifAddress)

Check the auction status

After making any operation, check the domain state:

name field does not include .rsk suffix

For further information have a look at registrar contract.

function check(name) {
    var hash = web3.sha3(name)
    var status = registrar.state()
    return status
}

switch(check(myname)) {
    case 0:
        return 'Open'
    case 1:
        return 'Auction'
    case 2:
        return 'Owned'
    case 4:
        return 'Reveal'
}

Further reading: state.

Start an auction

To open a single auction:

function startAuction(name) {
    var hash = web3.sha3(name)
    registrar.startAuction(hash)
}

Further reading: startAuction.

Or open many auctions at once for better anonymity:

function startAuction(name, n_extras) {
    var hashes = []

    var hash = web3.sha3(name)
    hashes.push(hash)

    for (let i = 0; i < n_extras; i++)
        hashes.push(web3.sha3(hash + i.toString()))

    shuffle(hashses) // optional: shuffle them

    registrar.startAuctions(hashes)
}

Further reading: startAuctions.

Bid

To bid on an open auction:

function bid(name, owner, bidTokens, amountSent) {
    let hash = web3.sha3(name)
    let tokens = web3.toWei(bidTokens, 'ether')
    let amount = web3.toWei(amountSent, 'ether')
    let salt = random()

    var bid = registrar.shaBid(hash, owner, tokens, salt)

    // Pay the bid with one of these options:

    // With approve
    rif.approve(registrar.address, amount, (err, res) => {
        if (!err) registrar.newBid(shaBid, amount)
    })

    // With transfer and call
    const data = '0x1413151f' + bid.slice(2)
    rif.transferAndCall(registrar.address, amount, data)
}

Further reading: bid.

If you want to create an auction a bid in only one transaction:

function createAndBid(name, owner, bidTokens, amountSent) {
    var hashes = []

    var hash = web3.sha3(name)
    hashes.push(hash)

    for (let i = 0; i < n_extras; i++)
        hashes.push(web3.sha3(hash + i.toString()))

    shuffle(hashses) // optional: shuffle them

    let tokens = web3.toWei(bidTokens, 'ether')
    let amount = web3.toWei(amountSent, 'ether')
    let salt = random()

    var bid = registrar.shaBid(hash, owner, tokens, salt)

    rif.approve(registrar.address, amount, (err, res) => {
        if (!err) registrar.startAuctionsAndBid(hashes, shaBid, amount)
    })
}

Further reading: startAuctionsAndBid.

Unseal bid

Remember the data you input to unseal the bid must be the same you used to seal it.

function bid(name, owner, bid_tokens, displayed_tokens) {
    let hash = web3.sha3(name)
    let tokens = web3.toWei(bid_tokens, 'ether')
    let salt = random()

    registrar.unsealBid(hash, tokens, salt)
}

Further reading: unsealBid.

Register won auction

To register the name recently won in the RND Registry contract:

function finalizeAuction(name) {
    var hash = web3.sha3(name)
    registrar.finalizeAuction(hash)
}

Further reading: finalizeAuction.

Transfer domain ownership

With the domain ownership, the deed and the tokens are also transferred:

function transfer(name, to) {
    var hash = web3.sha3(name)
    registrar.transfer(hash, to)
}

Further reading: transfer.

Release a domain

A domain can be released within the rent payment period. Check this and then, to release de domain:

function release(name) {
    var hash = web3.sha3(name)
    registrar.releaseDeed(hash)
}

Further reading: releaseDeed.

Pay rent

The rent must also be payed within the rent payment period. Check withinRentPaymentPeriod above and then:

function payRent(name) {
    var hash = web3.sha3(name)
    var amount =  1e18

    // Pay the rent with one of this options:

    // With approve
    rif.approve(registrar.address, amount, (err, res) => {
        registrar.payRent(hash, amount)
    })

    // With transfer and call
    const data = '0xe1ac9915' + hash.slice(2)
    rif.transferAndCall(registrar.address, amount, data)
}

Further reading: payRent.

Check rent status

To know if the domain is within the rentment period:

var deedAbi = []
var deedInstance = web3.contract(deedAbi)

function withinRentPaymentPeriod(name) {
    var hash = web3.sha3(name)
    registrar.entries(hash, (entries_error, entry) => {
        if (entries_error) return true
        var deed = deedInstance.at(res.deed)
        deed.canPayRent((err, res) => {
            return !err && res
        })
    })
}

Further reading: canPayRent.

Or resolve it logically:

function withinRentPaymentPeriod(name) {
    var hash = web3.sha3(name)
    registrar.entries(hash, (err, res) => {
        return !err && (res.expirationDate - 9 months) > 0
    })
}

Further reading: entries.

RNS Registry

Instance the RNS Registry contract:

const rnsAbi = []
const rnsAddress = ''
var rnsInstance = web3.eth.contract(rnsAbi)
var rns = registryInstance.at(rnsAddress)

And include namehash library:

var namehash = require('eth-ens-namehash').hash

domain field does include .rsk suffix

Further reading: RNS Registry contract.

Change the resolver

function setResolver(domain, newResolver) {
    var hash = namehash(domain)
    rns.setResolver(hash, newResolver)
}

Further reading: setResolver.

Change the node owner

function setOwner(domain, owner) {
    var hash = namehash(domain)
    rns.setOwner(hash, owner)
}

Further reading: setOwner.

Change the TTL

function setTTL(domain, ttl) {
    var hash = namehash(domain)
    rns.setTTL(hash, ttl)
}

Further reading: setTTL.

Create a subdomain

This is also used to change the subdomain owner.

The name field is the subdomain inherited from the domain.

function subdomain(domain, name, owner) {
    var domainHash = namehash(domain)
    var hash = web3.sha3(name)
    rns.setSubnodeOwner(domainHash, hash, owner)
}

Further reading: setSubnodeOwner.

Resolver

Have a look at the Resolve a name and Public Resolver Contract section for further information.