ENSNormalize.cs

0-dependancy ENSIP-15 in C#

Reference Implementation: @adraffy/ens-normalize.js
Passes 100% Validation Tests
Space Efficient: .dll under 60KB
- Resources via make.js

// globals
adraffy.ENSNormalize.ENSIP15 // Main Library
adraffy.ENSNormalize.NF      // NFC/NFD

Primary API

// string -> string
// throws on invalid names
Console.WriteLine(ENSIP15.Normalize("RaFFY🚴‍♂️.eTh"));
// "raffy🚴‍♂.eth"

// works like Normalize()
Console.WriteLine(ENSIP15.Beautify("1⃣2⃣.eth")); 
// "1️⃣2️⃣.eth"

Output-based tokenization: Label

// string -> Label[]
// never throws
Label[] labels = ENSNormalize.ENSIP15.Split("💩Raffy.eth_");
// [
//   Label {
//     Input: [ 128169, 82, 97, 102, 102, 121 ],  
//     Tokens: [
//       OutputToken { Codepoints: [ 128169, 65039 ], IsEmoji: true }
//       OutputToken { Codepoints: [ 114, 97, 102, 102, 121 ] }
//     ],
//     Normalized: [ 128169, 114, 97, 102, 102, 121 ],
//     Group: Group { Name: "Latin", ... }
//   },
//   Label {
//     Input: [ 101, 116, 104, 95 ],
//     Tokens: [ 
//       OutputToken { Codepoints: [ 101, 116, 104, 95 ] }
//     ],
//     Error: NormError { Kind: "underscore allowed only at start" }
//   }
// ]

// string -> Label
// never throws
Label label = ENSNormalize.ENSIP15.NormalizeLabel("ABC");
// note: this throws on "."

Normalization Properties

Group — ENSIP15.Groups: IReadOnlyList<Group>
EmojiSequence — ENSIP15.Emojis: IReadOnlyList<Emoji>
Whole — ENSIP15.Wholes: IReadOnlyList<Whole>

Error Handling

All errors are safe to print. Functions that accept names as input wrap their exceptions in InvalidLabelException { Label: string, Error: NormError } for additional context.

// int -> string
ENSIP15.SafeCodepoint(0x303); // "◌̃"

// IReadOnlyList<int> -> string
ENSIP15.SafeImplode(new int[]{ 0x303, 0xFE0F }); // "◌̃{FE0F}"

// IReadOnlySet<int>
ENSIP15.ShouldEscape.Contains(0x202E); // true

Errors with Additional Context

(Base) NormException { Kind: string }
DisallowedCharacterException { CodePoint }
ConfusableException { Group, OtherGroup }
IllegalMixtureException { Codepoint, Group, OtherGroup? }

Error Kinds

"empty label"
"duplicate non-spacing marks"
"excessive non-spacing marks"
"leading fenced"
"adjacent fenced"
"trailing fenced"
"leading combining mark"
"emoji + combining mark"
"invalid label extension"
"underscore allowed only at start"
"illegal mixture"
"whole-script confusable"
"disallowed character"