@ensdomains/ensjs 3.0.0-alpha.2 → 3.0.0-alpha.21

package/src/functions/setRecord.ts

@@ -0,0 +1,59 @@
+import { ENSArgs } from '..'
+import { namehash } from '../utils/normalise'
+import { generateSingleRecordCall, RecordInput } from '../utils/recordHelpers'
+
+type BaseInput = {
+  resolverAddress?: string
+}
+
+type ContentHashInput = {
+  record: RecordInput<'contentHash'>
+  type: 'contentHash'
+}
+
+type AddrOrTextInput = {
+  record: RecordInput<'addr' | 'text'>
+  type: 'addr' | 'text'
+}
+
+export default async function (
+  {
+    contracts,
+    provider,
+    getResolver,
+    signer,
+  }: ENSArgs<'contracts' | 'provider' | 'getResolver' | 'signer'>,
+  name: string,
+  {
+    record,
+    type,
+    resolverAddress,
+  }: BaseInput & (ContentHashInput | AddrOrTextInput),
+) {
+  if (!name.includes('.')) {
+    throw new Error('Input is not an ENS name')
+  }
+
+  let resolverToUse: string
+  if (resolverAddress) {
+    resolverToUse = resolverAddress
+  } else {
+    resolverToUse = await getResolver(name)
+  }
+
+  if (!resolverToUse) {
+    throw new Error('No resolver found for input address')
+  }
+
+  const resolver = (
+    await contracts?.getPublicResolver(provider, resolverToUse)
+  )?.connect(signer)!
+  const hash = namehash(name)
+
+  const call = generateSingleRecordCall(hash, resolver, type)(record)
+
+  return {
+    to: resolver.address,
+    data: call,
+  }
+}

package/src/{tests → functions}/setRecords.test.ts

@@ -1,13 +1,13 @@
 import { ENS } from '..'
+import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
 import { namehash } from '../utils/normalise'
-import setup from './setup'
 
