Quickstart

1. Install

   Begin by installing @namehash/nameguard:

   npm

   npm install @namehash/nameguard
   

2. Import

   Next import nameguard using the required network:

   mainnet

   import { nameguard } from "@namehash/nameguard";
   

3. Inspect

   You’re now ready to inspect, lookup and verify:

   Inspect Name

   const report = await nameguard.inspectName("nick.eth");
   

   Batch Inspect Name

   const names = ["vitalik.eth", "notrab.eth"];
   
   const reports = await nameguard.bulkInspectNames(names);
   

   Secure Primary Name Lookup

   const result = await nameguard.getSecurePrimaryName("0x...");
   

   Verify `.eth` Names

   const report = await nameguard.fakeEthNameCheck("contractAddress", "tokenId");
   

   Inspect Grapheme

   const report = await nameguard.inspectGrapheme("𝒶");
   

   Inspect Labelhash

   const report = await nameguard.inspectLabelhash("0x...", {
     parent: "eth",
   });
   

   Inspect Namehash

   const report = await nameguard.inspectNamehash("0x...");