@ensdomains/ensjs 3.0.0-alpha.3 → 3.0.0-alpha.30

package/src/functions/getExpiry.ts

@@ -1,19 +1,24 @@
 import { BigNumber } from 'ethers'
 import { solidityKeccak256 } from 'ethers/lib/utils'
 import { ENSArgs } from '..'
+import { namehash } from '../utils/normalise'
 
-const raw = async (
-  { contracts, multicallWrapper }: ENSArgs<'contracts' | 'multicallWrapper'>,
-  name: string,
-) => {
-  const baseRegistrar = await contracts?.getBaseRegistrar()!
+type ContractOption = 'registrar' | 'nameWrapper'
 
-  const labels = name.split('.')
+type Args = {
+  contract?: ContractOption
+}
 
+const getRegistrarExpiry = async (
+  { contracts, multicallWrapper }: ENSArgs<'contracts' | 'multicallWrapper'>,
+  labels: string[],
+) => {
   if (labels.length > 2 || labels[1] !== 'eth') {
-    throw new Error('Only .eth names have expiry dates')
+    throw new Error('Only .eth names have expiry dates on the registrar')
   }
 
+  const baseRegistrar = await contracts?.getBaseRegistrar()!
+
   const expiryCall = baseRegistrar.interface.encodeFunctionData('nameExpires', [
     solidityKeccak256(['string'], [labels[0]]),
   ])
@@ -32,11 +37,49 @@ const raw = async (
   ])
 }
 
