import{ens_normalize}from'@adraffy/ens-normalize';// or require()// browser: https://cdn.jsdelivr.net/npm/@adraffy/ens-normalize@latest/dist/index.min.mjs (or .cjs)// *** ALL errors thrown by this library are safe to print ***// - characters are shown as {HEX} if should_escape()// - potentially different bidi directions inside "quotes"// - 200E is used near "quotes" to prevent spillover// - an "error type" can be extracted by slicing up to the first (:)// - labels are middle-truncated with ellipsis (…) at 63 cps// string -> string// throws on invalid names// output ready for namehashletnormalized=ens_normalize('RaFFY🚴‍♂️.eTh');// => "raffy🚴‍♂.eth"// note: does not enforce .eth registrar 3-character minimum

// works like ens_normalize()// output ready for displayletpretty=ens_beautify('1⃣2⃣.eth');// => "1️⃣2️⃣.eth"// note: normalization is unchanged:// ens_normalize(ens_beautify(x)) == ens_normalize(x)

// these fragments fail ens_normalize()// but will normalize fine as fragmentsletfrag1=ens_normalize_fragment('AB--');// expected error: label extletfrag2=ens_normalize_fragment('\u{303}');// expected error: leading cmletfrag3=ens_normalize_fragment('οо');// expected error: mixture

// string -> Token[]// never throwslettokens=ens_tokenize('_R💩\u{FE0F}a\u{FE0F}\u{304}\u{AD}./');// [//     { type: 'valid', cps: [ 95 ] }, // valid (as-is)//     {//         type: 'mapped',//         cp: 82,         // input//         cps: [ 114 ]    // output//     },//     {//         type: 'emoji',//         input: Emoji(2) [ 128169, 65039 ],  // input//         emoji: [ 128169, 65039 ],           // fully-qualified//         cps: Emoji(1) [ 128169 ]            // output (normalized)//     },//     {//         type: 'nfc',//         input: [ 97, 772 ],  // input (before nfc)//         cps: [ 257 ],        // output (after nfc)//         tokens0: [           // tokens (before nfc)//             { type: 'valid', cps: [ 97 ] },//             { type: 'ignored', cp: 65039 },//             { type: 'valid', cps: [ 772 ] }//         ],//         tokens: [            // tokens (after nfc)//             { type: 'valid', cps: [ 257 ] }//         ]//     },//     { type: 'ignored', cp: 173 },//     { type: 'stop', cp: 46 },//     { type: 'disallowed', cp: 47 }// ]// note: if name is normalizable, then:// ens_normalize(ens_tokenize(name).map(token => {//     ** convert valid/mapped/nfc/stop to string **// }).join('')) == ens_normalize(name)

// string -> Label[]// never throwsletlabels=ens_split('💩Raffy.eth_');// [//   {//     input: [ 128169, 82, 97, 102, 102, 121 ],//     offset: 0, // index of codepoint, not substring index!//                // (corresponding length can be inferred from input)//     tokens: [//       Emoji(2) [ 128169, 65039 ],   // emoji//       [ 114, 97, 102, 102, 121 ]    // nfc-text//     ],//     output: [ 128169, 114, 97, 102, 102, 121 ],//     emoji: true,//     type: 'Latin'//   },//   {//     input: [ 101, 116, 104, 95 ],//     offset: 7,//     tokens: [ [ 101, 116, 104, 95 ] ],//     output: [ 101, 116, 104, 95 ],//     error: Error('underscore allowed only at start')//   }// ]

// () -> number[][]letemojis=ens_emoji();// [//     [ 2764 ],//     [ 128169, 65039 ],//     [ 128105, 127997, 8205, 9877, 65039 ],//     ...// ]

// number -> boolshould_escape(0x202E);// eg. RIGHT-TO-LEFT OVERRIDE => true

// number -> boolis_combining_mark(0x20E3);// eg. COMBINING ENCLOSING KEYCAP => true

// number[] -> stringsafe_str_from_cps([0x300,0,32,97]);// "◌̀{00} a"safe_str_from_cps(Array(100).fill(97),4);// "aa…aa" => middle-truncated

Build

Security