feat: Add ENS lookup methods

.github/workflows/cla.yml

@@ -20,6 +20,6 @@ jobs:
           path-to-signatures: 'signatures/version1/cla.json'
           path-to-cla-document: 'https://gnosis-safe.io/cla/'
           branch: 'cla-signatures'
-          allowlist: germartinez,mikheevm,rmeissner,Uxio0,dasanra,davidalbela,luarx,giacomolicari,lukasschor,tschubotz,gnosis-info,bot*,katspaugh
+          allowlist: germartinez,mikheevm,rmeissner,Uxio0,dasanra,davidalbela,luarx,giacomolicari,lukasschor,tschubotz,gnosis-info,bot*,katspaugh,usame-algan
           empty-commit-flag: false
           blockchain-storage-flag: false

.gitignore

@@ -58,3 +58,4 @@ deployments
 typechain
 
 openapi/
+.idea

packages/safe-core-sdk/package.json

@@ -90,6 +90,7 @@
     }
   },
   "dependencies": {
+    "@ensdomains/eth-ens-namehash": "^2.0.15",
     "@gnosis.pm/safe-core-sdk-types": "^0.1.1",
     "@gnosis.pm/safe-deployments": "^1.4.0",
     "ethereumjs-util": "^7.1.3"

packages/safe-core-sdk/src/ethereumLibs/EthAdapter.ts

@@ -48,6 +48,8 @@ interface EthAdapter {
   signMessage(message: string, signerAddress: string): Promise<string>
   estimateGas(transaction: EthAdapterTransaction, options?: string): Promise<number>
   call(transaction: EthAdapterTransaction): Promise<string>
+  ensLookup(name: string): Promise<string | null>
+  ensReverseLookup(address: string): Promise<string | null>
 }
 
 export default EthAdapter

packages/safe-core-sdk/src/ethereumLibs/EthersAdapter.ts

@@ -151,6 +151,14 @@ class EthersAdapter implements EthAdapter {
   call(transaction: EthAdapterTransaction): Promise<string> {
     return this.#provider.call(transaction)
   }
+
+  ensLookup(name: string): Promise<string | null> {
+    return this.#provider.resolveName(name)
+  }
+
+  ensReverseLookup(address: string): Promise<string | null> {
+    return this.#provider.lookupAddress(address);
+  }
 }
 
 export default EthersAdapter

packages/safe-core-sdk/src/ethereumLibs/Web3Adapter.ts

@@ -1,3 +1,5 @@
+import Web3 from 'web3'
+const namehash = require('@ensdomains/eth-ens-namehash')
 import { BigNumber } from '@ethersproject/bignumber'
 import { SafeVersion } from '../contracts/config'
 import {
@@ -18,13 +20,13 @@ import EthAdapter, { EthAdapterTransaction, GetSafeContractProps } from './EthAd
 
 export interface Web3AdapterConfig {
   /** web3 - Web3 library */
-  web3: any
+  web3: Web3
   /** signerAddress - Address of the signer */
   signerAddress: string
 }
 
 class Web3Adapter implements EthAdapter {
-  #web3: any
+  #web3: Web3
   #signerAddress: string
 
   constructor({ web3, signerAddress }: Web3AdapterConfig) {
@@ -105,7 +107,7 @@ class Web3Adapter implements EthAdapter {
     return getGnosisSafeProxyFactoryContractInstance(safeVersion, proxyFactoryContract)
   }
 
-  getContract(address: string, abi: AbiItem[]): any {
+  getContract(address: string, abi: any): any {
     return new this.#web3.eth.Contract(abi, address)
   }
 
@@ -125,13 +127,24 @@ class Web3Adapter implements EthAdapter {
     return this.#web3.eth.sign(message, this.#signerAddress)
   }
 
-  estimateGas(transaction: EthAdapterTransaction, options?: string): Promise<number> {
+  estimateGas(transaction: EthAdapterTransaction, options?: any): Promise<number> {
     return this.#web3.eth.estimateGas(transaction, options)
   }
 
   call(transaction: EthAdapterTransaction): Promise<string> {
     return this.#web3.eth.call(transaction)
   }
+
+  ensLookup(name: string): Promise<string> {
+    return this.#web3.eth.ens.getAddress(name)
+  }
+
+  async ensReverseLookup(address: string): Promise<string> {
+    const lookup = address.slice(-40) + '.addr.reverse'
+    const node = namehash.hash(lookup)
+    const ResolverContract = await this.#web3.eth.ens.getResolver(lookup);
+    return await ResolverContract.methods.name(node).call()
+  }
 }
 
 export default Web3Adapter

packages/safe-core-sdk/tests/ens.test.ts

@@ -0,0 +1,77 @@
+import Web3 from 'web3'
+import { ethers } from 'hardhat'
+import { Web3Adapter } from '../src'
+import { EthersAdapter } from '../dist/src'
+import { ZERO_ADDRESS } from '../src/utils/constants'
+import chai from 'chai'
+import { getDefaultProvider } from '@ethersproject/providers'
+import { Wallet } from '@ethersproject/wallet'
+
+describe('Web3Adapter', () => {
+  const web3 = new Web3(new Web3.providers.HttpProvider('https://rinkeby-light.eth.linkpool.io/', {}))
+  const web3Adapter = new Web3Adapter({web3, signerAddress: ZERO_ADDRESS})
+
+  describe('ENS direct lookup', () => {
+    it('returns an address for ens name', async () => {
+      const address = await web3Adapter.ensLookup('safe.eth')
+
+      chai.expect(address).match(/0x[0-9a-z]{40}/i)
+    })
+
+    it('throws an error for a non existing name', async () => {
+      try {
+        await web3Adapter.ensLookup('nonexistingname')
+      } catch(error) {
+        chai.expect((error as Error).message).to.equal('The resolver at 0x0000000000000000000000000000000000000000does not implement requested method: \"addr\".')
+      }
+    })
+  })
+
+  describe('ENS reverse lookup', () => {
+    it('returns a name for existing address', async () => {
+      const name = await web3Adapter.ensReverseLookup('0x203aBBf9F190009606C317439360c9f3c0874452')
+      chai.expect(name).to.equal("marco.eth")
+    })
+
+    it('throws an error if no name exists for address', async () => {
+      try {
+        await web3Adapter.ensReverseLookup('0x16B110D5b7583266B29159d89eF0d001adf6f6FD')
+      } catch(error: any) {
+        chai.expect(error.message).to.exist
+      }
+    })
+  })
+})
+
+describe('EthersAdapter', () => {
+  const provider = getDefaultProvider(`https://rinkeby.infura.io/v3/${process.env.INFURA_KEY}`)
+  const signer = new Wallet(
+    '0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d', // A Safe owner
+    provider
+  )
+  const ethersAdapter = new EthersAdapter({ ethers, signer })
+
+  describe('ENS direct lookup', () => {
+    it('returns an address for ens name', async () => {
+      const address = await ethersAdapter.ensLookup('safe.eth')
+      chai.expect(address).match(/0x[0-9a-z]{40}/i)
+    })
+
+    it('throws an error for a non existing name', async () => {
+      const address = await ethersAdapter.ensLookup('nonexistingname')
+      chai.expect(address).to.be.null
+    })
+  })
+
+  describe('ENS reverse lookup', () => {
+    it('returns a name for existing address', async () => {
+      const name = await ethersAdapter.ensReverseLookup('0x203aBBf9F190009606C317439360c9f3c0874452')
+      chai.expect(name).to.equal('marco.eth')
+    })
+
+    it('returns null if no name exists for address', async () => {
+      const name = await ethersAdapter.ensReverseLookup('0x16B110D5b7583266B29159d89eF0d001adf6f6FD')
+      chai.expect(name).to.be.null
+    })
+  })
+})

yarn.lock

@@ -654,6 +654,11 @@
     ethers "^5.0.13"
     js-sha3 "^0.8.0"
 
+"@ensdomains/eth-ens-namehash@^2.0.15":
+  version "2.0.15"
+  resolved "https://registry.yarnpkg.com/@ensdomains/eth-ens-namehash/-/eth-ens-namehash-2.0.15.tgz#5e5f2f24ba802aff8bc19edd822c9a11200cdf4a"
+  integrity sha512-JRDFP6+Hczb1E0/HhIg0PONgBYasfGfDheujmfxaZaAv/NAH4jE6Kf48WbqfRZdxt4IZI3jl3Ri7sZ1nP09lgw==
+
 "@ensdomains/[email protected]", "@ensdomains/resolver@^0.2.4":
   version "0.2.4"
   resolved "https://registry.yarnpkg.com/@ensdomains/resolver/-/resolver-0.2.4.tgz#c10fe28bf5efbf49bff4666d909aed0265efbc89"