How to “Add a Primary ENS Name” for Your Web3 or EVM Smart Contract

Today, let’s dive into the exciting world of ENS and Ethereum Virtual Machine (EVM) blockchains, and uncover how to add a primary ENS name to your contract for improved user experience and safety.

Remember this quote from Jeff Lau, the Ethereum developer:

“ENS is not just a nice to have. It’s about better UX, better security, and better branding.” — JeffLau.eth

Understanding ENS & EVM Blockchains

ENS (Ethereum Name Service) is a decentralized domain name system built on the Ethereum blockchain. It functions similarly to the internet’s DNS (Domain Name System), but with a twist: it’s completely decentralized, providing a more secure and censorship-resistant infrastructure. This, coupled with the Ethereum Virtual Machine (EVM) blockchain’s ability to execute smart contracts, makes for a powerful synergy that can drastically enhance the user experience and security on the Web3.

The magic of ENS is its simplicity. Instead of having to remember an unwieldy alphanumeric address, users can simply refer to an easy-to-remember domain, such as ‘yourname.eth’. This capability isn’t just a novelty—it’s an essential step towards making blockchain technology accessible and user-friendly.

Every contract should have a primary ENS name? Why?

1) Usability – it makes it easy to know what contracts are what on-chain. This can be seen inside wallet and explorers.

2) Security – Contracts with names are harder to spoof

3) DevEx – Contracts can be updated dynamically https://t.co/l86jRvVYUI

— jefflau.eth (@_jefflau) April 18, 2023

Claiming the Reverse Node: Path to Better UX

Claiming the reverse node for your contract upon deployment is a game-changer, letting users see the ENS name instead of an address. It’s a vital step towards more intuitive interactions on the EVM blockchain.

So, how can you achieve this? Let’s take a look at a handy GitHub resource provided by ENS Domains and JeffLau.eth.

The code featured here allows you to add a primary ENS name to your contract by inheriting the ReverseClaimer contract. In turn, your contract automatically claims its reverse ENS record on deployment.

Added this contract last month. If you inherit this into your contract, it will claim the reverse node for your contract on deploy.

You can then add a primary ENS name for your contract so you see the name instead of an address!
https://t.co/o0bNCqbhtq

— jefflau.eth (@_jefflau) April 17, 2023

Detailed Walkthrough: Implementing ENS in Your Smart Contract

Adding a primary ENS name to your contract is a straightforward process that significantly enhances user interaction. Below is a detailed walkthrough, complete with a code snippet, to guide you through this process.

Step 1: Preparing Your Environment

Before you begin, ensure you have the following prerequisites:

• An Ethereum development environment, like Truffle or Hardhat.
• A deployed smart contract on the Ethereum network.

Step 2: Integrating the ENS Library

First, integrate the ENS library into your development environment. If you’re using Node.js, you can install the ENS library via npm:

Intrigued? You should be. With a simple code modification, you can transform your users’ experience, making it simpler and safer for them to interact with your contracts.

Step 3: Claiming Your ENS Name

To claim an ENS name, you need to register it via the ENS app or a similar service. Once you have your ENS name (e.g., yourname.eth), you’re ready to link it to your contract.

Step 4: Writing the Code

Now, let’s write the code to claim the reverse node. We’ll use a simple example where your contract inherits the ReverseClaimer contract. Here’s a basic implementation:

pragma solidity ^0.8.0;

import "@ensdomains/ens-contracts/contracts/registry/ReverseRegistrar.sol";

contract YourContract is ReverseClaimer {

constructor(address ensRegistry) {

// Obtain the reverse registrar from the ENS registry

ReverseRegistrar reverseRegistrar = ReverseRegistrar(ensRegistry);

// Claim the reverse node

reverseRegistrar.claim(address(this)); }

// Additional contract logic here

} 

In this snippet:

• We import the ReverseRegistrar contract from the ENS library.
• The constructor of YourContract takes the address of the ENS registry and claims the reverse node.

Step 5: Deploying Your Contract

With the modified contract, deploy it to the Ethereum network using your preferred tools. Upon deployment, your contract will automatically claim its reverse ENS record.

Step 6, The Final Step: Verifying the Setup

After deployment, verify that your contract’s address resolves to your claimed ENS name. You can do this through the ENS app or programmatically using a script.

https://t.co/437qCXEmfy

imo ReverseResolver could be updated to respect ERC-173 owner()

i like the following setup for future contracts: pic.twitter.com/nJNZWvfzop

— raffy.eth🌱🩸 (@adraffy) May 24, 2023

The Impact on User Onboarding & Experience

There’s no denying the fact that ENS significantly enhances the Web3 user experience, providing a more human-friendly interface to interact with contracts. Not only does this make it easier for users to remember and input addresses, but it also adds an extra layer of security, as the chance of entering an incorrect address is reduced.

When JeffLau.eth says, “ENS is not just a nice to have”, he’s absolutely right. The ENS and EVM blockchain combination is not just a ‘nice-to-have’, it’s an essential upgrade for anyone looking to bring their smart contract operations into the Web3 era, with superior UX, superior security, and superior Web3 branding.

In this example, we can see the “binance-nft-marketplace.eth” ENS address.

Binance/Unstoppable Domains (paid) partnership update: pic.twitter.com/YsFibv8K41

— alto | dollar.eth (@etheraltog) June 22, 2023

Final Thoughts: Seizing the ENS Opportunity

ENS integration is no longer optional—it’s a necessity. As more users onboard into the world of Web3, having a primary ENS name for your contract is a surefire way to stand out, while offering a safer, more user-friendly experience.

Remember, ENS is cross-blockchain compatible, and blockchain agnostic. ENS is not just about names—it’s about forging an intuitive and secure path, for users and smart contracts, in the ever-evolving Web3 landscape.

So, take a leap, claim your smart contracts’ reverse node, (or encourage your favorite project to do so), and watch as the world of Web3 becomes a little more readable and identifiable to everyone!

JeffLau.eth’s GitHub Link: https://github.com/ensdomains/ens-contracts/blob/master/contracts/reverseRegistrar/ReverseClaimer.sol