@ensdomains/ensjs 3.0.0-alpha.17 → 3.0.0-alpha.18

package/src/functions/makeCommitment.test.ts

@@ -2,20 +2,20 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { makeCommitment } from '../utils/registerHelpers'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 
 beforeAll(async () => {
-  ;({ ENSInstance } = await setup())
+  ;({ ensInstance } = await setup())
 })
 
 describe('makeCommitment', () => {
   it('should create a valid commitment', async () => {
-    const resolver = await ENSInstance.contracts!.getPublicResolver()!
+    const resolver = await ensInstance.contracts!.getPublicResolver()!
     const commitment = makeCommitment({
       name: 'test.eth',
       owner: '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
       duration: 1 * 365 * 24 * 60 * 60,
-      resolver: resolver,
+      resolver,
     })
     expect(commitment).toHaveProperty('secret')
     expect(commitment).toHaveProperty('commitment')

package/src/functions/registerName.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { namehash } from '../utils/normalise'
 
-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()
 })
 
@@ -26,7 +26,7 @@ describe('registerName', () => {
     const name = 'cool-swag.eth'
     const duration = 31536000
     const { customData, ...commitPopTx } =
-      await ENSInstance.commitName.populateTransaction(name, {
+      await ensInstance.commitName.populateTransaction(name, {
         duration,
         owner: accounts[1],
         addressOrIndex: accounts[1],
@@ -39,10 +39,10 @@ describe('registerName', () => {
 
     const { secret, wrapperExpiry } = customData!
 
-    const controller = await ENSInstance.contracts!.getEthRegistrarController()!
+    const controller = await ensInstance.contracts!.getEthRegistrarController()!
     const [price] = await controller.rentPrice(name, duration)
 
-    const tx = await ENSInstance.registerName(name, {
+    const tx = await ensInstance.registerName(name, {
       secret,
       wrapperExpiry,
       duration,
@@ -52,7 +52,7 @@ describe('registerName', () => {
     })
     await tx.wait()
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
+    const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
     const owner = await nameWrapper.ownerOf(namehash(name))
     expect(owner).toBe(accounts[1])
   })

package/src/functions/renewName.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { labelhash } from '../utils/labels'
 
-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()
 })
 
@@ -25,13 +25,13 @@ describe('registerName', () => {
     const name = 'to-be-renewed.eth'
     const label = name.split('.')[0]
     const duration = 31536000
-    const baseRegistrar = await ENSInstance.contracts!.getBaseRegistrar()!
+    const baseRegistrar = await ensInstance.contracts!.getBaseRegistrar()!
     const oldExpiry = await baseRegistrar.nameExpires(labelhash(label))
 
-    const controller = await ENSInstance.contracts!.getEthRegistrarController()!
+    const controller = await ensInstance.contracts!.getEthRegistrarController()!
     const [price] = await controller.rentPrice(label, duration)
 
-    const tx = await ENSInstance.renewName(name, {
+    const tx = await ensInstance.renewName(name, {
       value: price.mul(2),
       duration,
       addressOrIndex: accounts[1],

package/src/functions/setName.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
 
-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()
 })
 
@@ -22,18 +22,18 @@ describe('setName', () => {
     await revert()
   })
   it('should return a transaction for a name and set successfully', async () => {
-    const tx = await ENSInstance.setName('test123.eth', { addressOrIndex: 1 })
+    const tx = await ensInstance.setName('test123.eth', { addressOrIndex: 1 })
     expect(tx).toBeTruthy()
     await tx?.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const reverseNode = accounts[1].toLowerCase().substring(2) + '.addr.reverse'
+      await ensInstance.contracts!.getUniversalResolver()!
+    const reverseNode = `${accounts[1].toLowerCase().substring(2)}.addr.reverse`
     const result = await universalResolver.reverse(hexEncodeName(reverseNode))
     expect(result[0]).toBe('test123.eth')
   })
   it("should return a transaction for setting another address' name", async () => {
-    const registry = (await ENSInstance.contracts!.getRegistry()!).connect(
+    const registry = (await ensInstance.contracts!.getRegistry()!).connect(
       provider.getSigner(1),
     )
     const setApprovedForAllTx = await registry.setApprovalForAll(
@@ -42,7 +42,7 @@ describe('setName', () => {
     )
     await setApprovedForAllTx?.wait()
 
-    const tx = await ENSInstance.setName('test123.eth', {
+    const tx = await ensInstance.setName('test123.eth', {
       address: accounts[1],
       addressOrIndex: 2,
     })
@@ -50,8 +50,8 @@ describe('setName', () => {
     await tx?.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const reverseNode = accounts[1].toLowerCase().substring(2) + '.addr.reverse'
+      await ensInstance.contracts!.getUniversalResolver()!
+    const reverseNode = `${accounts[1].toLowerCase().substring(2)}.addr.reverse`
     const result = await universalResolver.reverse(hexEncodeName(reverseNode))
     expect(result[0]).toBe('test123.eth')
   })

package/src/functions/setRecord.test.ts

@@ -4,11 +4,11 @@ import { decodeContenthash } from '../utils/contentHash'
 import { hexEncodeName } from '../utils/hexEncodedName'
 import { namehash } from '../utils/normalise'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
 
 beforeAll(async () => {
-  ;({ ENSInstance, revert } = await setup())
+  ;({ ensInstance, revert } = await setup())
 })
 
 afterAll(async () => {
@@ -17,7 +17,7 @@ afterAll(async () => {
 
 describe('setRecord', () => {
   it('should allow a text record set', async () => {
-    const tx = await ENSInstance.setRecord('test123.eth', {
+    const tx = await ensInstance.setRecord('test123.eth', {
       type: 'text',
       record: { key: 'foo', value: 'bar' },
       addressOrIndex: 1,
@@ -26,8 +26,8 @@ describe('setRecord', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ensInstance.contracts!.getPublicResolver()!
     const encodedText = await universalResolver.resolve(
       hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('text', [
@@ -42,7 +42,7 @@ describe('setRecord', () => {
     expect(resultText).toBe('bar')
   })
   it('should allow an address record set', async () => {
-    const tx = await ENSInstance.setRecord('test123.eth', {
+    const tx = await ensInstance.setRecord('test123.eth', {
       type: 'addr',
       record: {
         key: 'ETC',
@@ -54,8 +54,8 @@ describe('setRecord', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ensInstance.contracts!.getPublicResolver()!
     const encodedAddr = await universalResolver.resolve(
       hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('addr(bytes32,uint256)', [
@@ -72,7 +72,7 @@ describe('setRecord', () => {
     )
   })
   it('should allow a contenthash record set', async () => {
-    const tx = await ENSInstance.setRecord('test123.eth', {
+    const tx = await ensInstance.setRecord('test123.eth', {
       type: 'contentHash',
       record:
         'ipns://k51qzi5uqu5dgox2z23r6e99oqency055a6xt92xzmyvpz8mwz5ycjavm0u150',
@@ -82,8 +82,8 @@ describe('setRecord', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ensInstance.contracts!.getPublicResolver()!
     const encodedContent = await universalResolver.resolve(
       hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('contenthash', [

package/src/functions/setRecord.ts

@@ -1,10 +1,6 @@
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
-import {
-  generateSingleRecordCall,
-  RecordInput,
-  RecordTypes,
-} from '../utils/recordHelpers'
+import { generateSingleRecordCall, RecordInput } from '../utils/recordHelpers'
 
 type BaseInput = {
   resolverAddress?: string
@@ -20,7 +16,7 @@ type AddrOrTextInput = {
   type: 'addr' | 'text'
 }
 
-export default async function <T extends RecordTypes>(
+export default async function (
   {
     contracts,
     provider,

package/src/functions/setRecords.test.ts

@@ -3,11 +3,11 @@ import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
 import { namehash } from '../utils/normalise'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
 
 beforeAll(async () => {
-  ;({ ENSInstance, revert } = await setup())
+  ;({ ensInstance, revert } = await setup())
 })
 
 afterAll(async () => {
@@ -16,7 +16,7 @@ afterAll(async () => {
 
 describe('setRecords', () => {
   it('should return a transaction to the resolver and set successfully', async () => {
-    const tx = await ENSInstance.setRecords('test123.eth', {
+    const tx = await ensInstance.setRecords('test123.eth', {
       records: {
         coinTypes: [
           { key: 'ETC', value: '0x42D63ae25990889E35F215bC95884039Ba354115' },
@@ -29,8 +29,8 @@ describe('setRecords', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ensInstance.contracts!.getPublicResolver()!
     const encodedText = await universalResolver.resolve(
       hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('text', [

package/src/functions/setResolver.test.ts

@@ -1,14 +1,12 @@
-import { ethers } from 'ethers'
 import { ENS } from '..'
 import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
 
-let ENSInstance: ENS
+let ensInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
-let provider: ethers.providers.JsonRpcProvider
 
 beforeAll(async () => {
-  ;({ ENSInstance, revert, provider } = await setup())
+  ;({ ensInstance, revert } = await setup())
 })
 
 afterAll(async () => {
@@ -20,7 +18,7 @@ describe('setResolver', () => {
     await revert()
   })
   it('should return a transaction to the registry and set successfully', async () => {
-    const tx = await ENSInstance.setResolver('test123.eth', {
+    const tx = await ensInstance.setResolver('test123.eth', {
       contract: 'registry',
       resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
       addressOrIndex: 1,
@@ -29,14 +27,14 @@ describe('setResolver', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
     const [result] = await universalResolver.findResolver(
       hexEncodeName('test123.eth'),
     )
     expect(result).toBe('0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC')
   })
   it('should return a transaction to the namewrapper and set successfully', async () => {
-    const tx = await ENSInstance.setResolver('wrapped.eth', {
+    const tx = await ensInstance.setResolver('wrapped.eth', {
       contract: 'nameWrapper',
       resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
       addressOrIndex: 1,
@@ -45,7 +43,7 @@ describe('setResolver', () => {
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
     const [result] = await universalResolver.findResolver(
       hexEncodeName('wrapped.eth'),
     )

package/src/functions/setResolver.ts

@@ -13,7 +13,7 @@ export default async function (
   },
 ) {
   if (!resolver) {
-    resolver = (await contracts?.getPublicResolver()!).address
+    resolver = (await contracts!.getPublicResolver()!).address
   }
 
   switch (contract) {

package/src/functions/transferName.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { namehash } from '../utils/normalise'
 
-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()
 })
 
@@ -22,7 +22,7 @@ describe('transferName', () => {
     await revert()
   })
   it('should allow a transfer on the registrar', async () => {
-    const tx = await ENSInstance.transferName('test123.eth', {
+    const tx = await ensInstance.transferName('test123.eth', {
       contract: 'baseRegistrar',
       newOwner: accounts[2],
       addressOrIndex: 1,
@@ -30,14 +30,14 @@ describe('transferName', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const baseRegistrar = await ENSInstance.contracts!.getBaseRegistrar()!
+    const baseRegistrar = await ensInstance.contracts!.getBaseRegistrar()!
     const result = await baseRegistrar.ownerOf(
       utils.solidityKeccak256(['string'], ['test123']),
     )
     expect(result).toBe(accounts[2])
   })
   it('should allow a transfer on the namewrapper', async () => {
-    const tx = await ENSInstance.transferName('wrapped.eth', {
+    const tx = await ensInstance.transferName('wrapped.eth', {
       newOwner: accounts[2],
       contract: 'nameWrapper',
       addressOrIndex: 1,
@@ -45,12 +45,12 @@ describe('transferName', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
+    const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
     const result = await nameWrapper.ownerOf(namehash('wrapped.eth'))
     expect(result).toBe(accounts[2])
   })
   it('should allow a transfer on the registry', async () => {
-    const tx = await ENSInstance.transferName('test.with-subnames.eth', {
+    const tx = await ensInstance.transferName('test.with-subnames.eth', {
       newOwner: accounts[1],
       contract: 'registry',
       addressOrIndex: accounts[2],
@@ -58,7 +58,7 @@ describe('transferName', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const registry = await ENSInstance.contracts!.getRegistry()!
+    const registry = await ensInstance.contracts!.getRegistry()!
     const result = await registry.owner(namehash('test.with-subnames.eth'))
     expect(result).toBe(accounts[1])
   })

package/src/functions/transferSubname.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { namehash } from '../utils/normalise'
 
-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()
 })
 
@@ -22,7 +22,7 @@ describe('transferSubname', () => {
     await revert()
   })
   it('should allow transferring a subname on the registry', async () => {
-    const tx = await ENSInstance.transferSubname('test.with-subnames.eth', {
+    const tx = await ensInstance.transferSubname('test.with-subnames.eth', {
       contract: 'registry',
       owner: accounts[1],
       addressOrIndex: 1,
@@ -30,12 +30,12 @@ describe('transferSubname', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const registry = await ENSInstance.contracts!.getRegistry()!
+    const registry = await ensInstance.contracts!.getRegistry()!
     const result = await registry.owner(namehash('test.with-subnames.eth'))
     expect(result).toBe(accounts[1])
   })
   it('should allow transferring a subname on the nameWrapper', async () => {
-    const tx = await ENSInstance.transferSubname(
+    const tx = await ensInstance.transferSubname(
       'test.wrapped-with-subnames.eth',
       {
         contract: 'nameWrapper',
@@ -46,7 +46,7 @@ describe('transferSubname', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
+    const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
     const result = await nameWrapper.ownerOf(
       namehash('test.wrapped-with-subnames.eth'),
     )

package/src/functions/transferSubname.ts

@@ -32,7 +32,7 @@ export default async function (
 
   switch (contract) {
     case 'registry': {
-      const registry = (await contracts?.getRegistry()!).connect(signer)
+      const registry = (await contracts!.getRegistry()!).connect(signer)
 
       return registry.populateTransaction.setSubnodeOwner(
         parentNodehash,
@@ -41,7 +41,7 @@ export default async function (
       )
     }
     case 'nameWrapper': {
-      const nameWrapper = (await contracts?.getNameWrapper()!).connect(signer)
+      const nameWrapper = (await contracts!.getNameWrapper()!).connect(signer)
       const expiry = await makeExpiry(
         { getExpiry },
         labels.join('.'),

package/src/functions/unwrapName.test.ts

@@ -3,13 +3,13 @@ import { ENS } from '..'
 import setup from '../tests/setup'
 import { namehash } from '../utils/normalise'
 
-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()
 })
 
@@ -22,7 +22,7 @@ describe('unwrapName', () => {
     await revert()
   })
   it('should return a .eth unwrap name transaction and succeed', async () => {
-    const tx = await ENSInstance.unwrapName('wrapped.eth', {
+    const tx = await ensInstance.unwrapName('wrapped.eth', {
       newController: accounts[1],
       newRegistrant: accounts[1],
       addressOrIndex: 1,
@@ -30,21 +30,21 @@ describe('unwrapName', () => {
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const baseRegistrar = await ENSInstance.contracts!.getBaseRegistrar()!
+    const baseRegistrar = await ensInstance.contracts!.getBaseRegistrar()!
     const result = await baseRegistrar.ownerOf(
       utils.solidityKeccak256(['string'], ['wrapped']),
     )
     expect(result).toBe(accounts[1])
   })
   it('should return a regular unwrap name transaction and succeed', async () => {
-    const tx = await ENSInstance.unwrapName('test.wrapped-with-subnames.eth', {
+    const tx = await ensInstance.unwrapName('test.wrapped-with-subnames.eth', {
       newController: accounts[1],
       addressOrIndex: 2,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
 
-    const registry = await ENSInstance.contracts!.getRegistry()!
+    const registry = await ensInstance.contracts!.getRegistry()!
     const result = await registry.owner(
       namehash('test.wrapped-with-subnames.eth'),
     )

package/src/functions/unwrapName.ts

@@ -17,7 +17,7 @@ export default async function (
   const labelhash = utils.solidityKeccak256(['string'], [labels[0]])
   const parentNodehash = namehash(labels.slice(1).join('.'))
 
-  const nameWrapper = (await contracts?.getNameWrapper()!).connect(signer)
+  const nameWrapper = (await contracts!.getNameWrapper()!).connect(signer)
 
   if (labels.length === 2 && labels[1] === 'eth') {
     if (!newRegistrant) {
@@ -29,15 +29,14 @@ export default async function (
       newRegistrant,
       newController,
     )
-  } else {
-    if (newRegistrant) {
-      throw new Error('newRegistrant can only be specified for .eth names')
-    }
-
-    return nameWrapper.populateTransaction.unwrap(
-      parentNodehash,
-      labelhash,
-      newController,
-    )
   }
+  if (newRegistrant) {
+    throw new Error('newRegistrant can only be specified for .eth names')
+  }
+
+  return nameWrapper.populateTransaction.unwrap(
+    parentNodehash,
+    labelhash,
+    newController,
+  )
 }