commands/init, scaffold: Add contract name support to graph init

Author: steve pro

src/commands/init.js

@@ -33,11 +33,12 @@ ${chalk.dim('Options for --from-contract:')}
       --network <mainnet|kovan|rinkeby|ropsten|goerli|poa-core>
                                 Selects the network the contract is deployed to
       --index-events            Index contract events as entities
+      --contract-name           Name of the contract (default: Contract)      
 `
 
 const processInitForm = async (
   toolbox,
-  { abi, address, allowSimpleName, directory, fromExample, network, subgraphName },
+  {abi, address, allowSimpleName, directory, fromExample, network, subgraphName, contractName},
 ) => {
   let networkChoices = ['mainnet', 'kovan', 'rinkeby', 'ropsten', 'goerli', 'poa-core']
   let addressPattern = /^(0x)?[0-9a-fA-F]{40}$/
@@ -147,6 +148,18 @@ const processInitForm = async (
         }
       },
     },
+    {
+      type: 'input',
+      name: 'contractName',
+      message: 'Contract Name',
+      initial: contractName || 'Contract',
+      skip: () => fromExample !== undefined,
+      validate: value => value && value.length > 0,
+      result: value => {
+        contractName = value;
+        return value;
+      }
+    },
   ]
 
   try {
@@ -233,6 +246,7 @@ module.exports = {
       abi,
       allowSimpleName,
       fromContract,
+      contractName,
       fromExample,
       h,
       help,
@@ -338,6 +352,7 @@ module.exports = {
           indexEvents,
           network,
           subgraphName,
+          contractName,
         },
         { commands },
       )
@@ -352,6 +367,7 @@ module.exports = {
       fromExample,
       network,
       subgraphName,
+      contractName
     })
 
     // Exit immediately when the form is cancelled
@@ -382,6 +398,7 @@ module.exports = {
           network: inputs.network,
           address: inputs.address,
           indexEvents,
+          contractName: inputs.contractName
         },
         { commands },
       )
@@ -571,7 +588,7 @@ const initSubgraphFromExample = async (
 
 const initSubgraphFromContract = async (
   toolbox,
-  { allowSimpleName, subgraphName, directory, abi, network, address, indexEvents },
+  {allowSimpleName, subgraphName, directory, abi, network, address, indexEvents, contractName},
   { commands },
 ) => {
   let { print } = toolbox
@@ -609,6 +626,7 @@ const initSubgraphFromContract = async (
           network,
           address,
           indexEvents,
+          contractName,
         },
         spinner,
       )

src/scaffold.js

@@ -50,19 +50,19 @@ const generatePackageJson = ({ subgraphName }) =>
 
 // Subgraph manifest
 
-const generateManifest = ({ abi, address, network }) =>
+const generateManifest = ({ abi, address, network, contractName }) =>
   prettier.format(
     `
 specVersion: 0.0.1
 schema:
   file: ./schema.graphql
 dataSources:
   - kind: ethereum/contract
-    name: Contract
+    name: ${contractName}
     network: ${network}
     source:
       address: '${address}'
-      abi: Contract
+      abi: ${contractName}
     mapping:
       kind: ethereum/events
       apiVersion: 0.0.2
@@ -72,8 +72,8 @@ dataSources:
           .map(event => `- ${event.get('_alias')}`)
           .join('\n        ')}
       abis:
-        - name: Contract
-          file: ./abis/Contract.json
+        - name: ${contractName}
+          file: ./abis/${contractName}.json
       eventHandlers:
         ${abiEvents(abi)
           .map(
@@ -185,11 +185,11 @@ const generateEventFieldAssignments = event =>
     [],
   )
 
-const generateEventIndexingHandlers = events =>
+const generateEventIndexingHandlers = (events, contractName) =>
   `
   import { ${events.map(
     event => `${event._alias} as ${event._alias}Event`,
-  )}} from '../generated/Contract/Contract'
+  )}} from '../generated/${contractName}/${contractName}'
   import { ${events.map(event => event._alias)} } from '../generated/schema'
 
   ${events
@@ -208,11 +208,11 @@ const generateEventIndexingHandlers = events =>
     .join('\n')}
 `
 
-const generatePlaceholderHandlers = ({ abi, events }) =>
+const generatePlaceholderHandlers = ({ abi, events, contractName }) =>
   `
   import { BigInt } from '@graphprotocol/graph-ts'
-  import { Contract, ${events.map(event => event._alias)} }
-    from '../generated/Contract/Contract'
+  import { ${contractName}, ${events.map(event => event._alias)} }
+    from '../generated/${contractName}/${contractName}'
   import { ExampleEntity } from '../generated/schema'
 
   ${events
@@ -279,33 +279,33 @@ export function handle${event._alias}(event: ${event._alias}): void {}
     )
     .join('\n')}`
 
-const generateMapping = ({ abi, indexEvents }) => {
+const generateMapping = ({ abi, indexEvents, contractName }) => {
   let events = abiEvents(abi).toJS()
   return prettier.format(
     indexEvents
-      ? generateEventIndexingHandlers(events)
-      : generatePlaceholderHandlers({ abi, events: events }),
+      ? generateEventIndexingHandlers(events, contractName)
+      : generatePlaceholderHandlers({ abi, events: events, contractName }),
     { parser: 'typescript', semi: false },
   )
 }
 
 const generateScaffold = async (
-  { abi, address, network, subgraphName, indexEvents },
+  { abi, address, network, subgraphName, indexEvents, contractName='Contract' },
   spinner,
 ) => {
   step(spinner, 'Generate subgraph from ABI')
   let packageJson = generatePackageJson({ subgraphName })
-  let manifest = generateManifest({ abi, address, network })
-  let schema = generateSchema({ abi, indexEvents })
-  let mapping = generateMapping({ abi, subgraphName, indexEvents })
+  let manifest = generateManifest({ abi, address, network, contractName })
+  let schema = generateSchema({ abi, indexEvents, contractName })
+  let mapping = generateMapping({ abi, subgraphName, indexEvents, contractName })
 
   return {
     'package.json': packageJson,
     'subgraph.yaml': manifest,
     'schema.graphql': schema,
     src: { 'mapping.ts': mapping },
     abis: {
-      'Contract.json': prettier.format(JSON.stringify(abi.data), {
+      [`${contractName}.json`]: prettier.format(JSON.stringify(abi.data), {
         parser: 'json',
       }),
     },

src/scaffold.test.js

@@ -80,6 +80,7 @@ describe('Subgraph scaffolding', () => {
         abi: TEST_ABI,
         network: 'kovan',
         address: '0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d',
+        contractName: 'Contract'
       }),
     ).toEqual(`\
 specVersion: 0.0.1
@@ -146,7 +147,7 @@ type ExampleEvent1 @entity {
   })
 
   test('Mapping (default)', () => {
-    expect(generateMapping({ abi: TEST_ABI })).toEqual(`\
+    expect(generateMapping({ abi: TEST_ABI, contractName: 'Contract' })).toEqual(`\
 import { BigInt } from "@graphprotocol/graph-ts"
 import {
   Contract,
@@ -203,7 +204,7 @@ export function handleExampleEvent1(event: ExampleEvent1): void {}
   })
 
   test('Mapping (for indexing events)', () => {
-    expect(generateMapping({ abi: TEST_ABI, indexEvents: true })).toEqual(`\
+    expect(generateMapping({ abi: TEST_ABI, indexEvents: true, contractName: 'Contract' })).toEqual(`\
 import {
   ExampleEvent as ExampleEventEvent,
   ExampleEvent1 as ExampleEvent1Event