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

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,47 +22,32 @@ describe('unwrapName', () => {
     await revert()
   })
   it('should return a .eth unwrap name transaction and succeed', async () => {
-    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-    })
-    await wrapNameTx.wait()
-
-    const tx = await ENSInstance.unwrapName('parthtejpal.eth', {
-      newController: accounts[0],
-      newRegistrant: accounts[0],
+    const tx = await ensInstance.unwrapName('wrapped.eth', {
+      newController: accounts[1],
+      newRegistrant: accounts[1],
+      addressOrIndex: 1,
     })
     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'], ['parthtejpal']),
+      utils.solidityKeccak256(['string'], ['wrapped']),
     )
-    expect(result).toBe(accounts[0])
+    expect(result).toBe(accounts[1])
   })
   it('should return a regular unwrap name transaction and succeed', async () => {
-    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-    })
-    await wrapNameTx.wait()
-    const createSubnameTx = await ENSInstance.createSubname(
-      'test.parthtejpal.eth',
-      {
-        contract: 'nameWrapper',
-        owner: accounts[0],
-        addressOrIndex: 0,
-      },
-    )
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.unwrapName('test.parthtejpal.eth', {
-      newController: accounts[0],
+    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 result = await registry.owner(namehash('test.parthtejpal.eth'))
-    expect(result).toBe(accounts[0])
+    const registry = await ensInstance.contracts!.getRegistry()!
+    const result = await registry.owner(
+      namehash('test.wrapped-with-subnames.eth'),
+    )
+    expect(result).toBe(accounts[1])
   })
 })

package/src/functions/unwrapName.ts

