ens-normalize.js
0依存 Ethereum Name Service (ENS) 名称正規化ツール。npm i @adraffy/ens-normalize ✓
- 🏛️ ENSIP-15: ENS 名称正規化標準 に準拠
- Unicode:
17.0.0• CLDR:47 - 他の実装例:
- Python — namehash/ens-normalize-python
- Rust — sevenzing/ens-normalize-rs
- Zig — evmts/z-ens-normalize
- C# — adraffy/ENSNormalize.cs
- Java — adraffy/ENSNormalize.java
- Swift – adraffy/ENSNormalize.swift
- Go — adraffy/go-ens-normalize
- Swift – adraffy/ENSNormalize.swift
- 以前の実装:
- Javascript — ensdomains/eth-ens-namehash
- ENSIP-1からの内訳レポート
- ✅️ 100% 合格 ENSIP-15 検証テスト
- ✅️ 100% 合格 Unicode 正規化テスト
- ミニファイドファイルサイズ:
29KB— ネイティブNFC、nf-native.js によるString.normalize()使用 ⚠️38KBデフォルト — カスタムNFC、nf.js
44KB 全て含む!* — カスタムNFC + サブライブラリ: parts.js, utils.js
- 含まれるアプリ:
- リゾルバーデモ ⭐
- 対応絵文字
- 文字ビューア
- 混乱解説
- 関連プロジェクト:
- 最新の .eth 登録 • 更新 • 期限切れ
- ラベルデータベース • Labelhash⁻¹ • 総当たり
- 絵文字頻度エクスプローラー
- adraffy/punycode.js • Punycode コーダー
- adraffy/keccak.js • Keccak ハッシャー
- adraffy/emoji.js • 絵文字パーサー
- リゾルバーデモ 下部にさらにリンクあり
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 namehash
let normalized = ens_normalize('RaFFY🚴♂️.eTh');
// => "raffy🚴♂.eth"
// note: does not enforce .eth registrar 3-character minimum
絵文字を完全修飾形式でフォーマットする:// works like ens_normalize()
// output ready for display
let pretty = 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 fragments
let frag1 = ens_normalize_fragment('AB--'); // expected error: label ext
let frag2 = ens_normalize_fragment('\u{303}'); // expected error: leading cm
let frag3 = ens_normalize_fragment('οо'); // expected error: mixture
入力ベースのトークン化:// string -> Token[]
// never throws
let tokens = 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 throws
let labels = 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[][]
let emojis = ens_emoji();
// [
// [ 2764 ],
// [ 128169, 65039 ],
// [ 128105, 127997, 8205, 9877, 65039 ],
// ...
// ]文字が直接印刷されるべきでないかどうかを判断する:
// number -> bool
should_escape(0x202E); // eg. RIGHT-TO-LEFT OVERRIDE => true文字が結合記号かどうかを判定する:
// number -> bool
is_combining_mark(0x20E3); // eg. COMBINING ENCLOSING KEYCAP => true
コードポイントを印刷可能な文字列としてフォーマットする:// number[] -> string
safe_str_from_cps([0x300, 0, 32, 97]); // "◌̀{00} a"
safe_str_from_cps(Array(100).fill(97), 4); // "aa…aa" => middle-truncated
ビルド
- このリポジトリを
git cloneし、次にnpm installを実行 - /derive/ 内の指示に従いデータファイルを生成
npm run derive- spec.json
- nf.json
- nf-tests.json
npm run make— /derive/output/ からデータファイルを圧縮- include-ens.js
- include-nf.js
- include-versions.js
- /validate/ 内の指示に従い検証テストを生成
npm run validate- tests.json
npm run test— 検証テストを実行npm run build— /dist/ を作成npm run rebuild— 上記すべてのコマンドを実行npm run order— 最適なグループ順序を作成して再ビルド
セキュリティ
- ビルド を実行し、include-versions.js と比較
spec_hash— spec.json の SHA-256 ハッシュ値(バイト単位)ens_hash_base64— include-ens.js の base64 リテラルの SHA-256 ハッシュ値nf_hash_base64— include-nf.js の base64 リテラルの SHA-256 ハッシュ値