@ensdomains/ensjs 3.0.0-alpha.21 → 3.0.0-alpha.23

package/src/functions/createSubname.ts

@@ -3,7 +3,7 @@ import { ENSArgs } from '..'
 import { FuseOptions } from '../@types/FuseOptions'
 import generateFuseInput from '../utils/generateFuseInput'
 import { namehash } from '../utils/normalise'
-import { Expiry, makeExpiry } from '../utils/wrapperExpiry'
+import { Expiry, makeExpiry, wrappedLabelLengthCheck } from '../utils/wrapper'
 
 type BaseArgs = {
   owner: string
@@ -59,6 +59,7 @@ export default async function (
       )
     }
     case 'nameWrapper': {
+      wrappedLabelLengthCheck(label)
       const nameWrapper = (await contracts!.getNameWrapper()!).connect(signer)
       const expiry: BigNumber = await makeExpiry(
         { getExpiry },

package/src/functions/getHistory.ts

@@ -2,6 +2,8 @@ import { formatsByCoinType } from '@ensdomains/address-encoder'
 import { ethers } from 'ethers'
 import { ENSArgs } from '..'
 import { decodeContenthash } from '../utils/contentHash'
+import { labelhash } from '../utils/labels'
+import { namehash } from '../utils/normalise'
 
 type DomainEvent = 'NewOwner' | 'NewResolver' | 'Transfer' | 'NewTTL'
 type RegistrationEvent = 'NameRegistered' | 'NameRenewed' | 'NameTransferred'
@@ -102,8 +104,8 @@ export async function getHistory(
 ) {
   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
@@ -129,7 +131,7 @@ export async function getHistory(
             }
           }
           owner {
-            registrations (where: { labelName: $label }) {
+            registrations (where: { id: $labelhash }) {
               events {
                 id
                 blockNumber
@@ -201,19 +203,23 @@ 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 },
+  if (!domain) return
+
+  const {
+    events: domainEvents,
+    owner: {
+      registrations: [{ events: registrationEvents }],
     },
-  ] = domains
+    resolver: { events: resolverEvents },
+  } = domain
 
   const domainHistory = mapEvents(domainEvents, 'Domain')
   const registrationHistory = mapEvents(registrationEvents, 'Registration')

package/src/functions/getNames.test.ts

@@ -33,7 +33,6 @@ const domainLetterItems = [
   'x',
   'w',
   't',
-  't',
   'l',
   'a',
   '9',

package/src/functions/getNames.ts

@@ -76,7 +76,7 @@ const getNames = async (
     page,
     pageSize = 10,
     orderDirection,
-    orderBy,
+    orderBy = 'labelName',
   }: Params,
 ) => {
   const address = _address.toLowerCase()

package/src/functions/getPrice.test.ts

@@ -1,3 +1,4 @@
+import { BigNumber } from 'ethers'
 import { ENS } from '..'
 import setup from '../tests/setup'
 
@@ -7,14 +8,16 @@ beforeAll(async () => {
   ;({ ensInstance } = await setup())
 })
 
+const yearCost = BigNumber.from('8561643835626')
+
 describe('getPrice', () => {
-  it('should return a base and premium price for an address', async () => {
+  it('should return a base and premium price for a name', async () => {
     const { base, premium } = (await ensInstance.getPrice(
       'test123',
       86400,
       false,
     ))!
-    expect(base.toNumber()).toBe(86400)
+    expect(base.eq(yearCost)).toBe(true)
     expect(premium.toNumber()).toBe(0)
   })
 
@@ -24,18 +27,18 @@ describe('getPrice', () => {
       86400,
       false,
     ))!
-    expect(base.toNumber()).toBe(86400 * 2)
+    expect(base.eq(yearCost.mul(2))).toBe(true)
     expect(premium.toNumber()).toBe(0)
   })
 
   describe('legacy mode', () => {
-    it('should return a base and premium price for an address', async () => {
+    it('should return a base and premium price for a name', async () => {
       const { base, premium } = (await ensInstance.getPrice(
         'test123',
         86400,
         true,
       ))!
-      expect(base.toNumber()).toBe(86400)
+      expect(base.eq(yearCost)).toBe(true)
       expect(premium.toNumber()).toBe(0)
     })
 
@@ -45,7 +48,7 @@ describe('getPrice', () => {
         86400,
         true,
       ))!
-      expect(base.toNumber()).toBe(86400 * 2)
+      expect(base.eq(yearCost.mul(2))).toBe(true)
       expect(premium.toNumber()).toBe(0)
     })
   })

package/src/functions/getProfile.test.ts

@@ -1,7 +1,7 @@
-import { ethers } from 'ethers'
 import dotenv from 'dotenv'
+import { ethers } from 'ethers'
 import { ENS } from '..'
-import setup from '../tests/setup'
+import setup, { deploymentAddresses } from '../tests/setup'
 
 dotenv.config()
 
@@ -29,7 +29,7 @@ const checkRecords = (
     expect(result.records?.texts).toHaveLength(textLength)
     expect(result.records?.coinTypes).toHaveLength(coinTypeLength)
     expect(result.resolverAddress).toBe(
-      '0x1613beB3B2C4f22Ee086B2b38C1476A3cE7f78E8',
+      deploymentAddresses.LegacyPublicResolver,
     )
   }
 }
@@ -107,12 +107,12 @@ describe('getProfile', () => {
       })
       await tx.wait()
       const result = await ensInstance.getProfile('test123.eth', {
-        resolverAddress: '0x1613beB3B2C4f22Ee086B2b38C1476A3cE7f78E8',
+        resolverAddress: deploymentAddresses.LegacyPublicResolver,
       })
       expect(result).toBeDefined()
       expect(result?.address).toBe(accounts[1])
       expect(result?.resolverAddress).toBe(
-        '0x1613beB3B2C4f22Ee086B2b38C1476A3cE7f78E8',
+        deploymentAddresses.LegacyPublicResolver,
       )
     })
     it('should return undefined for an unregistered name', async () => {
@@ -123,7 +123,6 @@ describe('getProfile', () => {
   describe('with an old resolver', () => {
     it('should use fallback methods for a name with an older resolver (no multicall)', async () => {
       const result = await ensInstance.getProfile('with-legacy-resolver.eth')
-      const deploymentAddresses = JSON.parse(process.env.DEPLOYMENT_ADDRESSES!)
       expect(result).toBeDefined()
       if (result) {
         expect(result.address).toBe(

package/src/functions/getResolver.test.ts

@@ -1,5 +1,5 @@
 import { ENS } from '..'
-import setup from '../tests/setup'
+import setup, { deploymentAddresses } from '../tests/setup'
 
 let ensInstance: ENS
 
@@ -10,6 +10,6 @@ beforeAll(async () => {
 describe('getResolver', () => {
   it('should find the resolver for a name with a resolver', async () => {
     const result = await ensInstance.getResolver('with-profile.eth')
-    expect(result).toBe('0x1613beB3B2C4f22Ee086B2b38C1476A3cE7f78E8')
+    expect(result).toBe(deploymentAddresses.LegacyPublicResolver)
   })
 })

package/src/functions/{getFuses.test.ts → getWrapperData.test.ts}

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers'
-import { ENS } from '..'
+import { ENS } from '../index'
 import setup from '../tests/setup'
 
 let ensInstance: ENS
@@ -38,15 +38,17 @@ afterAll(async () => {
   await revert()
 })
 
-describe('getFuses', () => {
+describe('getWrapperData', () => {
   it('should return default data for an unwrapped name', async () => {
-    const result = await ensInstance.getFuses('with-profile.eth')
+    const result = await ensInstance.getWrapperData('with-profile.eth')
     expect({ ...result, expiryDate: result?.expiryDate.toString() }).toEqual(
       unwrappedNameDefault,
     )
   })
   it('should return with CAN_DO_EVERYTHING set to true for a name with no fuses burned', async () => {
-    const result = await ensInstance.getFuses('test.wrapped-with-subnames.eth')
+    const result = await ensInstance.getWrapperData(
+      'test.wrapped-with-subnames.eth',
+    )
     expect(result).toBeTruthy()
     if (result) {
       expect(result.fuseObj.CAN_DO_EVERYTHING).toBe(true)
@@ -70,7 +72,7 @@ describe('getFuses', () => {
     })
     await tx.wait()
 
-    const result = await ensInstance.getFuses('wrapped.eth')
+    const result = await ensInstance.getWrapperData('wrapped.eth')
     expect(result).toBeTruthy()
     if (result) {
       expect(result.fuseObj).toMatchObject({
@@ -87,7 +89,7 @@ describe('getFuses', () => {
     }
   })
   it('should return correct expiry', async () => {
-    const result = await ensInstance.getFuses('wrapped.eth')
+    const result = await ensInstance.getWrapperData('wrapped.eth')
     expect(result).toBeTruthy()
     if (result) {
       expect(result.expiryDate).toBeInstanceOf(Date)

package/src/functions/{getFuses.ts → getWrapperData.ts}

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers'
-import { ENSArgs } from '..'
+import { ENSArgs } from '../index'
 import { CurrentFuses, fuseEnum } from '../utils/fuses'
 import { namehash } from '../utils/normalise'
 
@@ -14,11 +14,10 @@ const raw = async ({ contracts }: ENSArgs<'contracts'>, name: string) => {
 const decode = async ({ contracts }: ENSArgs<'contracts'>, data: string) => {
   const nameWrapper = await contracts?.getNameWrapper()!
   try {
-    const {
-      owner,
-      fuses: _fuses,
-      expiry,
-    } = nameWrapper.interface.decodeFunctionResult('getData', data)
+    const [owner, _fuses, expiry] = nameWrapper.interface.decodeFunctionResult(
+      'getData',
+      data,
+    )
 
     const fuses = BigNumber.from(_fuses)
 
@@ -44,7 +43,7 @@ const decode = async ({ contracts }: ENSArgs<'contracts'>, data: string) => {
       owner,
     }
   } catch (e) {
-    console.error('Error decoding fuses data: ', e)
+    console.error('Error decoding wrapper data: ', e)
     return
   }
 }

package/src/functions/registerName.ts

@@ -1,14 +1,12 @@
 import { BigNumber } from 'ethers'
 import { ENSArgs } from '..'
 import {
-  CommitmentParams,
+  BaseRegistrationParams,
   makeRegistrationData,
 } from '../utils/registerHelpers'
+import { wrappedLabelLengthCheck } from '../utils/wrapper'
 
-type Params = Omit<CommitmentParams, 'name' | 'resolver'> & {
-  resolverAddress?: string
-  secret: string
-  wrapperExpiry: number
+type Params = BaseRegistrationParams & {
   value: BigNumber
 }
 
@@ -21,6 +19,8 @@ export default async function (
   if (labels.length !== 2 || labels[1] !== 'eth')
     throw new Error('Currently only .eth TLD registrations are supported')
 
+  wrappedLabelLengthCheck(labels[0])
+
   const controller = await contracts!.getEthRegistrarController()
   const _resolver = await contracts!.getPublicResolver(
     undefined,

package/src/functions/renewNames.test.ts

@@ -34,7 +34,7 @@ describe('renewNames', () => {
     const tx = await ensInstance.renewNames(name, {
       value: price.mul(2),
       duration,
-      addressOrIndex: accounts[1],
+      addressOrIndex: accounts[0],
     })
     await tx.wait()
 
@@ -48,8 +48,8 @@ describe('renewNames', () => {
     const duration = 31536000
     const baseRegistrar = await ensInstance.contracts!.getBaseRegistrar()!
     const oldExpiry = await baseRegistrar.nameExpires(labelhash(label))
-    const controller = await ensInstance.contracts!.getEthRegistrarController()!
-    const [price] = await controller.rentPrice(label, duration)
+    const bulkRenewal = await ensInstance.contracts!.getBulkRenewal()!
+    const price = await bulkRenewal.rentPrice(names, duration)
 
     const tx = await ensInstance.renewNames(names, {
       value: price.mul(4),

package/src/functions/renewNames.ts

@@ -1,16 +1,46 @@
-import { BigNumber } from 'ethers'
+import { BigNumber, BigNumberish } from 'ethers'
 import { ENSArgs } from '..'
+import { FuseProps, validateFuses } from '../utils/fuses'
+import { MAX_INT_64 } from '../utils/registerHelpers'
 
-export default async function (
+type BaseProps = {
+  duration: number
+  value: BigNumber
+}
+
+export async function renewNameWithData(
   { contracts }: ENSArgs<'contracts'>,
-  nameOrNames: string | string[],
+  name: string,
   {
     duration,
     value,
-  }: {
-    duration: number
-    value: BigNumber
+    fuses,
+    wrapperExpiry = MAX_INT_64,
+  }: BaseProps & {
+    fuses?: FuseProps
+    wrapperExpiry?: BigNumberish
   },
+) {
+  const labels = name.split('.')
+  if (labels.length !== 2 || labels[1] !== 'eth') {
+    throw new Error('Currently only .eth TLD renewals are supported')
+  }
+
+  const encodedFuses = fuses ? validateFuses(fuses) : 0
+  const controller = await contracts!.getEthRegistrarController()
+  return controller.populateTransaction.renewWithFuses(
+    labels[0],
+    duration,
+    encodedFuses,
+    wrapperExpiry,
+    { value },
+  )
+}
+
+export default async function (
+  { contracts }: ENSArgs<'contracts'>,
+  nameOrNames: string | string[],
+  { duration, value }: BaseProps,
 ) {
   const names = Array.isArray(nameOrNames) ? nameOrNames : [nameOrNames]
   const labels = names.map((name) => {

package/src/functions/transferController.ts

@@ -0,0 +1,28 @@
+import { ethers } from 'ethers'
+import { ENSArgs } from '..'
+
+export default async function (
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
+  name: string,
+  {
+    newOwner,
+    isOwner,
+  }: {
+    newOwner: string
+    isOwner: boolean
+  },
+) {
+  const baseRegistrar = (await contracts?.getBaseRegistrar())!.connect(signer)
+  const registry = (await contracts?.getRegistry())!.connect(signer)
+  const labels = name.split('.')
+  if (isOwner) {
+    return registry.populateTransaction.setOwner(
+      ethers.utils.solidityKeccak256(['string'], [labels[0]]),
+      newOwner,
+    )
+  }
+  return baseRegistrar.populateTransaction.reclaim(
+    ethers.utils.solidityKeccak256(['string'], [labels[0]]),
+    newOwner,
+  )
+}

package/src/functions/transferSubname.ts

@@ -1,7 +1,7 @@
 import { ethers } from 'ethers'
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
-import { Expiry, makeExpiry } from '../utils/wrapperExpiry'
+import { Expiry, makeExpiry } from '../utils/wrapper'
 
 type BaseArgs = {
   owner: string

package/src/functions/wrapName.test.ts

@@ -44,7 +44,7 @@ describe('wrapName', () => {
       await tx.wait()
 
       const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
-      const [fuses] = await nameWrapper.getFuses(namehash('test123.eth'))
+      const [, fuses] = await nameWrapper.getData(namehash('test123.eth'))
 
       // parent cannot control
       expect(fuses).toBe(64)
@@ -62,7 +62,7 @@ describe('wrapName', () => {
       await tx.wait()
 
       const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
-      const [fuses] = await nameWrapper.getFuses(namehash('test123.eth'))
+      const [, fuses] = await nameWrapper.getData(namehash('test123.eth'))
       expect(fuses).toBe(81)
     })
     it('should allow an initial resolver address', async () => {
@@ -81,6 +81,15 @@ describe('wrapName', () => {
       )
       expect(result).toBe('0x42D63ae25990889E35F215bC95884039Ba354115')
     })
+    it('should throw an error for labels longer than 255 bytes', async () => {
+      const label = 'a'.repeat(256)
+      await expect(
+        ensInstance.wrapName(`${label}.eth`, {
+          wrappedOwner: accounts[2],
+          addressOrIndex: 1,
+        }),
+      ).rejects.toThrow("Label can't be longer than 255 bytes")
+    })
   })
   describe('other', () => {
     it('should return a wrap name transaction and succeed', async () => {
@@ -94,7 +103,7 @@ describe('wrapName', () => {
       await tx.wait()
 
       const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
-      const [fuses] = await nameWrapper.getFuses(
+      const [, fuses] = await nameWrapper.getData(
         namehash('test.with-subnames.eth'),
       )
 

package/src/functions/wrapName.ts

@@ -3,7 +3,7 @@ import { ENSArgs } from '..'
 import type { FuseOptions } from '../@types/FuseOptions'
 import generateFuseInput from '../utils/generateFuseInput'
 import { hexEncodeName } from '../utils/hexEncodedName'
-import { Expiry, makeExpiry } from '../utils/wrapperExpiry'
+import { Expiry, makeExpiry, wrappedLabelLengthCheck } from '../utils/wrapper'
 
 async function wrapETH(
   { contracts }: ENSArgs<'contracts'>,
@@ -86,6 +86,8 @@ export default async function (
   if (!resolverAddress) resolverAddress = publicResolver.address
 
   const labels = name.split('.')
+  wrappedLabelLengthCheck(labels[0])
+
   if (labels.length === 2 && labels[1] === 'eth') {
     switch (typeof fuseOptions) {
       case 'object': {