npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-ens-name

v0.2.5

Published

React Component that resolves ENS Names

Downloads

91

Readme

react-ens-name

A React Component which resolves ENS Names. It does a reverse lookup of an Ethereum Address to accomplish this. This component also caches ENS names using Zustand on the client side.

If the address cannot be resolved, the address will be formatted for you. There are a variety of ways to format the address. The default is to display the last 4 digits of an ETH Address (0x...F314).

Note: customDisplay is favored over any other fallback address display preferences.

Note: No styling on the component is provided.

Install

Using npm:

npm install ethereum-ens-name

Using yarn:

yarn add ethereum-ens-name

Usage

Basic

Provide ENSName component an ethereum address and it will resolve it

const IndexPage = () => {
  return (
    <div className="index">
      Index
      <ENSName address="0xD286064cc27514B914BAB0F2FaD2E1a89A91F314"></ENSName>
      <style jsx>{`
        .index {
        }
      `}</style>
    </div>
  );
};

Using Custom Provider

const IndexPage = () => {
  import { ethers } from ethers

  const provider =new ethers.providers.JsonRpcProvider(
    "https://mainnet.infura.io/v3/<INFURA_KEY>"
  );

  return (
    <div className="index">
      Index
      <ENSName
        address="0xD286064cc27514B914BAB0F2FaD2E1a89A91F314",
        provider={provider}
      ></ENSName>
      <style jsx>{`
        .index {
        }
      `}</style>
    </div>
  );
};

Using Custom Display

const randomFormat = (address: string | undefined) => {
  return address.slice(0, getRandomInt(40) + 2)
}

const IndexPage = () => {
  import { ethers } from ethers

  return (
    <div className="index">
      Index
      <ENSName
        address="0xD286064cc27514B914BAB0F2FaD2E1a89A91F314",
        customDisplay={randomFormat}
      ></ENSName>
      <style jsx>{`
        .index {
        }
      `}</style>
    </div>
  );
};

Params

  • address - the ethereum address to resolve the ens name for
  • provider - can choose to provide a custom provider to resolve the ENS name (infura, metamask). By default the mainnet will be used
  • displayType - How to display the address if ENS can't resolve the name
    • "FULL", // display: 0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B
    • "LAST4", // display: 0xeC9B
    • "LAST6", // display: 0x9aeC9B
    • "FIRST4", // display: 0xAb58
    • "FIRST6", // display: 0xAb5801
    • "FIRST4_LAST4", // display: 0xAb58...eC9B
    • "FIRST6_LAST6", // display: 0xAb5801...9aeC9B
  • "withEllipses" - Adds "..." where it makes sense for the display
  • customDisplay - provide a function which takes the address (0x...) and formats it in a custom way

Formatting Options

TODO

  • Validate ETH Address
    • Handle API failure cleanly
  • Use decentralized way of resolving ENS name (using The Graph subgraph for ENS?)
  • Cleanup Codebase
  • Request Feedback & Suggestions
  • Component Styling?