JSPM

  • Created
  • Published
  • Downloads 1705200
  • Score
    100M100P100Q227729F
  • License MIT

Compact ES6 Ethereum Name Service (ENS) Name Normalizer

Package Exports

  • @adraffy/ens-normalize
  • @adraffy/ens-normalize/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@adraffy/ens-normalize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ens-normalize.js

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


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.