@adraffy/ens-normalize

What is @adraffy/ens-normalize?

@adraffy/ens-normalize is an npm package designed to normalize Ethereum Name Service (ENS) names. It ensures that ENS names are in a consistent format, which is crucial for avoiding ambiguities and ensuring compatibility across different systems.

What are @adraffy/ens-normalize's main functionalities?

Normalization

This feature allows you to normalize an ENS name to ensure it is in a consistent format. The code sample demonstrates how to normalize the ENS name 'example.eth'.

const { normalize } = require('@adraffy/ens-normalize');
const normalized = normalize('example.eth');
console.log(normalized);

Validation

This feature allows you to validate an ENS name to check if it conforms to the expected format. The code sample demonstrates how to validate the ENS name 'example.eth'.

const { validate } = require('@adraffy/ens-normalize');
const isValid = validate('example.eth');
console.log(isValid);

Unicode Handling

This feature allows you to convert Punycode-encoded ENS names to their Unicode equivalents. The code sample demonstrates how to convert the Punycode-encoded ENS name 'xn--exmple-cua.eth' to its Unicode equivalent.

const { toUnicode } = require('@adraffy/ens-normalize');
const unicodeName = toUnicode('xn--exmple-cua.eth');
console.log(unicodeName);

Other packages similar to @adraffy/ens-normalize

eth-ens-namehash

The eth-ens-namehash package is another tool for generating ENS namehashes. It includes some basic normalization features but is primarily focused on the namehashing process. It is less comprehensive in normalization compared to @adraffy/ens-normalize.

punycode

The punycode package provides utilities for converting between Unicode and Punycode, which is useful for handling internationalized domain names (IDNs). While it does not specifically target ENS names, it can be used in conjunction with other packages to handle Unicode normalization.

README

ens-normalize.js

1-file, 0-dependancy Compact ES6 Ethereum Name Service (ENS) Name Normalizer.

• Uses latest specification: UTS-46 v14.0.0
• Handles ZWNJ/ZWJ in ContextJ
• Handles Emoji ZWJ Sequences
• Handles Punycode, adapted from mathiasbynens/punycode.js

---

• Live Demo
• Generated Report: Unicode IDNATestV2
• Generated Report: eth-ens-namehash/normalize

import {ens_normalize} from '@adraffy/ens-normalize';
// browser: 
// 'https://unpkg.com/@adraffy/ens-normalize@latest/dist/ens-normalize.min.js'

// example:
let normalized = ens_normalize('🚴‍♂️.eth'); // throws if error
// this value is ready for hashing

// optional argument: ignore_disallowed (default: false)
// when truthy, disallowed characters are ignored 
console.log(ens_normalize('_', true)); // === ''
console.log(ens_normalize('_'));       // throws: disallowed

// errors:
// - not a string
// - contains disallowed character if !ignore_disallowed
// - puny decode failure
// - puny decode mismatch
// - label has double-hyphen at [3:4]
// - label starts/ends with hyphen
// - label starts with combining mark

// note: does not enforce .eth TLD 3-character minimum

---

Build Notes

• Clone to access build/. These files are not included in the npm version.
• The actual source is in build/ens-normalize.js.
• Use npm run dist to build the injected and minified versions.