adraffy / ENSNormalize.go

ENSIP-15 in Go

ENSNormalize.go

0-dependancy ENSIP-15 in Go

• Reference Implementation: adraffy/ens-normalize.js
  • Unicode: 15.1.0
  • Spec Hash: 1f6d3bdb7a724fe3b91f6d73ab14defcb719e0f4ab79022089c940e7e9c56b9c
• Passes 100% ENSIP-15 Validation Tests
• Passes 100% Unicode Normalization Tests

$ go get github.com/adraffy/ENSNormalize.go@v0.0.1

Primary API

// panics on invalid names
ensip15.Normalize("RaFFY🚴‍♂️.eTh") // "raffy🚴‍♂.eth"

// works like Normalize()
ensip15.Beautify("1⃣2⃣.eth"); // "1️⃣2️⃣.eth"

// returns "", err on invalid names
norm, err := ens.Normalize("a_") // see below

Singleton

ens := ensip15.Shared() // singleton
ens := ensip15.New() // new instance

nf := ensip15.Shared().NF() // singleton
nf := nf.New() // new instance

Error Handling

All errors are safe to print.

Utilities

Normalize name fragments for substring search:

ensip15.Shared().NormalizeFragment("AB--", false) // "ab--"
ensip15.Shared().NormalizeFragment("..\u0300", false) // "..̀"
ensip15.Shared().NormalizeFragment("\u03BF\u043E", false) // "οо"
// note: Normalize() errors on these inputs

Construct safe strings:

ensip15.Shared().SafeCodepoint(0x303) // "◌̃ {303}"
ensip15.Shared().SafeCodepoint(0xFE0F) // "{FE0F}"
ensip15.Shared().SafeImplode([]rune{0x303, 0xFE0F}) // "◌̃{FE0F}"

Unicode Normalization Forms

ensip15.Shared().NF().NFC([]rune{0x65, 0x300}) // [0xE8]
ensip15.Shared().NF().NFD([]rune{0xE8})        // [0x65, 0x300]