Smart Contract Integration Guide

This guide covers how to retrieve the reverse record of UD domains using smart contracts. This process requires using the ABIs built into the Unstoppable Domains UNS smart contract.

Step 1: Select a UNS Registry Smart Contract

The UNS Registry smart contract is where domain owners store their data and is a map of domain namehashes to key-value dictionaries of records. Choose one of the Unstoppable Registry smart contracts to interact with (either mainnet or testnet).

Step 2: Open the “Read as Proxy” Tab for the Registry Contract

Navigate to the Contract tab in either the Etherscan or Polygonscan page of the Registry contract and click on the Read as Proxy tab:

Step 3: Retrieve the Reverse Record

The UNS contract has a reverseOf() method that takes in a wallet address and returns the namehash of the domain that has configured Reverse Resolution to that address.

Add the wallet address you want to resolve in the addr field of the reverseOf() method and click the Query button.

Step 4: Get the Domain Metadata

Send a GET request to the Get Metadata for a Domain to retrieve the metadata of the domain associated with the namehash returned from the reverseOf() method call:

https://resolve.unstoppabledomains.com/metadata/{domainOrToken}

Step 5: Get the Domain Name From the Metadata

The metadata endpoint returns a JSON response in the following format:

{
  "name": string,
  "description": string,
  "properties": object,
  "external_url": string,
  "image": string,
  "image_url": string,
  "attributes": [
    object
  ],
  "background_color": string
}

The human-readable form of the domain associated with the token is stored in the name field of the API response.

Smart Contract Considerations

Integrating Reverse Resolution with smart contracts involves using the reverseOf() method to retrieve the namehash of the reverse record, then using the Get Metadata for a Domain to get the human-readable version of the domain.

You can also integrate Reverse Resolution into your application using libraries that allow you to call smart contracts ABIs like ethers.js and web3.js. Here’s an application that integrates Reverse Resolution using ethers.js: https://github.com/Noxturnix/web3udmintfeed.nft.

An example in JavaScript of integrating Reverse Resolution (using the ethers.js library):

const proxyReaderAddress = "0x423F2531bd5d3C3D4EF7C318c2D1d9BEDE67c680";

// partial ABI, just for the reverseOf method
const proxyReaderAbi = [
  "function reverseOf(address addr) external view returns (uint256)",
];

const proxyReaderContract = new ethers.Contract(
  proxyReaderAddress,
  proxyReaderAbi,
  provider
);

const address = "0x88bc9b6c56743a38223335fac05825d9355e9f83";

// call the reverseOf method
const reverseResolutionTokenId = await proxyReaderContract.reverseOf(address);
fetch(`https://resolve.unstoppabledomains.com/metadata/${reverseResolutionTokenId}`)
  .then(response => response.json())
  .then(data => console.log(data.name));

// jim-unstoppable.x

Asking For Help

If you are experiencing difficulties using our services, please know that we are here to help. You can join our Discord Community for real-time support from UD and the community, where you can receive assistance with integrating your app