-const decode = async (
+const getWrapperExpiry = async (
+  { contracts }: ENSArgs<'contracts'>,
+  labels: string[],
+) => {
+  const nameWrapper = await contracts?.getNameWrapper()!
+  const expiryCall = nameWrapper.interface.encodeFunctionData('getData', [
+    namehash(labels.join('.')),
+  ])
+  return {
+    to: nameWrapper.address,
+    data: expiryCall,
+  }
+}
+
+const getContractToUse = (
+  contract: ContractOption | undefined,
+  labels: string[],
+) => {
+  if (contract) return contract
+  if (labels.length === 2 && labels[1] === 'eth') {
+    return 'registrar'
+  }
+  return 'nameWrapper'
+}
+
+const raw = async (
+  ensArgs: ENSArgs<'contracts' | 'multicallWrapper'>,
+  name: string,
+  { contract }: Args = {},
+) => {
+  const labels = name.split('.')
+
+  const contractToUse = getContractToUse(contract, labels)
+
+  return contractToUse === 'nameWrapper'
+    ? getWrapperExpiry(ensArgs, labels)
+    : getRegistrarExpiry(ensArgs, labels)
+}
+
+const decodeRegistrarExpiry = async (
   { contracts, multicallWrapper }: ENSArgs<'contracts' | 'multicallWrapper'>,
   data: string,
 ) => {
-  if (data === null) return
   const result = await multicallWrapper.decode(data)
   const baseRegistrar = await contracts?.getBaseRegistrar()!
   try {
@@ -57,6 +100,41 @@ const decode = async (
   }
 }
 
+const decodeWrapperExpiry = async (
+  { contracts }: ENSArgs<'contracts'>,
+  data: string,
+) => {
+  const nameWrapper = await contracts?.getNameWrapper()!
+  try {
+    const [, , expiry] = nameWrapper.interface.decodeFunctionResult(
+      'getData',
+      data,
+    )
+    return {
+      expiry: new Date(expiry * 1000),
+      gracePeriod: null,
+    }
+  } catch {
+    return
+  }
+}
+
+const decode = async (
+  ensArgs: ENSArgs<'contracts' | 'multicallWrapper'>,
+  data: string,
+  name: string,
+  { contract }: Args = {},
+) => {
+  if (data === null) return
+
+  const labels = name.split('.')
+  const contractToUse = getContractToUse(contract, labels)
+
+  return contractToUse === 'nameWrapper'
+    ? decodeWrapperExpiry(ensArgs, data)
+    : decodeRegistrarExpiry(ensArgs, data)
+}
+
 export default {
   raw,
   decode,

package/src/functions/getHistory.test.ts

@@ -1,22 +1,24 @@
 import { ENS } from '..'
 import setup from '../tests/setup'
 
-let ENSInstance: ENS
+let ensInstance: ENS
+let revert: Awaited<ReturnType<typeof setup>>['revert']
 
 beforeAll(async () => {
-  ;({ ENSInstance } = await setup())
-  jest.setTimeout(20000)
+  ;({ ensInstance, revert } = await setup())
 })
 
-describe('getHistory', () => {
-  let textEventsWithValue: any[]
+afterAll(async () => {
+  await revert()
+})
 
+describe('getHistory', () => {
   it('should return null for a non-existent name', async () => {
-    const result = await ENSInstance.getHistory('test123123cool.eth')
+    const result = await ensInstance.getHistory('test123123cool.eth')
     expect(result).toBeUndefined()
   })
   it('should return the history of a name', async () => {
-    const result = await ENSInstance.getHistory('jefflau.eth')
+    const result = await ensInstance.getHistory('with-profile.eth')
     expect(result).toBeTruthy()
     if (result) {
       expect(result).toHaveProperty('domain')
@@ -24,78 +26,13 @@ describe('getHistory', () => {
       expect(result).toHaveProperty('registration')
     }
   })
-  describe('getHistoryWithDetail', () => {
-    it('should return null for a non-existent name', async () => {
-      const result = await ENSInstance.getHistoryWithDetail(
-        'test123123cool.eth',
-      )
-      expect(result).toBeUndefined()
-    })
-    it('should return the history of a name with TextChanged event detail', async () => {
-      const result = await ENSInstance.getHistoryWithDetail('jefflau.eth')
-      expect(result).toBeTruthy()
-      if (result) {
-        const textEvents = result.resolver.filter(
-          (x) => x.type === 'TextChanged',
-        )
-        textEvents.forEach((event) =>
-          expect(event.data).toHaveProperty('value'),
-        )
-        textEventsWithValue = textEvents
-      }
-    })
-  })
-  describe('getHistoryDetailForTransactionHash', () => {
-    it('should throw an error for an invalid transaction hash', async () => {
-      try {
-        await ENSInstance.getHistoryDetailForTransactionHash('0x234')
-        expect(false).toBeTruthy()
-      } catch (error) {
-        expect((error as any).message).toContain('invalid hash')
-      }
-    })
-    it('should return null for a transaction hash with no text events', async () => {
-      const result = await ENSInstance.getHistoryDetailForTransactionHash(
-        '0x0fd7b555e3076ef38dbbe2e40deefe44c9a0530d43f6b3f60dbed4ba49d229b7',
-      )
-      expect(result).toBeUndefined()
-    })
-    it('should return single item for a given transaction hash with one event', async () => {
-      const eventToUse = textEventsWithValue[0]
-      const result = (await ENSInstance.getHistoryDetailForTransactionHash(
-        eventToUse.transactionHash,
-      )) as { key: any; value: any }[]
-      expect(result).toHaveLength(1)
-      if (result) {
-        expect(result[0]).toMatchObject(eventToUse.data)
-      }
-    })
-    it('should return multiple items for a given transaction hash with multiple events', async () => {
-      const hash =
-        '0x002b7cc3c85168d885a38226a28fac349d13cbaff7f3db4fa3af31f22b863079'
-      const dataArr = [
-        { key: 'description', value: 'Not so super description' },
-        { key: 'url', value: 'facebook.com' },
-      ]
-      const result = (await ENSInstance.getHistoryDetailForTransactionHash(
-        hash,
-      )) as { key: any; value: any }[]
-      expect(result).toHaveLength(dataArr.length)
-      if (result) {
-        result.forEach((item, index) =>
-          expect(item).toMatchObject(dataArr[index]),
-        )
-      }
-    })
-    it('should return a single item when an index is specified for a hash', async () => {
-      const hash =
-        '0x002b7cc3c85168d885a38226a28fac349d13cbaff7f3db4fa3af31f22b863079'
-      const data = { key: 'url', value: 'facebook.com' }
-      const result = (await ENSInstance.getHistoryDetailForTransactionHash(
-        hash,
-        1,
-      )) as { key: any; value: any }
-      expect(result).toMatchObject(data)
-    })
+  it('should return the history of a wrapped name', async () => {
+    const result = await ensInstance.getHistory('wrapped.eth')
+    expect(result).toBeTruthy()
+    if (result) {
+      expect(result).toHaveProperty('domain')
+      expect(result).toHaveProperty('resolver')
+      expect(result).toHaveProperty('registration')
+    }
   })
 })

package/src/functions/getHistory.ts

@@ -2,9 +2,18 @@ import { formatsByCoinType } from '@ensdomains/address-encoder'
 import { ethers } from 'ethers'
 import { ENSArgs } from '..'
 import { decodeContenthash } from '../utils/contentHash'
-import { makeOtherIndexes } from '../utils/makeHashIndexes'
+import { labelhash } from '../utils/labels'
+import { namehash } from '../utils/normalise'
 
-type DomainEvent = 'NewOwner' | 'NewResolver' | 'Transfer' | 'NewTTL'
+type DomainEvent =
+  | 'NewOwner'
+  | 'NewResolver'
+  | 'Transfer'
+  | 'NewTTL'
+  | 'WrappedTransfer'
+  | 'NameWrapped'
+  | 'NameUnwrapped'
+  | 'FusesSet'
 type RegistrationEvent = 'NameRegistered' | 'NameRenewed' | 'NameTransferred'
 type ResolverEvent =
   | 'AddrChanged'
@@ -16,18 +25,31 @@ type ResolverEvent =
   | 'ContenthashChanged'
   | 'InterfaceChanged'
   | 'AuthorisationChanged'
+  | 'VersionChanged'
 
 type EventTypes = 'Domain' | 'Registration' | 'Resolver'
+type EventFormat = {
+  Domain: DomainEvent
+  Registration: RegistrationEvent
+  Resolver: ResolverEvent
+}
 
-const eventFormat: Record<
-  EventTypes,
-  Record<string, (args: any) => Record<string, any>>
-> = {
+const eventFormat: {
+  [key in EventTypes]: { [n in EventFormat[key]]: (args: any) => object }
+} = {
   Domain: {
     NewOwner: (args: any) => ({ owner: args.owner.id }),
     NewResolver: (args: any) => ({ resolver: args.resolver.id.split('-')[0] }),
     Transfer: (args: any) => ({ owner: args.owner.id }),
     NewTTL: (args: any) => ({ ttl: args.ttl }),
+    WrappedTransfer: (args: any) => ({ owner: args.owner.id }),
+    NameWrapped: (args: any) => ({
+      fuses: args.fuses,
+      owner: args.owner.id,
+      expiry: args.expiry,
+    }),
+    NameUnwrapped: (args: any) => ({ owner: args.owner.id }),
+    FusesSet: (args: any) => ({ fuses: args.fuses, expiry: args.expiry }),
   },
   Registration: {
     NameRegistered: (args: any) => ({
@@ -63,7 +85,7 @@ const eventFormat: Record<
     NameChanged: (args: any) => ({ name: args.name }),
     AbiChanged: (args: any) => ({ contentType: args.contentType }),
     PubkeyChanged: (args: any) => ({ x: args.x, y: args.y }),
-    TextChanged: (args: any) => ({ key: args.key }),
+    TextChanged: (args: any) => ({ key: args.key, value: args.value }),
     ContenthashChanged: (args: any) => ({ hash: decodeContenthash(args.hash) }),
     InterfaceChanged: (args: any) => ({
       interfaceId: args.interfaceId,
@@ -74,57 +96,34 @@ const eventFormat: Record<
       target: args.target,
       isAuthorized: args.isAuthorized,
     }),
+    VersionChanged: (args: any) => ({ version: args.version }),
   },
 }
 
-const mapEvents = (eventArray: any[], type: EventTypes) =>
-  eventArray.map((event: any) => ({
-    type: event.__typename,
-    blockNumber: event.blockNumber,
-    transactionHash: event.transactionID,
-    id: event.id,
-    data: eventFormat[type][event.__typename](event),
-  }))
-
-const mapResultDetailDecode =
-  (publicResolver: ethers.Contract) => (result: any) => {
-    const hashIndexes = makeOtherIndexes(result.input, '10f13a8c')
-    const abiLengths = hashIndexes.map((x: number) => ({
-      index: x,
-      length:
-        x === 0
-          ? ethers.utils.hexDataLength(result.input)
-          : parseInt(ethers.utils.hexDataSlice(result.input, x - 32, x), 16),
-    }))
-    const ABIs = abiLengths.map(({ index, length }) =>
-      ethers.utils.hexDataSlice(result.input, index, index + length),
-    )
-    return ABIs.map((abi: string) => {
-      try {
-        return publicResolver.interface.decodeFunctionData(
-          'setText(bytes32,string,string)',
-          abi,
-        )
-      } catch {
-        return
-      }
-    })
-  }
-
-const expandDecode = (prev: any, curr: any) => {
-  if (!curr) return [...prev, { value: null }]
-  if (!curr.length) return [...prev, curr]
-  return [...prev, ...curr]
-}
+const mapEvents = <T extends EventTypes>(eventArray: any[], type: T) =>
+  eventArray.map(
+    (event: {
+      __typename: EventFormat[T]
+      blockNumber: number
+      transactionID: string
+      id: string
+    }) => ({
+      type: event.__typename,
+      blockNumber: event.blockNumber,
+      transactionHash: event.transactionID,
+      id: event.id,
+      data: eventFormat[type][event.__typename](event),
+    }),
+  )
 
 export async function getHistory(
   { gqlInstance }: ENSArgs<'gqlInstance'>,
   name: string,
 ) {
-  const client = gqlInstance.client
+  const { client } = gqlInstance
   const query = gqlInstance.gql`
-      query getHistory($name: String!, $label: String!) {
-        domains(where: { name: $name }) {
+      query getHistory($namehash: String!, $labelhash: String!) {
+        domain(id: $namehash) {
           events {
             id
             blockNumber
@@ -148,27 +147,46 @@ export async function getHistory(
             ...on NewTTL {
               ttl
             }
-          }
-          owner {
-            registrations (where: { labelName: $label }) {
-              events {
+            ...on WrappedTransfer {
+              owner {
                 id
-                blockNumber
-                transactionID
-                __typename
-                ...on NameRegistered {
-                  registrant {
-                    id
-                  }
-                  expiryDate
-                }
-                ...on NameRenewed {
-                  expiryDate
+              }
+            }
+            ...on NameWrapped {
+              fuses
+              expiry
+              owner {
+                id
+              }
+            }
+            ...on NameUnwrapped {
+              owner {
+                id
+              }
+            }
+            ...on FusesSet {
+              fuses
+              expiry
+            }
+          }
+          registration {
+            events {
+              id
+              blockNumber
+              transactionID
+              __typename
+              ...on NameRegistered {
+                registrant {
+                  id
                 }
-                ...on NameTransferred {
-                  newOwner {
-                    id
-                  }
+                expiryDate
+              }
+              ...on NameRenewed {
+                expiryDate
+              }
+              ...on NameTransferred {
+                newOwner {
+                  id
                 }
               }
             }
@@ -200,6 +218,7 @@ export async function getHistory(
               }
               ...on TextChanged {
                 key
+                value
               }
               ...on ContenthashChanged {
                 hash
@@ -213,6 +232,9 @@ export async function getHistory(
                 target
                 isAuthorized
               }
+              ...on VersionChanged {
+                version
+              }
             }
           }
         }
@@ -221,23 +243,25 @@ export async function getHistory(
 
   const label = name.split('.')[0]
 
-  const { domains } = await client.request(query, { name, label })
+  const nameHash = namehash(name)
+  const labelHash = labelhash(label)
 
-  if (!domains || domains.length === 0) return
+  const { domain } = await client.request(query, {
+    namehash: nameHash,
+    labelhash: labelHash,
+  })
 
-  const [
-    {
-      events: domainEvents,
-      owner: {
-        registrations: [{ events: registrationEvents }],
-      },
-      resolver: { events: resolverEvents },
-    },
-  ] = domains
+  if (!domain) return
+
+  const {
+    events: domainEvents,
+    registration: { events: registrationEvents },
+    resolver: { events: resolverEvents },
+  } = domain
 
   const domainHistory = mapEvents(domainEvents, 'Domain')
   const registrationHistory = mapEvents(registrationEvents, 'Registration')
-  let resolverHistory = mapEvents(
+  const resolverHistory = mapEvents(
     // remove duplicate events for ETH cointype
     resolverEvents.filter(
       (event: any) => !event.coinType || event.coinType !== '60',
@@ -251,97 +275,3 @@ export async function getHistory(
     resolver: resolverHistory,
   }
 }
-
-export async function getHistoryWithDetail(
-  {
-    contracts,
-    gqlInstance,
-    provider,
-  }: ENSArgs<'contracts' | 'gqlInstance' | 'provider'>,
-  name: string,
-) {
-  const historyRes = await getHistory({ gqlInstance }, name)
-
-  if (!historyRes) return
-
-  const { domain, registration, resolver: resolverHistory } = historyRes
-
-  const textEvents = resolverHistory.filter(
-    (event) => event.type === 'TextChanged',
-  )
-
-  const transactions = textEvents.reduce((prev, curr) => {
-    if (prev.includes(curr.transactionHash)) {
-      return prev
-    }
-    return [...prev, curr.transactionHash]
-  }, [] as string[])
-
-  const publicResolver = await contracts?.getPublicResolver()!
-
-  const fetchResult = (
-    await ethers.utils.fetchJson(
-      provider!.connection,
-      JSON.stringify(
-        transactions.map((tx, i) => ({
-          jsonrpc: '2.0',
-          id: i,
-          method: 'eth_getTransactionByHash',
-          params: [tx],
-        })),
-      ),
-    )
-  )
-    .map((result: any) => result.result)
-    .map(mapResultDetailDecode(publicResolver))
-    .reduce(expandDecode, [])
-
-  const detailedResolverHistory = resolverHistory.map((event) => {
-    if (event.type !== 'TextChanged') return event
-    const { id } = event
-    const matchedTextInx = textEvents.findIndex((x) => x.id === id)
-    return {
-      ...event,
-      data: {
-        ...event.data,
-        value: fetchResult[matchedTextInx] && fetchResult[matchedTextInx].value,
-      },
-    }
-  })
-
-  return {
-    domain,
-    registration,
-    resolver: detailedResolverHistory,
-  }
-}
-
-export async function getHistoryDetailForTransactionHash(
-  { contracts, provider }: ENSArgs<'contracts' | 'provider'>,
-  hash: string,
-  indexInTransaction?: number,
-) {
-  const publicResolver = await contracts?.getPublicResolver()!
-  const transaction = await provider!.getTransaction(hash)
-  if (!transaction) return
-  const result = mapResultDetailDecode(publicResolver)({
-    input: transaction.data,
-  })
-  if (!result || !result.length) return
-  if (typeof indexInTransaction === 'number') {
-    if (indexInTransaction + 1 > result.length) return
-    const resultItem = result[indexInTransaction]
-    if (
-      !resultItem ||
-      !resultItem.key ||
-      (!resultItem.value && resultItem.value !== '')
-    )
-      return
-    return { key: resultItem.key, value: resultItem.value }
-  }
-  return result.map((item: any) => {
-    if (!item.key) return
-    if (!item.value && item.value !== '') return { key: item.key, value: null }
-    return { key: item.key, value: item.value }
-  })
-}

package/src/functions/getName.test.ts

@@ -2,13 +2,13 @@ import { ethers } from 'ethers'
 import { ENS } from '..'
 import setup from '../tests/setup'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
 let provider: ethers.providers.JsonRpcProvider
 let accounts: string[]
 
 beforeAll(async () => {
-  ;({ ENSInstance, revert, provider } = await setup())
+  ;({ ensInstance, revert, provider } = await setup())
   accounts = await provider.listAccounts()
 })
 
@@ -18,29 +18,29 @@ afterAll(async () => {
 
 describe('getName', () => {
   it('should get a primary name from an address', async () => {
-    const result = await ENSInstance.getName(
-      '0x866B3c4994e1416B7C738B9818b31dC246b95eEE',
+    const result = await ensInstance.getName(
+      '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
     )
     expect(result).toBeTruthy()
     if (result) {
-      expect(result.name).toBe('jefflau.eth')
+      expect(result.name).toBe('with-profile.eth')
       expect(result.match).toBeTruthy()
     }
   })
   it('should return null for an address with no primary name', async () => {
-    const result = await ENSInstance.getName(
+    const result = await ensInstance.getName(
       '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0',
     )
-    expect(result).toBeUndefined()
+    expect(result?.name).toBeUndefined()
   })
   it('should return with a false match for a name with no forward resolution', async () => {
-    const tx = await ENSInstance.setName('jefflau.eth')
+    const tx = await ensInstance.setName('with-profile.eth')
     await tx?.wait()
 
-    const result = await ENSInstance.getName(accounts[0])
+    const result = await ensInstance.getName(accounts[0])
     expect(result).toBeTruthy()
     if (result) {
-      expect(result.name).toBe('jefflau.eth')
+      expect(result.name).toBe('with-profile.eth')
       expect(result.match).toBeFalsy()
     }
   })

package/src/functions/getName.ts

@@ -3,10 +3,10 @@ import { hexEncodeName } from '../utils/hexEncodedName'
 
 const raw = async ({ contracts }: ENSArgs<'contracts'>, address: string) => {
   const universalResolver = await contracts?.getUniversalResolver()!
-  const reverseNode = address.toLowerCase().substring(2) + '.addr.reverse'
+  const reverseNode = `${address.toLowerCase().substring(2)}.addr.reverse`
   return {
     to: universalResolver.address,
-    data: universalResolver.interface.encodeFunctionData('reverse', [
+    data: universalResolver.interface.encodeFunctionData('reverse(bytes)', [
       hexEncodeName(reverseNode),
     ]),
   }
@@ -21,7 +21,7 @@ const decode = async (
   const universalResolver = await contracts?.getUniversalResolver()!
   try {
     const result = universalResolver.interface.decodeFunctionResult(
-      'reverse',
+      'reverse(bytes)',
       data,
     )
     return {
@@ -31,7 +31,7 @@ const decode = async (
       resolverAddress: result['3'],
     }
   } catch {
-    return { name: null, match: false }
+    return { name: undefined }
   }
 }