feat(fetch): added contract name to output

BREAKING CHANGE: Output interface of getAbiAt was udpated from the ABI itself (string) to an object
containing the name of the contract and its ABI

Author: Rubilmax

package.json

@@ -1,6 +1,6 @@
 {
   "name": "etherscan-abi",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "⏬🚀 Fetch the most up-to-date ABI of a verified Smart Contract from Etherscan in seconds!",
   "main": "./lib/index.js",
   "bin": "./lib/cli.js",

src/cli.ts

@@ -77,9 +77,9 @@ const fetchAbis = () => {
   return Promise.all(
     options.contract.map(async (address) => {
       try {
-        const abi = await fetchAbiAt(address, options);
+        const { name, abi } = await fetchAbiAt(address, options);
 
-        const targetPath = path.join(options.target, `${address}.json`);
+        const targetPath = path.join(options.target, `${name}.json`);
         fs.writeFileSync(targetPath, JSON.stringify(abi, null, 2));
 
         console.log(

src/fetch.ts

@@ -6,10 +6,27 @@ import {
   EIP1967ImplementationNotFound,
 } from "@openzeppelin/upgrades-core";
 
-export interface EtherscanAbiResponse {
+interface EtherscanResponse {
   status: string;
   message: string;
-  result: string;
+}
+
+export interface EtherscanSourceCodeResponse extends EtherscanResponse {
+  result: {
+    SourceCode: string;
+    ABI: string;
+    ContractName: string;
+    CompilerVersion: string;
+    OptimizationUsed: string;
+    Runs: string;
+    ConstructorArguments: string;
+    EVMVersion: string;
+    Library: string;
+    LicenseType: string;
+    Proxy: string;
+    Implementation: string;
+    SwarmSource: string;
+  }[];
 }
 
 export const fetchAbiAt = async (
@@ -34,13 +51,20 @@ export const fetchAbiAt = async (
     }
   }
 
-  const res = await axios.get<EtherscanAbiResponse>(
-    new ethers.providers.EtherscanProvider(network, apiKey).getUrl("contract", {
-      action: "getabi",
+  const etherscan = new ethers.providers.EtherscanProvider(network, apiKey);
+  const res = await axios.get<EtherscanSourceCodeResponse>(
+    etherscan.getUrl("contract", {
+      action: "getsourcecode",
       address,
     })
   );
-  if (res.data.status !== "1") throw new Error(res.data.result);
 
-  return JSON.parse(res.data.result);
+  try {
+    return {
+      name: res.data.result[0].ContractName,
+      abi: JSON.parse(res.data.result[0].ABI),
+    };
+  } catch {
+    throw new Error(res.data.result[0].ABI);
+  }
 };

src/index.ts

@@ -1,2 +1,2 @@
 export { fetchAbiAt } from "./fetch";
-export type { EtherscanAbiResponse } from "./fetch";
+export type { EtherscanSourceCodeResponse } from "./fetch";