Merge pull request #144 from ensdomains/deleted-name-filter

feat: deleted name filtering via subgraph

packages/ensjs/deploy/00_register_legacy.cjs

@@ -309,6 +309,17 @@ const names = [
     namedAddr: 'owner',
     duration: 2419200,
   },
+  {
+    label: 'deletable',
+    namedOwner: 'owner',
+    namedAddr: 'owner',
+    subnames: [
+      { label: 'xyz', namedOwner: 'owner2' },
+      { label: 'test', namedOwner: 'owner' },
+      { label: 'unwrapped-deleted', namedOwner: 'owner' },
+      { label: 'wrapped-deleted', namedOwner: 'owner' },
+    ],
+  },
   ...Array.from({ length: 34 }, (_, i) => ({
     label: `${i}-dummy`,
     namedOwner: 'owner2',

packages/ensjs/deploy/01_delete_names.cjs

@@ -0,0 +1,65 @@
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable no-await-in-loop */
+const { ethers } = require('hardhat')
+const { namehash, toHex, labelhash } = require('viem')
+const { EMPTY_ADDRESS } = require('../dist/cjs/utils/consts')
+const { packetToBytes } = require('../dist/cjs/utils/hexEncodedName')
+
+/**
+ * @type {import('hardhat-deploy/types').DeployFunction}
+ */
+const func = async function (hre) {
+  const { getNamedAccounts } = hre
+  const allNamedAccts = await getNamedAccounts()
+
+  const nameWrapper = await ethers.getContract(
+    'NameWrapper',
+    await ethers.getSigner(allNamedAccts.owner),
+  )
+  const registry = await ethers.getContract(
+    'ENSRegistry',
+    await ethers.getSigner(allNamedAccts.owner),
+  )
+
+  /**
+   * @param {string} name
+   */
+  const deleteName = async (name) => {
+    const labels = name.split('.')
+    const label = labelhash(labels.shift())
+    const node = namehash(labels.join('.'))
+
+    const tx = await registry.setSubnodeRecord(
+      node,
+      label,
+      EMPTY_ADDRESS,
+      EMPTY_ADDRESS,
+      0,
+    )
+    await tx.wait()
+  }
+
+  const name1 = 'wrapped-deleted.deletable.eth'
+  const name2 = 'unwrapped-deleted.deletable.eth'
+
+  // wrap wrapped-deleted.deletable.eth
+  const approveTx = await registry.setApprovalForAll(nameWrapper.address, true)
+  await approveTx.wait()
+  const wrapTx = await nameWrapper.wrap(
+    toHex(packetToBytes(name1)),
+    allNamedAccts.owner,
+    EMPTY_ADDRESS,
+  )
+  await wrapTx.wait()
+
+  await deleteName(name1)
+  await deleteName(name2)
+
+  return true
+}
+
+func.id = 'delete-names'
+func.tags = ['delete-names']
+func.runAtTheEnd = true
+
+module.exports = func

packages/ensjs/hardhat.config.cjs

@@ -1,5 +1,5 @@
-require('@nomiclabs/hardhat-ethers')
 require('dotenv/config')
+require('@nomiclabs/hardhat-ethers')
 require('hardhat-deploy')
 const { resolve } = require('path')
 

packages/ensjs/src/clients/decorators/subgraph.ts

@@ -156,6 +156,7 @@ export type EnsSubgraphActions = {
     name,
     searchString,
     allowExpired,
+    allowDeleted,
     orderBy,
     orderDirection,
     pageSize,

packages/ensjs/src/functions/subgraph/getNamesForAddress.test.ts

@@ -2,6 +2,7 @@
 
 import type { Address } from 'viem'
 import { publicClient, walletClient } from '../../test/addTestContracts.js'
+import { EMPTY_ADDRESS } from '../../utils/consts.js'
 import getNamesForAddress, {
   type NameWithRelation,
 } from './getNamesForAddress.js'
@@ -132,6 +133,35 @@ describe('filter', () => {
     )
     expect(reverseRecordNames.length).toBeGreaterThan(0)
   })
+  it('does not include deleted names by default', async () => {
+    const result = await getNamesForAddress(publicClient, {
+      address: accounts[1],
+      pageSize: 1000,
+    })
+    if (!result.length) throw new Error('No names found')
+    const deletedNames = result.filter(
+      (x) => x.parentName === 'deletable.eth' && x.owner === EMPTY_ADDRESS,
+    )
+    expect(deletedNames.length).toBe(0)
+  })
+  it('allows including deleted names', async () => {
+    const result = await getNamesForAddress(publicClient, {
+      address: accounts[1],
+      pageSize: 1000,
+      filter: {
+        owner: true,
+        registrant: true,
+        resolvedAddress: true,
+        wrappedOwner: true,
+        allowDeleted: true,
+      },
+    })
+    if (!result.length) throw new Error('No names found')
+    const deletedNames = result.filter(
+      (x) => x.parentName === 'deletable.eth' && x.owner === EMPTY_ADDRESS,
+    )
+    expect(deletedNames.length).toBe(1)
+  })
 })
 
 describe.each([

packages/ensjs/src/functions/subgraph/getNamesForAddress.ts

@@ -7,7 +7,7 @@ import {
   InvalidFilterKeyError,
   InvalidOrderByError,
 } from '../../errors/subgraph.js'
-import { GRACE_PERIOD_SECONDS } from '../../utils/consts.js'
+import { EMPTY_ADDRESS, GRACE_PERIOD_SECONDS } from '../../utils/consts.js'
 import { createSubgraphClient } from './client.js'
 import type { DomainFilter } from './filters.js'
 import {
@@ -47,6 +47,8 @@ type GetNamesForAddressFilter = GetNamesForAddressRelation & {
   allowExpired?: boolean
   /** Allows reverse record nodes to be included (default: false) */
   allowReverseRecord?: boolean
+  /** Allows deleted names to be included (default: false) */
+  allowDeleted?: boolean
 }
 
 export type GetNamesForAddressParameters = {
@@ -165,6 +167,7 @@ const getNamesForAddress = async (
       resolvedAddress: true,
       wrappedOwner: true,
       allowExpired: false,
+      allowDeleted: false,
       allowReverseRecord: false,
     },
     orderBy = 'name',
@@ -175,7 +178,7 @@ const getNamesForAddress = async (
 ): Promise<GetNamesForAddressReturnType> => {
   const subgraphClient = createSubgraphClient({ client })
 
-  const { allowExpired, allowReverseRecord, ...filters } = filter
+  const { allowExpired, allowDeleted, allowReverseRecord, ...filters } = filter
   const ownerWhereFilters: DomainFilter[] = Object.entries(filters).reduce(
     (prev, [key, value]) => {
       if (value) {
@@ -240,6 +243,31 @@ const getNamesForAddress = async (
     })
   }
 
+  if (!allowDeleted) {
+    // exclude "deleted" domains
+    // when owner/resolver/registrant = null
+    whereFilters.push({
+      or: [
+        {
+          owner_not: EMPTY_ADDRESS,
+        },
+        {
+          resolver_not: null,
+        },
+        {
+          and: [
+            {
+              registrant_not: EMPTY_ADDRESS,
+            },
+            {
+              registrant_not: null,
+            },
+          ],
+        },
+      ],
+    })
+  }
+
   const whereFilter: DomainFilter =
     whereFilters.length > 1 ? { and: whereFilters } : whereFilters[0]
 

packages/ensjs/src/functions/subgraph/getSubnames.test.ts

@@ -91,6 +91,21 @@ it('allows including expired names - other', async () => {
   )
   expect(expiredNames.length).toBeGreaterThan(0)
 })
+it('does not include deleted names by default', async () => {
+  const result = await getSubnames(publicClient, {
+    name: 'deletable.eth',
+  })
+  if (!result.length) throw new Error('No names found')
+  expect(result.length).toBe(2)
+})
+it('allows including deleted names', async () => {
+  const result = await getSubnames(publicClient, {
+    name: 'deletable.eth',
+    allowDeleted: true,
+  })
+  if (!result.length) throw new Error('No names found')
+  expect(result.length).toBe(4)
+})
 
 describe.each([
   {

packages/ensjs/src/functions/subgraph/getSubnames.ts

@@ -2,7 +2,7 @@
 import { gql } from 'graphql-request'
 import type { ClientWithEns } from '../../contracts/consts.js'
 import { InvalidOrderByError } from '../../errors/subgraph.js'
-import { GRACE_PERIOD_SECONDS } from '../../utils/consts.js'
+import { EMPTY_ADDRESS, GRACE_PERIOD_SECONDS } from '../../utils/consts.js'
 import { namehash } from '../../utils/normalise.js'
 import { createSubgraphClient } from './client.js'
 import type { DomainFilter } from './filters.js'
@@ -23,6 +23,8 @@ export type GetSubnamesParameters = {
   searchString?: string
   /** Allows expired names to be included (default: false) */
   allowExpired?: boolean
+  /** Allows deleted names to be included (default: false) */
+  allowDeleted?: boolean
   /** Parameter to order names by (default: name) */
   orderBy?: GetSubnamesOrderBy
   /** Direction to order names in (default: asc) */
@@ -129,6 +131,7 @@ const getSubnames = async (
     name,
     searchString,
     allowExpired = false,
+    allowDeleted = false,
     orderBy = 'name',
     orderDirection = 'asc',
     pageSize = 100,
@@ -161,6 +164,28 @@ const getSubnames = async (
     })
   }
 
+  if (!allowDeleted) {
+    // exclude "deleted" domains
+    // when owner/resolver/registrant = null
+    whereFilters.push({
+      or: [
+        {
+          owner_not: EMPTY_ADDRESS,
+        },
+        {
+          resolver_not: null,
+        },
+        ...(name.toLowerCase() === 'eth'
+          ? [
+              {
+                registrant_not: EMPTY_ADDRESS,
+              },
+            ]
+          : []),
+      ],
+    })
+  }
+
   if (searchString) {
     // using labelName_contains instead of name_contains because name_contains
     // includes the parent name