sof-ens-namehash

A simple module for generating ENS namehashes per spec https://octonion.institute/susytech/SIPs/issues/137

Usage no npm install needed!

<script type="module">
  import sofEnsNamehash from 'https://cdn.skypack.dev/sof-ens-namehash';
</script>

README

Sof ENS Namehash CircleCI

A javascript library for generating Sophon Name Service (ENS) namehashes per spec.

Available on NPM

Installation

npm install sof-ens-namehash -S

Usage

var namehash = require('sof-ens-namehash')
var hash = namehash.hash('foo.sof')
// '0xde9b09fd7c5f901e23a3f19fecc54828e9c848539801e86591bd9801b019f84f'

// Also supports normalizing strings to ENS compatibility:
var input = getUserInput()
var normalized = namehash.normalize(input)

Security Warning

ENS Supports UTF-8 characters, and so many duplicate names are possible. For example:

  • faceboŠ¾k.sof
  • facebook.sof

The first one has non-ascii chars. (control+F on this page and search for facebook, only the second one will match).

namehash.normalize() doesn't automagically remap those, and so other precautions should be taken to avoid user phishing.

Development

This module supports advanced JavaScript syntax, but exports an ES5-compatible module. To re-build the exported module after making changes, run npm run bundle (must have browserify installed).