@ensdomains/ensjs 3.0.0-alpha.4 → 3.0.0-alpha.40

package/src/functions/transferName.test.ts

@@ -1,15 +1,15 @@
 import { ethers, utils } from 'ethers'
 import { ENS } from '..'
-import { namehash } from '../utils/normalise'
 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,60 +22,44 @@ describe('transferName', () => {
     await revert()
   })
   it('should allow a transfer on the registrar', async () => {
-    const tx = await ENSInstance.transferName(
-      'parthtejpal.eth',
-      accounts[1],
-      'baseRegistrar',
-      { addressOrIndex: 0 },
-    )
+    const tx = await ensInstance.transferName('test123.eth', {
+      contract: 'baseRegistrar',
+      newOwner: accounts[2],
+      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'], ['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',
-      accounts[0],
-    )
-    await wrapNameTx.wait()
-    const tx = await ENSInstance.transferName(
-      'parthtejpal.eth',
-      accounts[1],
-      'nameWrapper',
-      { addressOrIndex: 0 },
-    )
+    const tx = await ensInstance.transferName('wrapped.eth', {
+      newOwner: accounts[2],
+      contract: 'nameWrapper',
+      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 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 createSubnameTx = await ENSInstance.createSubname({
-      name: 'test.parthtejpal.eth',
+    const tx = await ensInstance.transferName('test.with-subnames.eth', {
+      newOwner: accounts[1],
       contract: 'registry',
-      owner: accounts[0],
-      options: { addressOrIndex: accounts[0] },
+      addressOrIndex: accounts[2],
     })
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferName(
-      'test.parthtejpal.eth',
-      accounts[1],
-      'registry',
-      { addressOrIndex: accounts[0] },
-    )
     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])
   })
 })

package/src/functions/transferName.ts

@@ -1,48 +1,49 @@
-import { ethers } from 'ethers'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
 
 export default async function (
-  { contracts, provider }: ENSArgs<'contracts' | 'provider'>,
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
   name: string,
-  newOwner: string,
-  contract: 'registry' | 'nameWrapper' | 'baseRegistrar',
-  options?: { addressOrIndex?: string | number },
+  {
+    newOwner,
+    contract,
+    reclaim,
+  }: {
+    newOwner: string
+    contract: 'registry' | 'nameWrapper' | 'baseRegistrar'
+    reclaim?: boolean
+  },
 ) {
-  const address = await provider
-    ?.getSigner(options?.addressOrIndex)
-    .getAddress()
-
-  if (!address) {
-    throw new Error('No signer found')
-  }
+  const address = await signer.getAddress()
 
   switch (contract) {
     case 'registry': {
-      const registry = (await contracts?.getRegistry())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
-      )
-      return registry.setOwner(namehash(name), newOwner)
+      const registry = (await contracts?.getRegistry())!.connect(signer)
+      return registry.populateTransaction.setOwner(namehash(name), newOwner)
     }
     case 'baseRegistrar': {
       const baseRegistrar = (await contracts?.getBaseRegistrar())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
+        signer,
       )
       const labels = name.split('.')
       if (labels.length > 2 || labels[labels.length - 1] !== 'eth') {
         throw new Error('Invalid name for baseRegistrar')
       }
-      return baseRegistrar['safeTransferFrom(address,address,uint256)'](
-        address,
-        newOwner,
-        ethers.utils.solidityKeccak256(['string'], [labels[0]]),
-      )
+      const tokenId = solidityKeccak256(['string'], [labels[0]])
+
+      // reclaim if sending manager on unwrapped name
+      if (reclaim) {
+        return baseRegistrar.populateTransaction.reclaim(tokenId, newOwner)
+      }
+
+      return baseRegistrar.populateTransaction[
+        'safeTransferFrom(address,address,uint256)'
+      ](address, newOwner, tokenId)
     }
     case 'nameWrapper': {
-      const nameWrapper = (await contracts?.getNameWrapper())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
-      )
-      return nameWrapper.safeTransferFrom(
+      const nameWrapper = (await contracts?.getNameWrapper())!.connect(signer)
+      return nameWrapper.populateTransaction.safeTransferFrom(
         address,
         newOwner,
         namehash(name),

package/src/functions/transferSubname.test.ts

@@ -1,15 +1,15 @@
 import { ethers } from 'ethers'
 import { ENS } from '..'
-import { namehash } from '../utils/normalise'
 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,52 +22,34 @@ describe('transferSubname', () => {
     await revert()
   })
   it('should allow transferring a subname on the registry', async () => {
-    const createSubnameTx = await ENSInstance.createSubname({
+    const tx = await ensInstance.transferSubname('test.with-subnames.eth', {
       contract: 'registry',
-      name: 'test.parthtejpal.eth',
-      owner: accounts[0],
-      options: { addressOrIndex: 0 },
+      owner: accounts[1],
+      addressOrIndex: 1,
     })
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferSubname(
-      'test.parthtejpal.eth',
-      'registry',
-      accounts[1],
-      { addressOrIndex: 0 },
-    )
     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',
-      accounts[0],
-    )
-    await wrapNameTx.wait()
-    const createSubnameTx = await ENSInstance.createSubname({
-      contract: 'nameWrapper',
-      name: 'test.parthtejpal.eth',
-      owner: accounts[0],
-      options: { addressOrIndex: 0 },
-    })
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferSubname(
-      'test.parthtejpal.eth',
-      'nameWrapper',
-      accounts[1],
-      { addressOrIndex: 0 },
+    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.parthtejpal.eth'))
+    const nameWrapper = await ensInstance.contracts!.getNameWrapper()!
+    const result = await nameWrapper.ownerOf(
+      namehash('test.wrapped-with-subnames.eth'),
+    )
     expect(result).toBe(accounts[1])
   })
 })

package/src/functions/transferSubname.ts

@@ -1,35 +1,60 @@
-import { ethers } from 'ethers'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
+import { Expiry, makeExpiry } 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, provider }: ENSArgs<'contracts' | 'provider'>,
+  {
+    contracts,
+    signer,
+    getExpiry,
+  }: ENSArgs<'contracts' | 'signer' | 'getExpiry'>,
   name: string,
-  contract: 'registry' | 'nameWrapper',
-  address: string,
-  options?: { addressOrIndex?: string | number },
+  { contract, owner, resolverAddress, ...wrapperArgs }: Args,
 ) {
-  const signer = provider?.getSigner(options?.addressOrIndex)
-
-  if (!signer) {
-    throw new Error('No signer found')
-  }
-
   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 = await makeExpiry(
+        { getExpiry },
+        labels.join('.'),
+        'expiry' in wrapperArgs ? wrapperArgs.expiry : undefined,
+      )
 
-      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,94 @@
+import type batch from './batch'
+import type {
+  multicallWrapper,
+  resolverMulticallWrapper,
+  universalWrapper,
+} from './batchWrappers'
+import type burnFuses from './burnFuses'
+import type commitName from './commitName'
+import type createSubname from './createSubname'
+import type deleteSubname from './deleteSubname'
+import type getAvailable from './getAvailable'
+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 {
+  getAddr,
+  getContentHash,
+  getText,
+  _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,
+  renewNameWithData,
+} from './renewNames'
+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
+  burnFuses: typeof burnFuses
+  commitName: typeof commitName
+  createSubname: typeof createSubname
+  deleteSubname: typeof deleteSubname
+  getAvailable: typeof getAvailable
+  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
+  _getAddr: typeof _getAddr
+  _getContentHash: typeof _getContentHash
+  _getText: typeof _getText
+  getSubnames: typeof getSubnames
+  getWrapperData: typeof getWrapperData
+  importDNSSECName: typeof importDNSSECName
+  registerName: typeof registerName
+  renewNames: typeof renewNames
+  renewNameWithData: typeof renewNameWithData
+  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

@@ -1,15 +1,15 @@
 import { ethers, utils } from 'ethers'
 import { ENS } from '..'
-import { namehash } from '../utils/normalise'
 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',
-      accounts[0],
-    )
-    await wrapNameTx.wait()
-
-    const tx = await ENSInstance.unwrapName(
-      'parthtejpal.eth',
-      accounts[0],
-      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',
-      accounts[0],
-    )
-    await wrapNameTx.wait()
-    const createSubnameTx = await ENSInstance.createSubname({
-      contract: 'nameWrapper',
-      name: 'test.parthtejpal.eth',
-      owner: accounts[0],
-      shouldWrap: true,
-      options: { addressOrIndex: 0 },
+    const tx = await ensInstance.unwrapName('test.wrapped-with-subnames.eth', {
+      newController: accounts[1],
+      addressOrIndex: 2,
     })
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.unwrapName('test.parthtejpal.eth', accounts[0])
     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,39 +1,43 @@
-import { utils } from 'ethers'
+import { keccak256 as solidityKeccak256 } from '@ethersproject/solidity'
+
 import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
 
 export default async function (
-  { contracts, provider }: ENSArgs<'contracts' | 'provider'>,
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
   name: string,
-  newController: string,
-  newRegistrant?: string,
-  options?: { addressOrIndex?: string | number },
+  {
+    newController,
+    newRegistrant,
+  }: {
+    newController: string
+    newRegistrant?: string
+  },
 ) {
-  const signer = provider?.getSigner(options?.addressOrIndex)
-
-  const address = await signer?.getAddress()
-
-  if (!signer || !address) {
-    throw new Error('No signer found')
-  }
-
   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 (!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,
+  )
 }