@ensdomains/ensjs 3.0.0-alpha.5 → 3.0.0-alpha.50

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()
 })
 
@@ -17,58 +17,141 @@ afterAll(async () => {
   await revert()
 })
 
+beforeEach(async () => {
+  await revert()
+})
+
 describe('transferSubname', () => {
-  beforeEach(async () => {
-    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 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 wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
-      wrappedOwner: accounts[0],
+
+  describe('wrapped name with PCC NOT burned', () => {
+    it('should NOT allow transferring a subname by name owner', async () => {
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+      await expect(
+        ensInstance.transferSubname('test.wrapped-with-subnames.eth', {
+          contract: 'nameWrapper',
+          owner: accounts[1],
+          addressOrIndex: 2,
+        }),
+      ).rejects.toThrow()
+
+      const result = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(result).toBe(accounts[2])
     })
-    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.transferSubname('test.parthtejpal.eth', {
-      contract: 'nameWrapper',
-      address: accounts[1],
-      addressOrIndex: 0,
+
+    it('should allow transferring a subname by parent owner', async () => {
+      const tx = await ensInstance.transferSubname(
+        'test.wrapped-with-subnames.eth',
+        {
+          contract: 'nameWrapper',
+          owner: accounts[1],
+          addressOrIndex: 1,
+        },
+      )
+      expect(tx).toBeTruthy()
+      await tx.wait()
+
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+      const result = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(result).toBe(accounts[1])
     })
-    expect(tx).toBeTruthy()
-    await tx.wait()
+  })
 
-    const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const result = await nameWrapper.ownerOf(namehash('test.parthtejpal.eth'))
-    expect(result).toBe(accounts[1])
+  describe('wrapped name with PCC burned', () => {
+    beforeEach(async () => {
+      const tx0 = await ensInstance.setFuses('wrapped-with-subnames.eth', {
+        named: ['CANNOT_UNWRAP'],
+        addressOrIndex: 1,
+      })
+      expect(tx0).toBeTruthy()
+      await tx0.wait()
+    })
+
+    it('should NOT allow transferring a subname by name owner', async () => {
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+
+      const tx1 = await ensInstance.setChildFuses(
+        'test.wrapped-with-subnames.eth',
+        {
+          fuses: {
+            parent: {
+              named: ['PARENT_CANNOT_CONTROL'],
+            },
+          },
+          addressOrIndex: 1,
+        },
+      )
+      expect(tx1).toBeTruthy()
+      await tx1.wait()
+
+      const checkOwner = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(checkOwner).toBe(accounts[2])
+
+      await expect(
+        ensInstance.transferSubname('test.wrapped-with-subnames.eth', {
+          contract: 'nameWrapper',
+          owner: accounts[1],
+          addressOrIndex: 2,
+        }),
+      ).rejects.toThrow()
+      const result = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(result).toBe(accounts[2])
+    })
+
+    it('should NOT allow transferring a subname by parent owner', async () => {
+      const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+
+      const tx1 = await ensInstance.setChildFuses(
+        'test.wrapped-with-subnames.eth',
+        {
+          fuses: {
+            parent: {
+              named: ['PARENT_CANNOT_CONTROL'],
+            },
+          },
+          addressOrIndex: 1,
+        },
+      )
+      expect(tx1).toBeTruthy()
+      await tx1.wait()
+
+      const checkOwner = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(checkOwner).toBe(accounts[2])
+
+      await expect(
+        ensInstance.transferSubname('test.wrapped-with-subnames.eth', {
+          contract: 'nameWrapper',
+          owner: accounts[1],
+          addressOrIndex: 1,
+        }),
+      ).rejects.toThrow()
+
+      const result = await nameWrapper.ownerOf(
+        namehash('test.wrapped-with-subnames.eth'),
+      )
+      expect(result).toBe(accounts[2])
+    })
   })
 })

package/src/functions/transferSubname.ts

@@ -1,33 +1,55 @@
-import { ethers } from 'ethers'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
+import { expiryToBigNumber, Expiry } from '../utils/wrapper'
+
+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
-  },
+  { contract, owner, resolverAddress, ...wrapperArgs }: Args,
 ) {
   const labels = name.split('.')
   const label = labels.shift() as string
-  const labelhash = ethers.utils.solidityKeccak256(['string'], [label])
+  const labelhash = solidityKeccak256(['string'], [label])
   const parentNodehash = namehash(labels.join('.'))
 
   switch (contract) {
     case 'registry': {
-      const registry = (await contracts?.getRegistry()!).connect(signer)
+      const registry = (await contracts!.getRegistry()!).connect(signer)
 
-      return registry.setSubnodeOwner(parentNodehash, labelhash, address)
+      return registry.populateTransaction.setSubnodeOwner(
+        parentNodehash,
+        labelhash,
+        owner,
+      )
     }
     case 'nameWrapper': {
-      const nameWrapper = (await contracts?.getNameWrapper()!).connect(signer)
+      const nameWrapper = (await contracts!.getNameWrapper()!).connect(signer)
+      const expiry = expiryToBigNumber(
+        (wrapperArgs as NameWrapperArgs).expiry,
+        0,
+      )
 
-      return nameWrapper.setSubnodeOwner(parentNodehash, label, address, '0')
+      return nameWrapper.populateTransaction.setSubnodeOwner(
+        parentNodehash,
+        label,
+        owner,
+        '0',
+        expiry,
+      )
     }
     default: {
       throw new Error(`Unknown contract: ${contract}`)

package/src/functions/types.ts

@@ -0,0 +1,102 @@
+import type batch from './batch'
+import type {
+  multicallWrapper,
+  resolverMulticallWrapper,
+  universalWrapper,
+} from './batchWrappers'
+import type commitName from './commitName'
+import type createSubname from './createSubname'
+import type deleteSubname from './deleteSubname'
+import type getAvailable from './getAvailable'
+import type getDecryptedName from './getDecryptedName'
+import type getDNSOwner from './getDNSOwner'
+import type getExpiry from './getExpiry'
+import type { getHistory } from './getHistory'
+import type getName from './getName'
+import type getNames from './getNames'
+import type getOwner from './getOwner'
+import type getPrice from './getPrice'
+import type getProfile from './getProfile'
+import type getRecords from './getRecords'
+import type getResolver from './getResolver'
+import type {
+  getABI,
+  getAddr,
+  getContentHash,
+  getText,
+  _getABI,
+  _getAddr,
+  _getContentHash,
+  _getText,
+} from './getSpecificRecord'
+import type getSubnames from './getSubnames'
+import type getWrapperData from './getWrapperData'
+import type importDNSSECName from './importDNSSECName'
+import type registerName from './registerName'
+import type {
+  // eslint-disable-next-line import/no-named-default
+  default as renewNames,
+  extendWrappedName,
+} from './renewNames'
+import type setFuses from './setFuses'
+import type { setChildFuses } from './setFuses'
+import type setName from './setName'
+import type setRecord from './setRecord'
+import type setRecords from './setRecords'
+import type setResolver from './setResolver'
+import type supportsTLD from './supportsTLD'
+import type transferController from './transferController'
+import type transferName from './transferName'
+import type transferSubname from './transferSubname'
+import type unwrapName from './unwrapName'
+import type wrapName from './wrapName'
+
+type Function = {
+  batch: typeof batch
+  multicallWrapper: typeof multicallWrapper
+  resolverMulticallWrapper: typeof resolverMulticallWrapper
+  universalWrapper: typeof universalWrapper
+  setFuses: typeof setFuses
+  setChildFuses: typeof setChildFuses
+  commitName: typeof commitName
+  createSubname: typeof createSubname
+  deleteSubname: typeof deleteSubname
+  getAvailable: typeof getAvailable
+  getDecryptedName: typeof getDecryptedName
+  getDNSOwner: typeof getDNSOwner
+  getExpiry: typeof getExpiry
+  getHistory: typeof getHistory
+  getName: typeof getName
+  getNames: typeof getNames
+  getOwner: typeof getOwner
+  getPrice: typeof getPrice
+  getProfile: typeof getProfile
+  getRecords: typeof getRecords
+  getResolver: typeof getResolver
+  getAddr: typeof getAddr
+  getContentHash: typeof getContentHash
+  getText: typeof getText
+  getABI: typeof getABI
+  _getAddr: typeof _getAddr
+  _getContentHash: typeof _getContentHash
+  _getText: typeof _getText
+  _getABI: typeof _getABI
+  getSubnames: typeof getSubnames
+  getWrapperData: typeof getWrapperData
+  importDNSSECName: typeof importDNSSECName
+  registerName: typeof registerName
+  renewNames: typeof renewNames
+  extendWrappedName: typeof extendWrappedName
+  setName: typeof setName
+  setRecord: typeof setRecord
+  setRecords: typeof setRecords
+  setResolver: typeof setResolver
+  supportsTLD: typeof supportsTLD
+  transferController: typeof transferController
+  transferName: typeof transferName
+  transferSubname: typeof transferSubname
+  unwrapName: typeof unwrapName
+  wrapName: typeof wrapName
+}
+
+export default Function

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,22 +16,29 @@ 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')
     }
 
-    return nameWrapper.unwrapETH2LD(labelhash, newRegistrant, newController)
-  } else {
-    if (newRegistrant) {
-      throw new Error('newRegistrant can only be specified for .eth names')
-    }
-
-    return nameWrapper.unwrap(parentNodehash, labelhash, newController)
+    return nameWrapper.populateTransaction.unwrapETH2LD(
+      labelhash,
+      newRegistrant,
+      newController,
+    )
   }
+  if (newRegistrant) {
+    throw new Error('newRegistrant can only be specified for .eth names')
+  }
+
+  return nameWrapper.populateTransaction.unwrap(
+    parentNodehash,
+    labelhash,
+    newController,
+  )
 }