Reusable functions and components for the SNS apps

Most functions in this library are async functions and therefore return promises which can be awaited or chained with .then.

Contents

• Registry and Resolvers

  • setupSNS()
  • getOwner()
  • getResolver()
  • getTTL()
  • getOwnerWithLabelhash()
  • getResolverWithLabelhash()
  • getAddress()
  • getAddr()
  • getContent()
  • getText()
  • getName()
  • getSubdomains()
  • setSubnodeOwner()
  • setSubnodeRecord()
  • setResolver()
  • setAddress()
  • setAddr()
  • setContent() DEPRECATED
  • setContenthash()
  • setText()
  • checkSubdomain()
  • createSubdomain()
  • deleteSubdomain()
  • claimAndSetReverseRecord()
  • setReverseRecord
  • getDomainDetails
  • getSubdomains

• Transaction Response

Setup

Setup for the library is done by calling the setupENS function. It can be optionally provided with a customProvider and an ENS address. Generally you won't need this unless you are running ganache.

It will return an object with the registrar and ens object. The ens object will deal with name resolution, reverse records and dealing with the registry. The registrar object has functions to interact the permanent registrar, legacy auction registrar and test registrar (just on test net)

import { setupSNS } from '@ensdomains/ui'

window.addEventListener('load', async () => {
  const { registrar, ens } = await setupSNS()
  const owner = await ens.getOwner('resolver.eth')
  // will instantiate with window.web3/window.ethereum if found, read-only if not.
  // Once setup has finished you can now call functions off the library
})

API

async function setupSNS(options): void

setupSNS must be called before anything other function in this library. We recommend calling it in a window.load event to make sure that your web3 object has loaded. You can provide a custom provider yourself, but by default it will look for window.web3 or window.ethereum if you do not give it a provider. We use the custom provider when we need to run automated tests with ganache. You can also it pass it the registry address, but by default it will derive the network you are on and instantiate ENS using that network's registry. You only need to provider it with an ens address if you are on a private network.

### `async function deleteSubdomain(label, name): TransactionResponse`

Can only be called by the controller of the name. This function will set the controller to `0x000...` and if it has a resolver, it will set the resolver `0x000...`, which will be a second transaction. Alternatively you can manually call `setSubnodeOwner` and set the controller to `0x000...`

#### Arguments

label (String): ENS Label e.g: sub (sub.vitalik.eth)
name (String): An ENS name

#### Returns

transaction (object): [Transaction Response Object](#transaction-response)

#### Example

```js
const tx = await ens.deleteSubdomain('sub', 'vitalik.eth')
console.log(tx.hash)
// 0x123456...
const receipt = await tx.wait() // Wait for transaction to be mined
// Transaction has been mined

async function claimAndSetReverseRecordName(name): TransactionResponse

This function will claim your Ethereum address on the reverse registrar, setup the reverse resolver and setup your name on the resolver all in one transaction. It can also be used to change your reverse record name to something else.

Arguments

name (String): An ENS name

Returns

transaction (object): Transaction Response Object

Example

const tx = await ens.claimAndSetReverseRecordName('vitalik.eth')
console.log(tx.hash)
// 0x123456...
const receipt = await tx.wait() // Wait for transaction to be mined
// Transaction has been mined