feat: auto fetch contract name from address (graphprotocol#1664)

* feat: auto fetch contract name from address

* fix: lint fix

* Create shaggy-ligers-carry.md

---------

Co-authored-by: Saihajpreet Singh <[email protected]>

.changeset/shaggy-ligers-carry.md

@@ -0,0 +1,5 @@
+---
+"@graphprotocol/graph-cli": minor
+---
+
+auto fetch contract name from address

packages/cli/src/command-helpers/abi.ts

@@ -44,6 +44,19 @@ export const loadStartBlockForContract = async (
     },
   );
 
+export const loadContractNameForAddress = async (
+  network: string,
+  address: string,
+): Promise<string> =>
+  await withSpinner(
+    `Fetching Contract Name`,
+    `Failed to fetch Contract Name`,
+    `Warnings while fetching contract name from Etherscan`,
+    async () => {
+      return getContractNameForAddress(network, address);
+    },
+  );
+
 export const fetchDeployContractTransactionFromEtherscan = async (
   network: string,
   address: string,
@@ -111,6 +124,36 @@ export const fetchTransactionByHashFromRPC = async (
   }
 };
 
+export const fetchSourceCodeFromEtherscan = async (
+  network: string,
+  address: string,
+): Promise<any> => {
+  const scanApiUrl = getEtherscanLikeAPIUrl(network);
+  const result = await fetch(
+    `${scanApiUrl}?module=contract&action=getsourcecode&address=${address}`,
+  );
+  const json = await result.json();
+  if (json.status === '1') {
+    return json;
+  }
+  throw new Error('Failed to fetch contract source code');
+};
+
+export const getContractNameForAddress = async (
+  network: string,
+  address: string,
+): Promise<string> => {
+  try {
+    const contractSourceCode = await fetchSourceCodeFromEtherscan(network, address);
+    const contractName = contractSourceCode.result[0].ContractName;
+    logger('Successfully getContractNameForAddress. contractName: %s', contractName);
+    return contractName;
+  } catch (error) {
+    logger('Failed to fetch getContractNameForAddress: %O', error);
+    throw new Error(error?.message);
+  }
+};
+
 export const getStartBlockForContract = async (
   network: string,
   address: string,

packages/cli/src/commands/add.ts

@@ -5,6 +5,7 @@ import { CLIError } from '@oclif/core/lib/errors';
 import {
   loadAbiFromBlockScout,
   loadAbiFromEtherscan,
+  loadContractNameForAddress,
   loadStartBlockForContract,
 } from '../command-helpers/abi';
 import * as DataSourcesExtractor from '../command-helpers/data-sources';
@@ -64,7 +65,7 @@ export default class AddCommand extends Command {
       args: { address, 'subgraph-manifest': manifestPath },
       flags: {
         abi,
-        'contract-name': contractName,
+        'contract-name': contractNameFlag,
         'merge-entities': mergeEntities,
         'network-file': networksFile,
         'start-block': startBlockFlag,
@@ -78,6 +79,7 @@ export default class AddCommand extends Command {
     const result = manifest.result.asMutable();
 
     let startBlock = startBlockFlag;
+    let contractName = contractNameFlag;
 
     const entities = getEntities(manifest);
     const contractNames = getContractNames(manifest);
@@ -119,6 +121,27 @@ export default class AddCommand extends Command {
       }
     }
 
+    try {
+      contractName = await loadContractNameForAddress(network, address);
+    } catch (error) {
+      // not asking user to do prompt in test environment
+      if (process.env.NODE_ENV !== 'test') {
+        const { contractName: userInputContractName } = await prompt.ask<{ contractName: string }>([
+          {
+            type: 'input',
+            name: 'contractName',
+            message: 'Contract Name',
+            initial: 'Contract',
+            validate: value => value && value.length > 0,
+            result(value) {
+              return value;
+            },
+          },
+        ]);
+        contractName = userInputContractName;
+      }
+    }
+
     await writeABI(ethabi, contractName);
 
     const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(

packages/cli/src/commands/init.ts

@@ -7,6 +7,7 @@ import { Args, Command, Flags, ux } from '@oclif/core';
 import {
   loadAbiFromBlockScout,
   loadAbiFromEtherscan,
+  loadContractNameForAddress,
   loadStartBlockForContract,
 } from '../command-helpers/abi';
 import { initNetworksConfig } from '../command-helpers/network';
@@ -717,6 +718,18 @@ async function processInitForm(
               initStartBlock = Number(startBlock).toString();
             }
           }
+
+          // If contract name is not set, try to load it.
+          if (!initContractName) {
+            // Load contract name for this contract
+            const contractName = await retryWithPrompt(() =>
+              loadContractNameForAddress(network, value),
+            );
+            if (contractName) {
+              initContractName = contractName;
+            }
+          }
+
           return value;
         },
       },
@@ -813,6 +826,10 @@ async function processInitForm(
         initial: initContractName || 'Contract' || isSubstreams,
         skip: () => initFromExample !== undefined || !protocolInstance.hasContract(),
         validate: value => value && value.length > 0,
+        result(value) {
+          if (initContractName) return initContractName;
+          return value;
+        },
       },
     ]);
 
@@ -1314,11 +1331,6 @@ async function addAnotherContract(
       this.log(`✖ ${error}`);
     }
 
-    const contractName = await ux.prompt('\nContract Name', {
-      required: true,
-      default: 'Contract',
-    });
-
     // Get the cwd before process.chdir in order to switch back in the end of command execution
     const cwd = process.cwd();
 
@@ -1327,7 +1339,7 @@ async function addAnotherContract(
         process.chdir(directory);
       }
 
-      const commandLine = [contract, '--contract-name', contractName];
+      const commandLine = [contract];
 
       await AddCommand.run(commandLine);
     } catch (e) {