-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,34 +16,37 @@ afterAll(async () => {
 
 describe('setRecords', () => {
   it('should return a transaction to the resolver and set successfully', async () => {
-    const tx = await ENSInstance.setRecords('parthtejpal.eth', {
-      coinTypes: [
-        { key: 'ETC', value: '0x42D63ae25990889E35F215bC95884039Ba354115' },
-      ],
-      texts: [{ key: 'foo', value: 'bar' }],
+    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()
 
     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('parthtejpal.eth'),
-      publicResolver.interface.encodeFunctionData('text(bytes32,string)', [
-        namehash('parthtejpal.eth'),
+      hexEncodeName('test123.eth'),
+      publicResolver.interface.encodeFunctionData('text', [
+        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',
       ]),
     )
     const [resultText] = publicResolver.interface.decodeFunctionResult(
-      'text(bytes32,string)',
+      'text',
       encodedText[0],
     )
     const [resultAddr] = publicResolver.interface.decodeFunctionResult(

package/src/functions/setRecords.ts

@@ -7,32 +7,38 @@ export default async function (
     contracts,
     provider,
     getResolver,
-  }: ENSArgs<'contracts' | 'provider' | 'getResolver'>,
+    signer,
+  }: ENSArgs<'contracts' | 'provider' | 'getResolver' | 'signer'>,
   name: string,
-  records: RecordOptions,
+  {
+    records,
+    resolverAddress,
+  }: {
+    records: RecordOptions
+    resolverAddress?: string
+  },
 ) {
   if (!name.includes('.')) {
     throw new Error('Input is not an ENS name')
   }
 
-  const resolverAddress = await getResolver(name)
-
-  if (!resolverAddress) {
-    throw new Error('No resolver found for input address')
+  let resolverToUse: string
+  if (resolverAddress) {
+    resolverToUse = resolverAddress
+  } else {
+    resolverToUse = await getResolver(name)
   }
 
-  const address = await provider?.getSigner().getAddress()
-
-  if (!address) {
-    throw new Error('No signer found')
+  if (!resolverToUse) {
+    throw new Error('No resolver found for input address')
   }
 
   const resolver = (
-    await contracts?.getPublicResolver(provider, resolverAddress)
-  )?.connect(provider?.getSigner()!)
+    await contracts?.getPublicResolver(provider, resolverToUse)
+  )?.connect(signer)!
   const hash = namehash(name)
 
   const calls: string[] = generateRecordCallArray(hash, records, resolver!)
 
-  return resolver?.multicall(calls)
+  return resolver.populateTransaction.multicall(calls)
 }

package/src/{tests → 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'
-import setup from './setup'
 
-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,40 +18,34 @@ describe('setResolver', () => {
     await revert()
   })
   it('should return a transaction to the registry and set successfully', async () => {
-    const tx = await ENSInstance.setResolver(
-      'parthtejpal.eth',
-      'registry',
-      '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
-    )
+    const tx = await ensInstance.setResolver('test123.eth', {
+      contract: 'registry',
+      resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+      addressOrIndex: 1,
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
+      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',
-      accounts[0],
-    )
-    await wrapNameTx.wait()
-    const tx = await ENSInstance.setResolver(
-      'parthtejpal.eth',
-      'nameWrapper',
-      '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
-    )
+    const tx = await ensInstance.setResolver('wrapped.eth', {
+      contract: 'nameWrapper',
+      resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+      addressOrIndex: 1,
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const universalResolver =
-      await ENSInstance.contracts!.getUniversalResolver()!
+      await ensInstance.contracts!.getUniversalResolver()!
     const [result] = await universalResolver.findResolver(
-      hexEncodeName('parthtejpal.eth'),
+      hexEncodeName('wrapped.eth'),
     )
     expect(result).toBe('0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC')
   })

package/src/functions/setResolver.ts

@@ -2,36 +2,31 @@ import { ENSArgs } from '..'
 import { namehash } from '../utils/normalise'
 
 export default async function (
-  { contracts, provider }: ENSArgs<'contracts' | 'provider'>,
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
   name: string,
-  contract: 'registry' | 'nameWrapper',
-  resolver?: string,
-  options?: { addressOrIndex?: string | number },
+  {
+    contract,
+    resolver,
+  }: {
+    contract: 'registry' | 'nameWrapper'
+    resolver?: string
+  },
 ) {
-  const address = await provider
-    ?.getSigner(options?.addressOrIndex)
-    .getAddress()
-
-  if (!address) {
-    throw new Error('No signer found')
-  }
-
   if (!resolver) {
-    resolver = (await contracts?.getPublicResolver()!).address
+    resolver = (await contracts!.getPublicResolver()!).address
   }
 
   switch (contract) {
     case 'registry': {
-      const registry = (await contracts?.getRegistry())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
-      )
-      return registry.setResolver(namehash(name), resolver)
+      const registry = (await contracts?.getRegistry())!.connect(signer)
+      return registry.populateTransaction.setResolver(namehash(name), resolver)
     }
     case 'nameWrapper': {
-      const nameWrapper = (await contracts?.getNameWrapper())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
+      const nameWrapper = (await contracts?.getNameWrapper())!.connect(signer)
+      return nameWrapper.populateTransaction.setResolver(
+        namehash(name),
+        resolver,
       )
-      return nameWrapper.setResolver(namehash(name), resolver)
     }
     default: {
       throw new Error(`Unknown contract: ${contract}`)

package/src/functions/transferName.test.ts

@@ -0,0 +1,65 @@
+import { ethers, utils } from 'ethers'
+import { ENS } from '..'
+import setup from '../tests/setup'
+import { namehash } from '../utils/normalise'
+
+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())
+  accounts = await provider.listAccounts()
+})
+
+afterAll(async () => {
+  await revert()
+})
+
+describe('transferName', () => {
+  beforeEach(async () => {
+    await revert()
+  })
+  it('should allow a transfer on the registrar', async () => {
+    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 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', {
+      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('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', {
+      newOwner: accounts[1],
+      contract: 'registry',
+      addressOrIndex: accounts[2],
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    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

@@ -3,46 +3,42 @@ 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,
+  }: {
+    newOwner: string
+    contract: 'registry' | 'nameWrapper' | 'baseRegistrar'
+  },
 ) {
-  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)'](
+      return baseRegistrar.populateTransaction[
+        'safeTransferFrom(address,address,uint256)'
+      ](
         address,
         newOwner,
         ethers.utils.solidityKeccak256(['string'], [labels[0]]),
       )
     }
     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

@@ -0,0 +1,55 @@
+import { ethers } from 'ethers'
+import { ENS } from '..'
+import setup from '../tests/setup'
+import { namehash } from '../utils/normalise'
+
+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())
+  accounts = await provider.listAccounts()
+})
+
+afterAll(async () => {
+  await revert()
+})
+
+describe('transferSubname', () => {
+  beforeEach(async () => {
+    await revert()
+  })
+  it('should allow transferring a subname on the registry', async () => {
+    const tx = await ensInstance.transferSubname('test.with-subnames.eth', {
+      contract: 'registry',
+      owner: accounts[1],
+      addressOrIndex: 1,
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    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(
+      '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])
+  })
+})

package/src/functions/transferSubname.ts

@@ -1,20 +1,30 @@
 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, 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])
@@ -22,14 +32,29 @@ export default async function (
 
   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/unwrapName.test.ts

@@ -0,0 +1,53 @@
+import { ethers, utils } from 'ethers'
+import { ENS } from '..'
+import setup from '../tests/setup'
+import { namehash } from '../utils/normalise'
+
+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())
+  accounts = await provider.listAccounts()
+})
+
+afterAll(async () => {
+  await revert()
+})
+
+describe('unwrapName', () => {
+  beforeEach(async () => {
+    await revert()
+  })
+  it('should return a .eth unwrap name transaction and succeed', async () => {
+    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'], ['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', {
+      newController: accounts[1],
+      addressOrIndex: 2,
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    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

@@ -3,37 +3,40 @@ 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 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,
+  )
 }