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

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

@@ -1,7 +1,7 @@
 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 revert: Awaited<ReturnType<typeof setup>>['revert']
@@ -43,7 +43,8 @@ describe('setName', () => {
     )
     await setApprovedForAllTx?.wait()
 
-    const tx = await ENSInstance.setName('fleek.eth', accounts[0], undefined, {
+    const tx = await ENSInstance.setName('fleek.eth', {
+      address: accounts[0],
       addressOrIndex: 1,
     })
     expect(tx).toBeTruthy()

package/src/functions/setName.ts

@@ -1,34 +1,32 @@
 import { ENSArgs } from '..'
 
 export default async function (
-  { contracts, provider }: ENSArgs<'contracts' | 'provider'>,
+  { contracts, signer }: ENSArgs<'contracts' | 'signer'>,
   name: string,
-  address?: string,
-  resolver?: string,
-  options?: { addressOrIndex?: string | number },
+  {
+    address,
+    resolver,
+  }: {
+    address?: string
+    resolver?: string
+  } = {},
 ) {
-  const signerAddress = await provider
-    ?.getSigner(options?.addressOrIndex)
-    .getAddress()
-
-  if (!signerAddress) {
-    throw new Error('No signer found')
-  }
+  const signerAddress = await signer.getAddress()
 
   const reverseRegistrar = (await contracts?.getReverseRegistrar())?.connect(
-    provider?.getSigner()!,
-  )
+    signer,
+  )!
 
   if (address) {
-    const publicResolver = await contracts?.getPublicResolver()
+    const publicResolver = await contracts?.getPublicResolver()!
 
-    return reverseRegistrar?.setNameForAddr(
+    return reverseRegistrar.populateTransaction.setNameForAddr(
       address,
       signerAddress,
-      resolver || publicResolver!.address,
+      resolver || publicResolver.address,
       name,
     )
   }
 
-  return reverseRegistrar?.setName(name)
+  return reverseRegistrar.populateTransaction.setName(name)
 }

package/src/functions/setRecord.test.ts

@@ -0,0 +1,100 @@
+import { ENS } from '..'
+import setup from '../tests/setup'
+import { decodeContenthash } from '../utils/contentHash'
+import { hexEncodeName } from '../utils/hexEncodedName'
+import { namehash } from '../utils/normalise'
+
+let ENSInstance: ENS
+let revert: Awaited<ReturnType<typeof setup>>['revert']
+
+beforeAll(async () => {
+  ;({ ENSInstance, revert } = await setup())
+})
+
+afterAll(async () => {
+  await revert()
+})
+
+describe('setRecord', () => {
+  it('should allow a text record set', async () => {
+    const tx = await ENSInstance.setRecord('parthtejpal.eth', {
+      type: 'text',
+      record: { key: 'foo', value: 'bar' },
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    const universalResolver =
+      await ENSInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+    const encodedText = await universalResolver.resolve(
+      hexEncodeName('parthtejpal.eth'),
+      publicResolver.interface.encodeFunctionData('text', [
+        namehash('parthtejpal.eth'),
+        'foo',
+      ]),
+    )
+    const [resultText] = publicResolver.interface.decodeFunctionResult(
+      'text',
+      encodedText[0],
+    )
+    expect(resultText).toBe('bar')
+  })
+  it('should allow an address record set', async () => {
+    const tx = await ENSInstance.setRecord('parthtejpal.eth', {
+      type: 'addr',
+      record: {
+        key: 'ETC',
+        value: '0x42D63ae25990889E35F215bC95884039Ba354115',
+      },
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    const universalResolver =
+      await ENSInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+    const encodedAddr = await universalResolver.resolve(
+      hexEncodeName('parthtejpal.eth'),
+      publicResolver.interface.encodeFunctionData('addr(bytes32,uint256)', [
+        namehash('parthtejpal.eth'),
+        '61',
+      ]),
+    )
+    const [resultAddr] = publicResolver.interface.decodeFunctionResult(
+      'addr(bytes32,uint256)',
+      encodedAddr[0],
+    )
+    expect(resultAddr).toBe(
+      '0x42D63ae25990889E35F215bC95884039Ba354115'.toLowerCase(),
+    )
+  })
+  it('should allow a contenthash record set', async () => {
+    const tx = await ENSInstance.setRecord('parthtejpal.eth', {
+      type: 'contentHash',
+      record:
+        'ipns://k51qzi5uqu5dgox2z23r6e99oqency055a6xt92xzmyvpz8mwz5ycjavm0u150',
+    })
+    expect(tx).toBeTruthy()
+    await tx.wait()
+
+    const universalResolver =
+      await ENSInstance.contracts!.getUniversalResolver()!
+    const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
+    const encodedContent = await universalResolver.resolve(
+      hexEncodeName('parthtejpal.eth'),
+      publicResolver.interface.encodeFunctionData('contenthash', [
+        namehash('parthtejpal.eth'),
+      ]),
+    )
+    const [resultContent] = publicResolver.interface.decodeFunctionResult(
+      'contenthash',
+      encodedContent[0],
+    )
+    const content = decodeContenthash(resultContent)
+    expect(content.decoded).toBe(
+      'k51qzi5uqu5dgox2z23r6e99oqency055a6xt92xzmyvpz8mwz5ycjavm0u150',
+    )
+    expect(content.protocolType).toBe('ipns')
+  })
+})

package/src/functions/setRecord.ts

@@ -0,0 +1,63 @@
+import { ENSArgs } from '..'
+import { namehash } from '../utils/normalise'
+import {
+  generateSingleRecordCall,
+  RecordInput,
+  RecordTypes,
+} 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 <T extends RecordTypes>(
+  {
+    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,7 +1,7 @@
-import { utils } from 'ethers'
 import { ENS } from '..'
+import setup from '../tests/setup'
 import { hexEncodeName } from '../utils/hexEncodedName'
-import setup from './setup'
+import { namehash } from '../utils/normalise'
 
 let ENSInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
@@ -17,10 +17,12 @@ 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' }],
+      records: {
+        coinTypes: [
+          { key: 'ETC', value: '0x42D63ae25990889E35F215bC95884039Ba354115' },
+        ],
+        texts: [{ key: 'foo', value: 'bar' }],
+      },
     })
     expect(tx).toBeTruthy()
     await tx.wait()
@@ -30,20 +32,20 @@ describe('setRecords', () => {
     const publicResolver = await ENSInstance.contracts!.getPublicResolver()!
     const encodedText = await universalResolver.resolve(
       hexEncodeName('parthtejpal.eth'),
-      publicResolver.interface.encodeFunctionData('text(bytes32,string)', [
-        utils.namehash('parthtejpal.eth'),
+      publicResolver.interface.encodeFunctionData('text', [
+        namehash('parthtejpal.eth'),
         'foo',
       ]),
     )
     const encodedAddr = await universalResolver.resolve(
       hexEncodeName('parthtejpal.eth'),
       publicResolver.interface.encodeFunctionData('addr(bytes32,uint256)', [
-        utils.namehash('parthtejpal.eth'),
+        namehash('parthtejpal.eth'),
         '61',
       ]),
     )
     const [resultText] = publicResolver.interface.decodeFunctionResult(
-      'text(bytes32,string)',
+      'text',
       encodedText[0],
     )
     const [resultAddr] = publicResolver.interface.decodeFunctionResult(

package/src/functions/setRecords.ts

@@ -1,5 +1,5 @@
-import { ethers } from 'ethers'
 import { ENSArgs } from '..'
+import { namehash } from '../utils/normalise'
 import { generateRecordCallArray, RecordOptions } from '../utils/recordHelpers'
 
 export default async function (
@@ -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()!)
-  const namehash = ethers.utils.namehash(name)
+    await contracts?.getPublicResolver(provider, resolverToUse)
+  )?.connect(signer)!
+  const hash = namehash(name)
 
-  const calls: string[] = generateRecordCallArray(namehash, records, resolver!)
+  const calls: string[] = generateRecordCallArray(hash, records, resolver!)
 
-  return resolver?.multicall(calls)
+  return resolver.populateTransaction.multicall(calls)
 }

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

@@ -1,7 +1,7 @@
 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 revert: Awaited<ReturnType<typeof setup>>['revert']
@@ -20,11 +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',
-      'registry',
-      '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
-    )
+    const tx = await ENSInstance.setResolver('parthtejpal.eth', {
+      contract: 'registry',
+      resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
@@ -37,16 +36,14 @@ describe('setResolver', () => {
   })
   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],
-    )
+    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
+      wrappedOwner: accounts[0],
+    })
     await wrapNameTx.wait()
-    const tx = await ENSInstance.setResolver(
-      'parthtejpal.eth',
-      'nameWrapper',
-      '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
-    )
+    const tx = await ENSInstance.setResolver('parthtejpal.eth', {
+      contract: 'nameWrapper',
+      resolver: '0xAEfF4f4d8e2cB51854BEa2244B3C5Fb36b41C7fC',
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 

package/src/functions/setResolver.ts

@@ -1,37 +1,32 @@
-import { ethers } from 'ethers'
 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
   }
 
   switch (contract) {
     case 'registry': {
-      const registry = (await contracts?.getRegistry())!.connect(
-        provider?.getSigner(options?.addressOrIndex)!,
-      )
-      return registry.setResolver(ethers.utils.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(ethers.utils.namehash(name), resolver)
     }
     default: {
       throw new Error(`Unknown contract: ${contract}`)

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

@@ -1,6 +1,7 @@
 import { ethers, utils } from 'ethers'
 import { ENS } from '..'
-import setup from './setup'
+import setup from '../tests/setup'
+import { namehash } from '../utils/normalise'
 
 let ENSInstance: ENS
 let revert: Awaited<ReturnType<typeof setup>>['revert']
@@ -21,12 +22,11 @@ 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('parthtejpal.eth', {
+      contract: 'baseRegistrar',
+      newOwner: accounts[1],
+      addressOrIndex: 0,
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
@@ -37,44 +37,43 @@ describe('transferName', () => {
     expect(result).toBe(accounts[1])
   })
   it('should allow a transfer on the namewrapper', async () => {
-    const wrapNameTx = await ENSInstance.wrapName(
-      'parthtejpal.eth',
-      accounts[0],
-    )
+    const wrapNameTx = await ENSInstance.wrapName('parthtejpal.eth', {
+      wrappedOwner: accounts[0],
+    })
     await wrapNameTx.wait()
-    const tx = await ENSInstance.transferName(
-      'parthtejpal.eth',
-      accounts[1],
-      'nameWrapper',
-      { addressOrIndex: 0 },
-    )
+    const tx = await ENSInstance.transferName('parthtejpal.eth', {
+      newOwner: accounts[1],
+      contract: 'nameWrapper',
+      addressOrIndex: 0,
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const nameWrapper = await ENSInstance.contracts!.getNameWrapper()!
-    const result = await nameWrapper.ownerOf(utils.namehash('parthtejpal.eth'))
+    const result = await nameWrapper.ownerOf(namehash('parthtejpal.eth'))
     expect(result).toBe(accounts[1])
   })
   it('should allow a transfer on the registry', async () => {
-    const createSubnameTx = await ENSInstance.createSubname({
-      name: 'test.parthtejpal.eth',
-      contract: 'registry',
-      owner: accounts[0],
-      options: { addressOrIndex: accounts[0] },
-    })
-    await createSubnameTx.wait()
-
-    const tx = await ENSInstance.transferName(
+    const createSubnameTx = await ENSInstance.createSubname(
       'test.parthtejpal.eth',
-      accounts[1],
-      'registry',
-      { addressOrIndex: accounts[0] },
+      {
+        contract: 'registry',
+        owner: accounts[0],
+        addressOrIndex: accounts[0],
+      },
     )
+    await createSubnameTx.wait()
+
+    const tx = await ENSInstance.transferName('test.parthtejpal.eth', {
+      newOwner: accounts[1],
+      contract: 'registry',
+      addressOrIndex: accounts[0],
+    })
     expect(tx).toBeTruthy()
     await tx.wait()
 
     const registry = await ENSInstance.contracts!.getRegistry()!
-    const result = await registry.owner(utils.namehash('test.parthtejpal.eth'))
+    const result = await registry.owner(namehash('test.parthtejpal.eth'))
     expect(result).toBe(accounts[1])
   })
 })

package/src/functions/transferName.ts

@@ -1,50 +1,47 @@
 import { ethers } from 'ethers'
 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(ethers.utils.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,
-        ethers.utils.namehash(name),
+        namehash(name),
         1,
         '0x',
       )