@ensdomains/ensjs 3.0.0-alpha.6 → 3.0.0-alpha.61

package/src/functions/getNames.test.ts

@@ -1,11 +1,17 @@
+/* eslint-disable no-await-in-loop */
+import { ethers } from 'ethers'
 import { ENS } from '..'
-import { OwnedName, Registration } from '../functions/getNames'
 import setup from '../tests/setup'
+import { Name } from './getNames'
+import { names as wrappedNames } from '../../deploy/00_register_wrapped'
 
-let ENSInstance: ENS
+let ensInstance: ENS
+let provider: ethers.providers.JsonRpcProvider
+let accounts: string[]
 
 beforeAll(async () => {
-  ;({ ENSInstance } = await setup())
+  ;({ ensInstance, provider } = await setup())
+  accounts = await provider.listAccounts()
 })
 
 const testProperties = (obj: object, ...properties: string[]) =>
@@ -14,12 +20,45 @@ const testProperties = (obj: object, ...properties: string[]) =>
 const testNotProperties = (obj: object, ...properties: string[]) =>
   properties.map((property) => expect(obj).not.toHaveProperty(property))
 
+const letterItems = [
+  'w',
+  '9',
+  '8',
+  '7',
+  '6',
+  '5',
+  '4',
+  ...Array(5).fill('3'),
+  ...Array(11).fill('2'),
+  ...Array(11).fill('1'),
+  '0',
+]
+
+const domainLetterItems = [
+  ...Array(3).fill('['),
+  'x',
+  'w',
+  't',
+  'l',
+  'a',
+  '9',
+  '8',
+  '7',
+  '6',
+  '5',
+  '4',
+  ...Array(5).fill('3'),
+  ...Array(11).fill('2'),
+  ...Array(11).fill('1'),
+  '0',
+]
+
 describe('getNames', () => {
   let totalRegistrations: number = 0
   let totalOwnedNames: number = 0
   it('should get the registrations for an address', async () => {
-    const result = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const result = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'registrant',
     })
     totalRegistrations = result.length
@@ -38,8 +77,8 @@ describe('getNames', () => {
     )
   })
   it('should get the owned names for an address', async () => {
-    const result = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const result = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'owner',
     })
     totalOwnedNames = result.length
@@ -56,191 +95,298 @@ describe('getNames', () => {
     )
     testNotProperties(result[0], 'expiryDate', 'registrationDate')
   })
+  it('should get wrapped domains for an address', async () => {
+    const result = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+      type: 'wrappedOwner',
+    })
+    expect(result).toBeTruthy()
+    testProperties(
+      result[0],
+      'id',
+      'labelName',
+      'labelhash',
+      'name',
+      'isMigrated',
+      'parent',
+      'truncatedName',
+      'expiryDate',
+      'fuses',
+    )
+  })
   it('should get the registrations for an address with pagination', async () => {
-    const pageOne = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageOne = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'registrant',
       page: 0,
     })
     expect(pageOne).toHaveLength(10)
-    const pageTwo = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageTwo = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'registrant',
       page: 1,
     })
-    expect(pageTwo).toHaveLength(totalRegistrations % 10)
+    expect(pageTwo).toHaveLength(10)
+    const pageThree = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+      type: 'registrant',
+      page: 2,
+    })
+    expect(pageThree).toHaveLength(10)
+    const pageFour = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+      type: 'registrant',
+      page: 3,
+    })
+    expect(pageFour).toHaveLength(totalRegistrations % 10)
   })
   it('should get the owned names for an address with pagination', async () => {
-    const pageOne = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageOne = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'owner',
       page: 0,
     })
     expect(pageOne).toHaveLength(10)
-    const pageTwo = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageTwo = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'owner',
       page: 1,
     })
     expect(pageTwo).toHaveLength(10)
-    const pageThree = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageThree = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'owner',
       page: 2,
     })
     expect(pageThree).toHaveLength(10)
-    const pageFour = await ENSInstance.getNames({
-      address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const pageFour = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       type: 'owner',
       page: 3,
     })