@@ -1,6 +1,8 @@
-import { utils } from 'ethers'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
+
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
+import { checkIsDotEth } from '../utils/validation'
 
 export default async function (
   { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
@@ -14,12 +16,12 @@ export default async function (
   },
 ) {
   const labels = name.split('.')
-  const labelhash = utils.solidityKeccak256(['string'], [labels[0]])
+  const labelhash = 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 (checkIsDotEth(labels)) {
     if (!newRegistrant) {
       throw new Error('newRegistrant must be specified for .eth names')
     }
@@ -29,15 +31,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,
+  )
 }

package/src/functions/wrapName.test.ts

@@ -1,17 +1,16 @@
-import { BigNumber, ethers } from 'ethers'
+import { ethers } from 'ethers'
 import { ENS } from '..'
 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']
-let createSnapshot: Awaited<ReturnType<typeof setup>>['createSnapshot']
 let provider: ethers.providers.JsonRpcProvider
 let accounts: string[]
 
 beforeAll(async () => {
-  ;({ ENSInstance, revert, createSnapshot, provider } = await setup())
+  ;({ ensInstance, revert, provider } = await setup())
   accounts = await provider.listAccounts()
 })
 
@@ -19,49 +18,134 @@ afterAll(async () => {
   await revert()
 })
 
+const approve = async () => {
+  const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+  const registry = (await ensInstance.contracts!.getRegistry()!).connect(
+    provider.getSigner(2),
+  )
+  const setApprovedForAllTx = await registry.setApprovalForAll(
+    nameWrapper.address,
+    true,
+  )
+  await setApprovedForAllTx?.wait()
+}
+
 describe('wrapName', () => {
   beforeEach(async () => {
     await revert()
   })
-  it('should return a wrap name transaction and succeed', async () => {
-    const tx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
+  describe('.eth', () => {
+    it('should return a wrap name transaction and succeed', async () => {
+      const tx = await ensInstance.wrapName('test123.eth', {
+        wrappedOwner: accounts[2],
+        addressOrIndex: 1,
+      })
+      expect(tx).toBeTruthy()
+      await tx.wait()
+
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+      const [, fuses] = await nameWrapper.getData(namehash('test123.eth'))
+
+      expect(fuses).toBe(196608)
     })
-    expect(tx).toBeTruthy()
-    await tx.wait()
+    it('should allow initial fuses', async () => {
+      const tx = await ensInstance.wrapName('test123.eth', {
+        wrappedOwner: accounts[2],
+        fuseOptions: {
+          child: {
+            named: ['CANNOT_UNWRAP', 'CANNOT_SET_TTL'],
+          },
+        },
+        addressOrIndex: 1,
+      })
+      expect(tx).toBeTruthy()
+      await tx.wait()
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const [result] = await nameWrapper.getFuses(namehash('parthtejpal.eth'))
-    expect((result as BigNumber).toHexString()).toBe('0x40')
-  })
-  it('should allow initial fuses', async () => {
-    const tx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-      fuseOptions: {
-        cannotUnwrap: true,
-        cannotSetTtl: true,
-      },
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+      const [, fuses] = await nameWrapper.getData(namehash('test123.eth'))
+      expect(fuses).toBe(196625)
     })
-    expect(tx).toBeTruthy()
-    await tx.wait()
+    it('should allow an initial resolver address', async () => {
+      const tx = await ensInstance.wrapName('test123.eth', {
+        wrappedOwner: accounts[2],
+        resolverAddress: '0x42D63ae25990889E35F215bC95884039Ba354115',
+        addressOrIndex: 1,
+      })
+      expect(tx).toBeTruthy()
+      await tx.wait()
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const [result] = await nameWrapper.getFuses(namehash('parthtejpal.eth'))
-    expect((result as BigNumber).toHexString()).toBe('0x40')
+      const universalResolver =
+        await ensInstance.contracts!.getUniversalResolver()!
+      const [result] = await universalResolver.findResolver(
+        hexEncodeName('test123.eth'),
+      )
+      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")
+    })
   })
-  it('should allow an initial resolver address', async () => {
-    const tx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-      resolverAddress: '0x42D63ae25990889E35F215bC95884039Ba354115',
+  describe('other', () => {
+    it('should return a wrap name transaction and succeed', async () => {
+      await approve()
+
+      const tx = await ensInstance.wrapName('test.with-subnames.eth', {
+        wrappedOwner: accounts[2],
+        addressOrIndex: 2,
+      })
+      expect(tx).toBeTruthy()
+      await tx.wait()
+
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+      const [, fuses] = await nameWrapper.getData(
+        namehash('test.with-subnames.eth'),
+      )
+
+      expect(fuses).toBe(0)
     })
-    expect(tx).toBeTruthy()
-    await tx.wait()
+    it('should allow an initial resolver address', async () => {
+      await approve()
+      const tx = await ensInstance.wrapName('test.with-subnames.eth', {
+        wrappedOwner: accounts[2],
+        resolverAddress: '0x42D63ae25990889E35F215bC95884039Ba354115',
+        addressOrIndex: 2,
+      })
+      expect(tx).toBeTruthy()
+      await tx.wait()
 
-    const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
-    const [result] = await universalResolver.findResolver(
-      hexEncodeName('parthtejpal.eth'),
-    )
-    expect(result).toBe('0x42D63ae25990889E35F215bC95884039Ba354115')
+      const universalResolver =
+        await ensInstance.contracts!.getUniversalResolver()!
+      const [result] = await universalResolver.findResolver(
+        hexEncodeName('test.with-subnames.eth'),
+      )
+      expect(result).toBe('0x42D63ae25990889E35F215bC95884039Ba354115')
+    })
+    it('should throw an error if contract does not have approval', async () => {
+      await expect(
+        ensInstance.wrapName('test.with-subnames.eth', {
+          wrappedOwner: accounts[2],
+          addressOrIndex: 2,
+        }),
+      ).rejects.toThrow()
+    })
+    it('should throw an error if initial fuses are provided', async () => {
+      await expect(
+        ensInstance.wrapName('test.with-subnames.eth', {
+          wrappedOwner: accounts[2],
+          fuseOptions: {
+            child: {
+              named: ['CANNOT_UNWRAP', 'CANNOT_SET_TTL'],
+            },
+          },
+          addressOrIndex: 1,
+        }),
+      ).rejects.toThrow()
+    })
   })
 })

package/src/functions/wrapName.ts

@@ -1,26 +1,29 @@
-import { ethers } from 'ethers'
+import { defaultAbiCoder } from '@ethersproject/abi'
+import { Signer } from '@ethersproject/abstract-signer'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
 import { ENSArgs } from '..'
-import type { FuseOptions } from '../@types/FuseOptions'
-import generateFuseInput from '../utils/generateFuseInput'
+import { CombinedFuseInput, encodeFuses } from '../utils/fuses'
 import { hexEncodeName } from '../utils/hexEncodedName'
+import { checkIsDotEth } from '../utils/validation'
+import { Expiry, wrappedLabelLengthCheck } from '../utils/wrapper'
 
 async function wrapETH(
   { contracts }: ENSArgs<'contracts'>,
   labels: string[],
   wrappedOwner: string,
-  decodedFuses: string,
+  decodedFuses: number,
   resolverAddress: string,
-  signer: ethers.Signer,
+  signer: Signer,
   address: string,
 ) {
   const nameWrapper = await contracts?.getNameWrapper()!
-  const baseRegistrar = (await contracts?.getBaseRegistrar()!).connect(signer)
+  const baseRegistrar = (await contracts!.getBaseRegistrar()!).connect(signer)
 
-  const labelhash = ethers.utils.solidityKeccak256(['string'], [labels[0]])
+  const labelhash = solidityKeccak256(['string'], [labels[0]])
 
-  const data = ethers.utils.defaultAbiCoder.encode(
-    ['string', 'address', 'uint32', 'uint64', 'address'],
-    [labels[0], wrappedOwner, '0x0', decodedFuses, resolverAddress],
+  const data = defaultAbiCoder.encode(
+    ['string', 'address', 'uint16', 'address'],
+    [labels[0], wrappedOwner, decodedFuses, resolverAddress],
   )
 
   return baseRegistrar.populateTransaction[
@@ -32,12 +35,11 @@ async function wrapOther(
   { contracts }: ENSArgs<'contracts'>,
   name: string,
   wrappedOwner: string,
-  decodedFuses: string,
   resolverAddress: string,
   address: string,
-  signer: ethers.Signer,
+  signer: Signer,
 ) {
-  const nameWrapper = (await contracts?.getNameWrapper()!).connect(signer)
+  const nameWrapper = (await contracts!.getNameWrapper()!).connect(signer)
   const registry = await contracts?.getRegistry()!
 
   const hasApproval = await registry.isApprovedForAll(
@@ -54,55 +56,54 @@ async function wrapOther(
   return nameWrapper.populateTransaction.wrap(
     hexEncodeName(name),
     wrappedOwner,
-    decodedFuses,
     resolverAddress,
   )
 }
 
 export default async function (
-  { contracts, signer, populate }: ENSArgs<'contracts' | 'signer' | 'populate'>,
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
   name: string,
   {
     wrappedOwner,
     fuseOptions,
+    expiry,
     resolverAddress,
   }: {
     wrappedOwner: string
-    fuseOptions?: FuseOptions | string | number
+    fuseOptions?: Partial<CombinedFuseInput> | number
+    expiry?: Expiry
     resolverAddress?: string
   },
 ) {
   const address = await signer.getAddress()
 
-  let decodedFuses: string
-
-  switch (typeof fuseOptions) {
-    case 'object': {
-      decodedFuses = generateFuseInput(fuseOptions)
-      break
-    }
-    case 'number': {
-      decodedFuses = fuseOptions.toString(16)
-      break
-    }
-    case 'string': {
-      decodedFuses = fuseOptions
-      break
-    }
-    case 'undefined': {
-      decodedFuses = '0'
-      break
-    }
-    default: {
-      throw new Error(`Invalid fuseOptions type: ${typeof fuseOptions}`)
-    }
-  }
+  let decodedFuses: number
 
   const publicResolver = await contracts?.getPublicResolver()!
   if (!resolverAddress) resolverAddress = publicResolver.address
 
   const labels = name.split('.')
-  if (labels.length < 3 && labels[labels.length - 1] === 'eth') {
+  wrappedLabelLengthCheck(labels[0])
+
+  if (checkIsDotEth(labels)) {
+    switch (typeof fuseOptions) {
+      case 'object': {
+        decodedFuses = encodeFuses(fuseOptions)
+        break
+      }
+      case 'number': {
+        decodedFuses = fuseOptions
+        break
+      }
+      case 'undefined': {
+        decodedFuses = 0
+        break
+      }
+      default: {
+        throw new Error(`Invalid fuseOptions type: ${typeof fuseOptions}`)
+      }
+    }
+
     return wrapETH(
       { contracts },
       labels,
@@ -112,15 +113,21 @@ export default async function (
       signer,
       address,
     )
-  } else {
-    return wrapOther(
-      { contracts },
-      name,
-      wrappedOwner,
-      decodedFuses,
-      resolverAddress,
-      address,
-      signer,
-    )
   }
+  if (fuseOptions)
+    throw new Error(
+      'Fuses can not be initially set when wrapping a non .eth name',
+    )
+  if (expiry)
+    throw new Error(
+      'Expiry can not be initially set when wrapping a non .eth name',
+    )
+  return wrapOther(
+    { contracts },
+    name,
+    wrappedOwner,
+    resolverAddress,
+    address,
+    signer,
+  )
 }