Get ABI from Sourcify (#42)

* Experiment with getting ABI from Sourcify with collateral damage

* Add config.abiSource

* Fetch ABIs from Sourcify

* Fix lint error

* Add e2e test for abiSource Sourcify

* Use pascalCase instead of startCase without first space

* Add newlines to warnings for better visibility

* Print compilation diagnostics with path to the file

* Ignore outDirs in ESLint

* Remove unused zod schema

* Add missing dependencies to test-e2e

* Run format

* Throw when networkId is not found

* Register ts-node only if it is not registered already

* Test double ts-node registration

* Document abiSource and networkIds in README

* Add changeset for a bugfix

Author: hasparus

.changeset/lazy-frogs-tap.md

@@ -0,0 +1,5 @@
+---
+'@dethcrypto/eth-sdk': patch
+---
+
+Fix: Custom network identifiers in `config.contracts` don't fail config validation anymore.

.changeset/tame-pots-kneel.md

@@ -0,0 +1,5 @@
+---
+'@dethcrypto/eth-sdk': patch
+---
+
+Fetch contract ABIs from Sourcify when `config.abiSource` is set to `"sourcify'`.

.gitignore

@@ -3,7 +3,5 @@ dist
 yarn-error.log
 .DS_Store
 *.tsbuildinfo
-packages/tests/eth-sdk
-packages/tests/out
 .env
 examples/*/yarn.lock

.prettierignore

@@ -2,4 +2,5 @@ node_modules
 .vscode
 package.json
 **/dist/**
-packages/test-e2e/test/sdk
+packages/test-e2e/test/*/sdk
+packages/test-e2e/test/*/outDir

examples/hardhat/package.json

@@ -20,6 +20,6 @@
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "ethers": "^5.4.7",
     "hardhat": "^2.6.5",
-    "typescript": "^4.4.4"
+    "typescript": "^4"
   }
 }

examples/vite-react/package.json

@@ -32,7 +32,7 @@
     "@types/react-dom": "^17.0.0",
     "@vitejs/plugin-react": "^1.0.0",
     "concurrently": "^6.3.0",
-    "typescript": "^4.4.4",
+    "typescript": "^4",
     "vite": "^2.6.4"
   }
 }

package.json

@@ -51,7 +51,7 @@
     "proxyquire": "^2.1.3",
     "ts-essentials": "^9.0.0",
     "ts-node": "^10.4.0",
-    "typescript": "^4.4.4",
+    "typescript": "^4",
     "wsrun": "^5.2.4"
   }
 }

packages/eth-sdk/README.md

@@ -30,6 +30,8 @@
     - [`etherscanURLs`](#etherscanurls)
     - [`rpc`](#rpc)
     - [`noFollowProxies`](#nofollowproxies)
+    - [`abiSource`](#abisource)
+    - [`networkIds`](#networkids)
 - [Examples](#examples)
   - [Videos](#videos)
 - [Motivation and use cases](#motivation-and-use-cases)
@@ -168,7 +170,8 @@ Predefined network identifiers are:
 "arbitrumOne"        "arbitrumTestnet"
 ```
 
-You can configure your own Etherscan URLs in [`etherscanURLs`](#etherscanurls).
+You can use other networks, but you will need to configure Etherscan URLs for them in [`etherscanURLs`](#etherscanurls)
+or provide [`networkIds`](#networkids) when using Sourcify as `abiSource`.
 
 ### `outputPath`
 
@@ -235,6 +238,33 @@ You can opt out of proxy following by setting `noFollowProxies` flag in your con
 }
 ```
 
+### `abiSource`
+
+_Default: `"etherscan"`_
+
+One of `"etherscan"`, `"sourcify"`. Specifies the source to fetch contract ABIs from.
+
+### `networkIds`
+
+As Sourcify `/files` endpoint requires network identifier, you will need to provide one when using a custom network.
+
+```json
+{
+  "abiSource": "sourcify",
+  "networkIds": {
+    "myNetwork": 3
+  },
+  "contracts": {
+    "myNetwork": {
+      "dai": "0x6b175474e89094c44da98b954eedeac495271d0f"
+    }
+  }
+}
+```
+
+`eth-sdk` already knows ids of 19 commonly used networks, including mainnet, testnets, Optimism and Arbitrum, so you
+won't need to provide them. You can find the list of all predefined networks in [`contracts`](#contracts) documentation.
+
 # Examples
 
 Check out examples of using `eth-sdk` in [`/examples`][examples] directory.

packages/eth-sdk/package.json

@@ -53,9 +53,9 @@
     "zod": "^3.11.5"
   },
   "peerDependencies": {
-    "ethers": "^5",
-    "@ethersproject/abstract-provider": "^5",
     "@ethersproject/abi": "^5",
-    "@ethersproject/bignumber": "^5"
+    "@ethersproject/abstract-provider": "^5",
+    "@ethersproject/bignumber": "^5",
+    "ethers": "^5"
   }
 }

packages/eth-sdk/src/abi-management/etherscan/getAbiFromEtherscan.test.ts

@@ -5,13 +5,13 @@ import { parseAddress, UserEtherscanURLs } from '../../config'
 import { FetchJson } from '../../peripherals/fetchJson'
 import { Abi } from '../../types'
 import { UserProvidedNetworkSymbol } from '../networks'
-import { EtherscanResponse, getABIFromEtherscan } from './getAbiFromEtherscan'
+import { EtherscanResponse, getAbiFromEtherscan } from './getAbiFromEtherscan'
 
-describe(getABIFromEtherscan.name, () => {
+describe(getAbiFromEtherscan.name, () => {
   it('fetches from predefined etherscan URL', async () => {
     const apiKey = '{{ API_KEY }}'
     const fetch = mockEndpoint()
-    const actual = await getABIFromEtherscan('mainnet', DAI_ADDRESS, apiKey, {}, fetch)
+    const actual = await getAbiFromEtherscan('mainnet', DAI_ADDRESS, apiKey, {}, fetch)
 
     expect(actual).toEqual(RETURNED_ABI)
     expect(fetch).toHaveBeenCalledWith([
@@ -29,7 +29,7 @@ describe(getABIFromEtherscan.name, () => {
 
     const fetch = mockEndpoint()
 
-    const actual = await getABIFromEtherscan(symbol, ADDRESS_ZERO, apiKey, userNetworks, fetch)
+    const actual = await getAbiFromEtherscan(symbol, ADDRESS_ZERO, apiKey, userNetworks, fetch)
 
     expect(actual).toEqual(RETURNED_ABI)
     expect(fetch).toHaveBeenCalledWith([