fix: honor --contract-name and --start-block (#1778)

* fix: honor --contract-name and --start-block

* Improve `startBlock` validation

* Add changeset

* Add `startBlock` to test case

* Fix contract name uniqueness check

* Parse `startBlockFlag` only if defined

* Fix lint

* remove default value for `--contract-name`

* fix add command exit

* lint

---------

Co-authored-by: Etienne Donneger <[email protected]>
Co-authored-by: YaroShkvorets <[email protected]>

Author: 3 people

.changeset/@graphprotocol_graph-cli-1829-dependencies.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+Fix `graph add` flag parameters parsing

.changeset/heavy-socks-cross.md

@@ -18,6 +18,8 @@ import EthereumABI from '../protocols/ethereum/abi.js';
 import Protocol from '../protocols/index.js';
 import Subgraph from '../subgraph.js';
 
+const DEFAULT_CONTRACT_NAME = 'Contract';
+
 export default class AddCommand extends Command {
   static description = 'Adds a new datasource to a subgraph.';
 
@@ -36,14 +38,14 @@ export default class AddCommand extends Command {
       char: 'h',
     }),
     abi: Flags.string({
-      summary: 'Path to the contract ABI.',
+      summary: 'Path to the contract ABI. If not provided, will be fetched from contract API.',
     }),
     'start-block': Flags.string({
-      summary: 'The block number to start indexing events from.',
+      summary:
+        'The block number to start indexing events from. If not provided, will be fetched from contract API',
     }),
     'contract-name': Flags.string({
-      summary: 'Name of the contract.',
-      default: 'Contract',
+      summary: 'Name of the contract. If not provided, will be fetched from contract API',
     }),
     'merge-entities': Flags.boolean({
       summary: 'Whether to merge entities with the same name.',
@@ -79,17 +81,8 @@ export default class AddCommand extends Command {
     const registry = await loadRegistry();
     const contractService = new ContractService(registry);
 
-    let startBlock = startBlockFlag;
-    let contractName = contractNameFlag;
-
-    const entities = getEntities(manifest);
-    const contractNames = getContractNames(manifest);
-    if (contractNames.includes(contractName)) {
-      this.error(
-        `Datasource or template with name ${contractName} already exists, please choose a different name.`,
-        { exit: 1 },
-      );
-    }
+    let startBlock = startBlockFlag ? parseInt(startBlockFlag).toString() : startBlockFlag;
+    let contractName = contractNameFlag || DEFAULT_CONTRACT_NAME;
 
     let ethabi = null;
     if (abi) {
@@ -103,44 +96,36 @@ export default class AddCommand extends Command {
             'Fetching ABI from contract API...',
             'Failed to fetch ABI',
             'Warning fetching ABI',
-            () => contractService?.getABI(EthereumABI, network, address),
+            () => contractService.getABI(EthereumABI, network, address),
           ),
         );
+        if (!ethabi) throw Error;
       } catch (error) {
         // we cannot ask user to do prompt in test environment
         if (process.env.NODE_ENV !== 'test') {
-          const { abi: abiFromFile } = await prompt.ask<{ abi: EthereumABI }>([
+          const { abi: abiFile } = await prompt.ask<{ abi: string }>([
             {
               type: 'input',
               name: 'abi',
               message: 'ABI file (path)',
-              initial: ethabi,
               validate: async (value: string) => {
                 try {
                   EthereumABI.load(contractName, value);
                   return true;
                 } catch (e) {
-                  this.error(e.message);
-                }
-              },
-              result: async (value: string) => {
-                try {
-                  return EthereumABI.load(contractName, value);
-                } catch (e) {
-                  return e.message;
+                  return `Failed to load ABI from ${value}: ${e.message}`;
                 }
               },
             },
           ]);
-          ethabi = abiFromFile;
+          ethabi = EthereumABI.load(contractName, abiFile);
         }
       }
     }
 
     try {
       if (isLocalHost) throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
-
-      startBlock ||= Number(await contractService?.getStartBlock(network, address)).toString();
+      startBlock ||= Number(await contractService.getStartBlock(network, address)).toString();
     } catch (error) {
       // we cannot ask user to do prompt in test environment
       if (process.env.NODE_ENV !== 'test') {
@@ -163,8 +148,10 @@ export default class AddCommand extends Command {
 
     try {
       if (isLocalHost) throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
-
-      contractName = (await contractService?.getContractName(network, address)) ?? '';
+      if (contractName === DEFAULT_CONTRACT_NAME) {
+        contractName =
+          (await contractService.getContractName(network, address)) ?? DEFAULT_CONTRACT_NAME;
+      }
     } catch (error) {
       // not asking user to do prompt in test environment
       if (process.env.NODE_ENV !== 'test') {
@@ -184,6 +171,15 @@ export default class AddCommand extends Command {
       }
     }
 
+    const entities = getEntities(manifest);
+    const contractNames = getContractNames(manifest);
+    if (contractNames.includes(contractName)) {
+      this.error(
+        `Datasource or template with name ${contractName} already exists, please choose a different name.`,
+        { exit: 1 },
+      );
+    }
+
     await writeABI(ethabi, contractName);
 
     const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(
@@ -246,9 +242,14 @@ export default class AddCommand extends Command {
       });
     }
 
-    await withSpinner('Running codegen', 'Failed to run codegen', 'Warning during codegen', () =>
-      system.run(yarn ? 'yarn codegen' : 'npm run codegen'),
+    await withSpinner(
+      'Running codegen',
+      'Failed to run codegen',
+      'Warning during codegen',
+      async () => await system.run(yarn ? 'yarn codegen' : 'npm run codegen'),
     );
+
+    this.exit(0);
   }
 }
 

packages/cli/src/commands/add.ts

@@ -19,6 +19,8 @@ describe('Add command', () => {
         '0x2E645469f354BB4F5c8a05B3b30A929361cf77eC',
         '--contract-name',
         'Gravatar',
+        '--start-block',
+        '6175244',
         '--abi',
         `${EXAMPLE_SUBGRAPH_PATH}/abis/Gravity.json`,
       ],

packages/cli/tests/cli/add.test.ts

@@ -32,6 +32,7 @@ dataSources:
     source:
       address: "0x2E645469f354BB4F5c8a05B3b30A929361cf77eC"
       abi: Gravatar
+      startBlock: 6175244
     mapping:
       kind: ethereum/events
       apiVersion: 0.0.7