@ensdomains/ensjs 3.0.0-alpha.10 → 3.0.0-alpha.13

package/src/functions/setRecords.test.ts

@@ -16,13 +16,14 @@ afterAll(async () => {
 
 describe('setRecords', () => {
   it('should return a transaction to the resolver and set successfully', async () => {
-    const tx = await ENSInstance.setRecords('parthtejpal.eth', {
+    const tx = await ENSInstance.setRecords('test123.eth', {
       records: {
         coinTypes: [
           { key: 'ETC', value: '0x42D63ae25990889E35F215bC95884039Ba354115' },
         ],
         texts: [{ key: 'foo', value: 'bar' }],
       },
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
@@ -31,16 +32,16 @@ describe('setRecords', () => {
       await ENSInstance.contracts!.getUniversalResolver()!
     const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
     const encodedText = await universalResolver.resolve(
-      hexEncodeName('parthtejpal.eth'),
+      hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('text', [
-        namehash('parthtejpal.eth'),
+        namehash('test123.eth'),
         'foo',
       ]),
     )
     const encodedAddr = await universalResolver.resolve(
-      hexEncodeName('parthtejpal.eth'),
+      hexEncodeName('test123.eth'),
       publicResolver.interface.encodeFunctionData('addr(bytes32,uint256)', [
-        namehash('parthtejpal.eth'),
+        namehash('test123.eth'),
         '61',
       ]),
     )

package/src/functions/setResolver.test.ts

@@ -20,9 +20,10 @@ describe('setResolver', () => {
     await revert()
   })
   it('should return a transaction to the registry and set successfully', async () => {
-    const tx = await ENSInstance.setResolver('parthtejpal.eth', {
+    const tx = await ENSInstance.setResolver('test123.eth', {
       contract: 'registry',
       resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
@@ -30,19 +31,15 @@ describe('setResolver', () => {
     const universalResolver =
       await ENSInstance.contracts!.getUniversalResolver()!
     const [result] = await universalResolver.findResolver(
-      hexEncodeName('parthtejpal.eth'),
+      hexEncodeName('test123.eth'),
     )
     expect(result).toBe('0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC')
   })
   it('should return a transaction to the namewrapper and set successfully', async () => {
-    const accounts = await provider.listAccounts()
-    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-    })
-    await wrapNameTx.wait()
-    const tx = await ENSInstance.setResolver('parthtejpal.eth', {
+    const tx = await ENSInstance.setResolver('wrapped.eth', {
       contract: 'nameWrapper',
       resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
@@ -50,7 +47,7 @@ describe('setResolver', () => {
     const universalResolver =
       await ENSInstance.contracts!.getUniversalResolver()!
     const [result] = await universalResolver.findResolver(
-      hexEncodeName('parthtejpal.eth'),
+      hexEncodeName('wrapped.eth'),
     )
     expect(result).toBe('0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC')
   })

package/src/functions/transferName.test.ts

@@ -22,58 +22,44 @@ describe('transferName', () => {
     await revert()
   })
   it('should allow a transfer on the registrar', async () => {
-    const tx = await ENSInstance.transferName('parthtejpal.eth', {
+    const tx = await ENSInstance.transferName('test123.eth', {
       contract: 'baseRegistrar',
-      newOwner: accounts[1],
-      addressOrIndex: 0,
+      newOwner: accounts[2],
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const baseRegistrar = await ENSInstance.contracts!.getBaseRegistrar()!
     const result = await baseRegistrar.ownerOf(
-      utils.solidityKeccak256(['string'], ['parthtejpal']),
+      utils.solidityKeccak256(['string'], ['test123']),
     )
-    expect(result).toBe(accounts[1])
+    expect(result).toBe(accounts[2])
   })
   it('should allow a transfer on the namewrapper', async () => {
-    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-    })
-    await wrapNameTx.wait()
-    const tx = await ENSInstance.transferName('parthtejpal.eth', {
-      newOwner: accounts[1],
+    const tx = await ENSInstance.transferName('wrapped.eth', {
+      newOwner: accounts[2],
       contract: 'nameWrapper',
-      addressOrIndex: 0,
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const result = await nameWrapper.ownerOf(namehash('parthtejpal.eth'))
-    expect(result).toBe(accounts[1])
+    const result = await nameWrapper.ownerOf(namehash('wrapped.eth'))
+    expect(result).toBe(accounts[2])
   })
   it('should allow a transfer on the registry', async () => {
-    const createSubnameTx = await ENSInstance.createSubname(
-      'test.parthtejpal.eth',
-      {
-        contract: 'registry',
-        owner: accounts[0],
-        addressOrIndex: accounts[0],
-      },
-    )
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferName('test.parthtejpal.eth', {
+    const tx = await ENSInstance.transferName('test.with-subnames.eth', {
       newOwner: accounts[1],
       contract: 'registry',
-      addressOrIndex: accounts[0],
+      addressOrIndex: accounts[2],
     })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const registry = await ENSInstance.contracts!.getRegistry()!
-    const result = await registry.owner(namehash('test.parthtejpal.eth'))
+    const result = await registry.owner(namehash('test.with-subnames.eth'))
     expect(result).toBe(accounts[1])
   })
 })

package/src/functions/transferSubname.test.ts

@@ -22,53 +22,34 @@ describe('transferSubname', () => {
     await revert()
   })
   it('should allow transferring a subname on the registry', async () => {
-    const createSubnameTx = await ENSInstance.createSubname(
-      'test.parthtejpal.eth',
-      {
-        contract: 'registry',
-        owner: accounts[0],
-        addressOrIndex: 0,
-      },
-    )
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferSubname('test.parthtejpal.eth', {
+    const tx = await ENSInstance.transferSubname('test.with-subnames.eth', {
       contract: 'registry',
-      address: accounts[1],
-      addressOrIndex: 0,
+      owner: accounts[1],
+      addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const registry = await ENSInstance.contracts!.getRegistry()!
-    const result = await registry.owner(namehash('test.parthtejpal.eth'))
+    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 wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
-    })
-    await wrapNameTx.wait()
-    const createSubnameTx = await ENSInstance.createSubname(
-      'test.parthtejpal.eth',
+    const tx = await ENSInstance.transferSubname(
+      'test.wrapped-with-subnames.eth',
       {
         contract: 'nameWrapper',
-        owner: accounts[0],
-        addressOrIndex: 0,
+        owner: accounts[1],
+        addressOrIndex: 1,
       },
     )
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferSubname('test.parthtejpal.eth', {
-      contract: 'nameWrapper',
-      address: accounts[1],
-      addressOrIndex: 0,
-    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const result = await nameWrapper.ownerOf(namehash('test.parthtejpal.eth'))
+    const result = await nameWrapper.ownerOf(
+      namehash('test.wrapped-with-subnames.eth'),
+    )
     expect(result).toBe(accounts[1])
   })
 })

package/src/functions/transferSubname.ts

@@ -1,17 +1,29 @@
 import { ethers } from 'ethers'
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
+import { Expiry, makeExpiry } from '../utils/wrapperExpiry'
+
+type BaseArgs = {
+  owner: string
+  resolverAddress?: string
+  contract: 'registry' | 'nameWrapper'
+}
+
+type NameWrapperArgs = {
+  contract: 'nameWrapper'
+  expiry?: Expiry
+} & BaseArgs
+
+type Args = BaseArgs | NameWrapperArgs
 
 export default async function (
-  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
-  name: string,
   {
-    contract,
-    address,
-  }: {
-    contract: 'registry' | 'nameWrapper'
-    address: string
-  },
+    contracts,
+    signer,
+    getExpiry,
+  }: ENSArgs<'contracts' | 'signer' | 'getExpiry'>,
+  name: string,
+  { contract, owner, resolverAddress, ...wrapperArgs }: Args,
 ) {
   const labels = name.split('.')
   const label = labels.shift() as string
@@ -25,17 +37,23 @@ export default async function (
       return registry.populateTransaction.setSubnodeOwner(
         parentNodehash,
         labelhash,
-        address,
+        owner,
       )
     }
     case 'nameWrapper': {
       const nameWrapper = (await contracts?.getNameWrapper()!).connect(signer)
+      const expiry = await makeExpiry(
+        { getExpiry },
+        labels.join('.'),
+        'expiry' in wrapperArgs ? wrapperArgs.expiry : undefined,
+      )
 
       return nameWrapper.populateTransaction.setSubnodeOwner(
         parentNodehash,
         label,
-        address,
+        owner,
         '0',
+        expiry,
       )
     }
     default: {

package/src/functions/unwrapName.test.ts

@@ -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 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 result = await registry.owner(
+      namehash('test.wrapped-with-subnames.eth'),
+    )
+    expect(result).toBe(accounts[1])
   })
 })

package/src/functions/wrapName.test.ts

@@ -1,4 +1,4 @@
-import { BigNumber, ethers } from 'ethers'
+import { ethers } from 'ethers'
 import { ENS } from '..'
 import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
@@ -19,49 +19,124 @@ 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.getFuses(namehash('test123.eth'))
+
+      // parent cannot control
+      expect(fuses).toBe(64)
     })
-    expect(tx).toBeTruthy()
-    await tx.wait()
+    it('should allow initial fuses', async () => {
+      const tx = await ENSInstance.wrapName('test123.eth', {
+        wrappedOwner: accounts[2],
+        fuseOptions: {
+          cannotUnwrap: true,
+          cannotSetTtl: true,
+        },
+        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.getFuses(namehash('test123.eth'))
+      expect(fuses).toBe(81)
     })
-    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 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.getFuses(
+        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: {
+            cannotUnwrap: true,
+            cannotSetTtl: true,
+          },
+          addressOrIndex: 1,
+        }),
+      ).rejects.toThrow()
+    })
   })
 })

package/src/functions/wrapName.ts

@@ -1,13 +1,15 @@
-import { ethers } from 'ethers'
+import { BigNumber, ethers } from 'ethers'
 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'
 
 async function wrapETH(
   { contracts }: ENSArgs<'contracts'>,
   labels: string[],
   wrappedOwner: string,
+  expiry: BigNumber,
   decodedFuses: string,
   resolverAddress: string,
   signer: ethers.Signer,
@@ -20,7 +22,7 @@ async function wrapETH(
 
   const data = ethers.utils.defaultAbiCoder.encode(
     ['string', 'address', 'uint32', 'uint64', 'address'],
-    [labels[0], wrappedOwner, '0x0', decodedFuses, resolverAddress],
+    [labels[0], wrappedOwner, decodedFuses, expiry, resolverAddress],
   )
 
   return baseRegistrar.populateTransaction[
@@ -32,7 +34,6 @@ async function wrapOther(
   { contracts }: ENSArgs<'contracts'>,
   name: string,
   wrappedOwner: string,
-  decodedFuses: string,
   resolverAddress: string,
   address: string,
   signer: ethers.Signer,
@@ -54,21 +55,26 @@ 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,
+    getExpiry,
+  }: ENSArgs<'contracts' | 'signer' | 'getExpiry'>,
   name: string,
   {
     wrappedOwner,
     fuseOptions,
+    expiry,
     resolverAddress,
   }: {
     wrappedOwner: string
     fuseOptions?: FuseOptions | string | number
+    expiry?: Expiry
     resolverAddress?: string
   },
 ) {
@@ -76,48 +82,58 @@ export default async function (
 
   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}`)
-    }
-  }
-
   const publicResolver = await contracts?.getPublicResolver()!
   if (!resolverAddress) resolverAddress = publicResolver.address
 
   const labels = name.split('.')
-  if (labels.length < 3 && labels[labels.length - 1] === 'eth') {
+  if (labels.length === 2 && labels[1] === 'eth') {
+    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}`)
+      }
+    }
+
+    const expiryToUse = await makeExpiry({ getExpiry }, name, expiry)
+
     return wrapETH(
       { contracts },
       labels,
       wrappedOwner,
+      expiryToUse,
       decodedFuses,
       resolverAddress,
       signer,
       address,
     )
   } else {
+    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,
-      decodedFuses,
       resolverAddress,
       address,
       signer,