-    expect(pageFour).toHaveLength(totalOwnedNames % 10)
+    expect(pageFour).toHaveLength(10)
+    const pageFive = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+      type: 'owner',
+      page: 4,
+    })
+    expect(pageFive).toHaveLength(totalOwnedNames % 10)
+  })
+  it('should get wrapped domains for an address with pagination, and filter out pcc expired names', async () => {
+    const pageOne = await ensInstance.getNames({
+      address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
+      type: 'wrappedOwner',
+      page: 0,
+    })
+
+    const nameCout = wrappedNames.reduce<number>((count, name) => {
+      if (name.namedOwner === 'owner2') count += 1
+      ;(name.subnames || []).forEach((subname: any) => {
+        if (subname.namedOwner === 'owner2') count += 1
+      })
+      return count
+    }, 0)
+
+    // length of page one should be all the names on 0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC
+    // minus 1 for the PCC expired name.
+    // the result here implies that the PCC expired name is not returned
+    expect(pageOne).toHaveLength(nameCout - 1)
+  })
+
+  describe('resolved addresses', () => {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    const RESOLVED_ADDRESS_COUNT: { [key: string]: number } = {
+      '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266': 2,
+      '0x70997970C51812dc3A010C7d01b50e0d17dc79C8': 16,
+      '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC': 35,
+    }
+    /* eslint-enable @typescript-eslint/naming-convention */
+
+    it('should get the names that resolve to an address by labelName', async () => {
+      const ADDRESSES = [accounts[0], accounts[1], accounts[2]]
+      for (const ADDRESS of ADDRESSES) {
+        const pageOne = await ensInstance.getNames({
+          address: ADDRESS,
+          type: 'resolvedAddress',
+          orderBy: 'labelName',
+          orderDirection: 'asc',
+        })
+        expect(pageOne.length).toBe(RESOLVED_ADDRESS_COUNT[ADDRESS])
+        let prevLabelName = pageOne[0].labelName
+        for (const name of pageOne) {
+          expect(
+            !!name.labelName &&
+              prevLabelName &&
+              name.labelName >= prevLabelName,
+          ).toBe(true)
+          prevLabelName = name.labelName
+          const profile = await ensInstance.getProfile(name.name)
+          const eth = profile?.records?.coinTypes?.find(
+            (coin) => coin.coin === 'ETH',
+          )
+          expect((eth as any).addr).toBe(ADDRESS)
+        }
+      }
+    })
+
+    it('should get the names that resolve to an address by creationDate', async () => {
+      const ADDRESSES = [accounts[0], accounts[1], accounts[2]]
+      for (const ADDRESS of ADDRESSES) {
+        const pageOne = await ensInstance.getNames({
+          address: ADDRESS,
+          type: 'resolvedAddress',
+          orderBy: 'createdAt',
+          orderDirection: 'desc',
+        })
+        expect(pageOne.length).toBe(RESOLVED_ADDRESS_COUNT[ADDRESS])
+        let prevCreatedAt = pageOne[0].createdAt?.getTime()
+        for (const name of pageOne) {
+          expect(
+            !!name.createdAt &&
+              !!prevCreatedAt &&
+              name.createdAt.getTime() <= prevCreatedAt,
+          ).toBe(true)
+          prevCreatedAt = name.createdAt?.getTime()
+          const profile = await ensInstance.getProfile(name.name)
+          const eth = profile?.records?.coinTypes?.find(
+            (coin) => coin.coin === 'ETH',
+          )
+          expect((eth as any).addr).toBe(ADDRESS)
+        }
+      }
+    })
   })
   describe('orderBy', () => {
     describe('registrations', () => {
       it('descending registrationDate', async () => {
-        const registrationDateOrderedDesc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const registrationDateOrderedDesc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'registrationDate',
           orderDirection: 'desc',
-        })) as Registration[]
+        })) as Name[]
         registrationDateOrderedDesc.reduce((prev, curr) => {
-          expect(prev.registrationDate.getTime()).toBeGreaterThanOrEqual(
-            curr.registrationDate.getTime(),
+          expect(prev.registrationDate!.getTime()).toBeGreaterThanOrEqual(
+            curr.registrationDate!.getTime(),
           )
           return curr
         })
       })
       it('ascending registrationDate', async () => {
-        const registrationDateOrderedAsc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const registrationDateOrderedAsc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'registrationDate',
           orderDirection: 'asc',
-        })) as Registration[]
+        })) as Name[]
         registrationDateOrderedAsc.reduce((prev, curr) => {
-          expect(prev.registrationDate.getTime()).toBeLessThanOrEqual(
-            curr.registrationDate.getTime(),
+          expect(prev.registrationDate!.getTime()).toBeLessThanOrEqual(
+            curr.registrationDate!.getTime(),
           )
           return curr
         })
       })
       it('descending expiryDate', async () => {
-        const expiryDateOrderedDesc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const expiryDateOrderedDesc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'expiryDate',
           orderDirection: 'desc',
-        })) as Registration[]
+        })) as Name[]
         expiryDateOrderedDesc.reduce((prev, curr) => {
-          expect(prev.expiryDate.getTime()).toBeGreaterThanOrEqual(
-            curr.expiryDate.getTime(),
+          expect(prev.expiryDate!.getTime()).toBeGreaterThanOrEqual(
+            curr.expiryDate!.getTime(),
           )
           return curr
         })
       })
       it('ascending expiryDate', async () => {
-        const expiryDateOrderedAsc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const expiryDateOrderedAsc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'expiryDate',
           orderDirection: 'asc',
-        })) as Registration[]
+        })) as Name[]
         expiryDateOrderedAsc.reduce((prev, curr) => {
-          expect(prev.expiryDate.getTime()).toBeLessThanOrEqual(
-            curr.expiryDate.getTime(),
+          expect(prev.expiryDate!.getTime()).toBeLessThanOrEqual(
+            curr.expiryDate!.getTime(),
           )
           return curr
         })
       })
       it('descending labelName', async () => {
-        const labelNameOrderedDesc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const labelNameOrderedDesc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'labelName',
           orderDirection: 'desc',
-        })) as Registration[]
-        labelNameOrderedDesc.reduce((prev, curr) => {
-          expect((prev.labelName || '') > (curr.labelName || '')).toBeTruthy()
-          return curr
-        })
+        })) as Name[]
+        expect(labelNameOrderedDesc.map((n) => n.labelName![0])).toStrictEqual(
+          letterItems,
+        )
       })
       it('ascending labelName', async () => {
-        const labelNameOrderedAsc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const labelNameOrderedAsc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'registrant',
           orderBy: 'labelName',
           orderDirection: 'asc',
-        })) as Registration[]
-        labelNameOrderedAsc.reduce((prev, curr) => {
-          expect((prev.labelName || '') < (curr.labelName || '')).toBeTruthy()
-          return curr
-        })
+        })) as Name[]
+        expect(labelNameOrderedAsc.map((n) => n.labelName![0])).toStrictEqual(
+          letterItems.reverse(),
+        )
       })
     })
     describe('owned names', () => {
       it('descending createdAt', async () => {
-        const createdAtOrderedDesc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const createdAtOrderedDesc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'owner',
           orderBy: 'createdAt',
           orderDirection: 'desc',
-        })) as OwnedName[]
+        })) as Name[]
         createdAtOrderedDesc.reduce((prev, curr) => {
-          expect(prev.createdAt.getTime()).toBeGreaterThanOrEqual(
-            curr.createdAt.getTime(),
+          expect(prev.createdAt!.getTime()).toBeGreaterThanOrEqual(
+            curr.createdAt!.getTime(),
           )
           return curr
         })
       })
       it('ascending createdAt', async () => {
-        const createdAtOrderedAsc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const createdAtOrderedAsc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'owner',
           orderBy: 'createdAt',
           orderDirection: 'asc',
-        })) as OwnedName[]
+        })) as Name[]
         createdAtOrderedAsc.reduce((prev, curr) => {
-          expect(prev.createdAt.getTime()).toBeLessThanOrEqual(
-            curr.createdAt.getTime(),
+          expect(prev.createdAt!.getTime()).toBeLessThanOrEqual(
+            curr.createdAt!.getTime(),
           )
           return curr
         })
       })
       it('descending labelName', async () => {
-        const labelNameOrderedDesc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const labelNameOrderedDesc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'owner',
           orderBy: 'labelName',
           orderDirection: 'desc',
-        })) as Registration[]
-        labelNameOrderedDesc.reduce((prev, curr) => {
-          if (
-            (!prev.labelName && !curr.labelName) ||
-            (!prev.labelName && curr.labelName)
-          )
-            return curr
-          expect((prev.labelName || '') > (curr.labelName || '')).toBeTruthy()
-          return curr
-        })
+        })) as Name[]
+        expect(labelNameOrderedDesc.map((n) => n.name[0])).toStrictEqual(
+          domainLetterItems,
+        )
       })
       it('ascending labelName', async () => {
-        const labelNameOrderedAsc = (await ENSInstance.getNames({
-          address: '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+        const labelNameOrderedAsc = (await ensInstance.getNames({
+          address: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
           type: 'owner',
           orderBy: 'labelName',
           orderDirection: 'asc',
-        })) as Registration[]
-        labelNameOrderedAsc.reduce((prev, curr) => {
-          if (
-            (!prev.labelName && !curr.labelName) ||
-            (prev.labelName && !curr.labelName)
-          )
-            return curr
-          expect((prev.labelName || '') < (curr.labelName || '')).toBeTruthy()
-          return curr
-        })
+        })) as Name[]
+        expect(labelNameOrderedAsc.map((n) => n.name[0])).toStrictEqual(
+          domainLetterItems.reverse(),
+        )
       })
     })
   })