@graphprotocol/graph-cli 0.37.2-alpha-20221219142030-0cf2a37 → 0.37.2

package/src/command-helpers/abi.js

@@ -1,5 +1,6 @@
 const { withSpinner } = require('./spinner')
 const fetch = require('node-fetch')
+const immutable = require('immutable')
 
 const loadAbiFromEtherscan = async (ABI, network, address) =>
   await withSpinner(
@@ -17,7 +18,7 @@ const loadAbiFromEtherscan = async (ABI, network, address) =>
       // a `result` field. The `status` is '0' in case of errors and '1' in
       // case of success
       if (json.status === '1') {
-        return new ABI('Contract', undefined, JSON.parse(json.result))
+        return new ABI('Contract', undefined, immutable.fromJS(JSON.parse(json.result)))
       } else {
         throw new Error('ABI not found, try loading it from a local file')
       }
@@ -41,7 +42,7 @@ const loadAbiFromBlockScout = async (ABI, network, address) =>
       // a `result` field. The `status` is '0' in case of errors and '1' in
       // case of success
       if (json.status === '1') {
-        return new ABI('Contract', undefined, JSON.parse(json.result))
+        return new ABI('Contract', undefined, immutable.fromJS(JSON.parse(json.result)))
       } else {
         throw new Error('ABI not found, try loading it from a local file')
       }

package/src/command-helpers/data-sources.js

@@ -1,3 +1,4 @@
+const immutable = require('immutable')
 const { loadManifest } = require('../migrations/util/load-manifest')
 
 // Loads manifest from file path and returns all:
@@ -12,15 +13,15 @@ const fromFilePath = async manifestPath => {
 
 const extractDataSourceByType = (manifest, dataSourceType, protocol) =>
   manifest
-    .get(dataSourceType, [])
+    .get(dataSourceType, immutable.List())
     .reduce(
       (dataSources, dataSource, dataSourceIndex) =>
       protocol.isValidKindName(dataSource.get('kind'))
       ? dataSources.push(
-        { path: [dataSourceType, dataSourceIndex], dataSource },
+        immutable.Map({ path: [dataSourceType, dataSourceIndex], dataSource }),
       )
       : dataSources,
-      []
+      immutable.List(),
     )
 
 // Extracts data sources and templates from a immutable manifest data structure

package/src/command-helpers/scaffold.js

@@ -9,6 +9,7 @@ const { generateEventIndexingHandlers } = require('../scaffold/mapping')
 const { generateEventType, abiEvents } = require('../scaffold/schema')
 const { generateTestsFiles } = require('../scaffold/tests')
 const { strings } = require('gluegun')
+const { Map } = require('immutable')
 
 const generateDataSource = async (
   protocol,
@@ -19,22 +20,15 @@ const generateDataSource = async (
 ) => {
   const protocolManifest = protocol.getManifestScaffold()
 
-  return {
-    kind: protocol.name,
-    name: contractName,
-    network: network,
-    source: yaml.parse(
-      prettier.format(
-        protocolManifest.source({ contract: contractAddress, contractName }),
-        { parser: 'yaml' },
-      ),
-    ),
-    mapping: yaml.parse(
-      prettier.format(protocolManifest.mapping({ abi, contractName }), {
-        parser: 'yaml',
-      }),
-    ),
-  }
+  return Map.of(
+    'kind', protocol.name,
+    'name', contractName,
+    'network', network,
+    'source', yaml.parse(prettier.format(protocolManifest.source({contract: contractAddress, contractName}),
+      {parser: 'yaml'})),
+    'mapping', yaml.parse(prettier.format(protocolManifest.mapping({abi, contractName}),
+      {parser: 'yaml'}))
+  ).asMutable()
 }
 
 const generateScaffold = async (
@@ -136,9 +130,11 @@ const writeMapping = async (abi, protocol, contractName, entities) => {
 
 const writeTestsFiles = async (abi, protocol, contractName) => {
   const hasEvents = protocol.hasEvents()
-  const events = hasEvents ? abiEvents(abi).toJS() : []
+  const events = hasEvents
+    ? abiEvents(abi).toJS()
+    : []
 
-  if (events.length > 0) {
+  if(events.length > 0) {
     // If a contract is added to a subgraph that has no tests folder
     await fs.ensureDir('./tests/')
 

package/src/command-helpers/spinner.js

@@ -1,4 +1,5 @@
 const chalk = require('chalk')
+const immutable = require('immutable')
 const toolbox = require('gluegun/toolbox')
 
 const step = (spinner, subject, text) => {

package/src/commands/add.js

@@ -1,16 +1,11 @@
 const chalk = require('chalk')
 const toolbox = require('gluegun/toolbox')
+const immutable = require('immutable')
 const { withSpinner } = require('../command-helpers/spinner')
 const Subgraph = require('../subgraph')
 const Protocol = require('../protocols')
 const DataSourcesExtractor = require('../command-helpers/data-sources')
-const {
-  generateDataSource,
-  writeABI,
-  writeSchema,
-  writeMapping,
-  writeTestsFiles,
-} = require('../command-helpers/scaffold')
+const { generateDataSource, writeABI, writeSchema, writeMapping, writeTestsFiles } = require('../command-helpers/scaffold')
 const { loadAbiFromEtherscan, loadAbiFromBlockScout } = require('../command-helpers/abi')
 const EthereumABI = require('../protocols/ethereum/abi')
 const { fixParameters } = require('../command-helpers/gluegun')
@@ -41,7 +36,7 @@ module.exports = {
       h,
       help,
       mergeEntities,
-      networkFile,
+      networkFile
     } = toolbox.parameters.options
 
     contractName = contractName || 'Contract'
@@ -59,8 +54,7 @@ module.exports = {
     }
 
     let address = toolbox.parameters.first || toolbox.parameters.array[0]
-    let manifestPath =
-      toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml'
+    let manifestPath = toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml'
 
     // Show help text if requested
     if (help || h) {
@@ -78,10 +72,7 @@ module.exports = {
     const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath)
     let protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     let manifest = await Subgraph.load(manifestPath, { protocol })
-    let network = manifest.result
-      .get('dataSources')
-      .get(0)
-      .get('network')
+    let network = manifest.result.get('dataSources').get(0).get('network')
     let result = manifest.result.asMutable()
 
     let entities = getEntities(manifest)
@@ -105,27 +96,17 @@ module.exports = {
       }
     }
 
-    let { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(
-      ethabi,
-      entities,
-      contractName,
-      mergeEntities,
-    )
+    let { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(ethabi, entities, contractName, mergeEntities)
     ethabi.data = abiData
 
     await writeABI(ethabi, contractName)
-    await writeSchema(ethabi, protocol, result.schema?.file, collisionEntities)
+    await writeSchema(ethabi, protocol, result.getIn(['schema', 'file']), collisionEntities)
     await writeMapping(ethabi, protocol, contractName, collisionEntities)
     await writeTestsFiles(ethabi, protocol, contractName)
 
     let dataSources = result.get('dataSources')
-    let dataSource = await generateDataSource(
-      protocol,
-      contractName,
-      network,
-      address,
-      ethabi,
-    )
+    let dataSource = await generateDataSource(protocol,
+      contractName, network, address, ethabi)
 
     // Handle the collisions edge case by copying another data source yaml data
     if (mergeEntities && onlyCollisions) {
@@ -145,7 +126,7 @@ module.exports = {
     await Subgraph.write(result, manifestPath)
 
     // Update networks.json
-    const networksFile = networkFile || './networks.json'
+    const networksFile = networkFile || "./networks.json"
     await updateNetworksFile(toolbox, network, contractName, address, networksFile)
 
     // Detect Yarn and/or NPM
@@ -165,26 +146,28 @@ module.exports = {
       'Warning during codegen',
       async spinner => {
         await system.run(yarn ? 'yarn codegen' : 'npm run codegen')
-      },
+      }
     )
-  },
+  }
 }
 
-const getEntities = manifest => {
-  let dataSources = manifest.result.get('dataSources', [])
-  let templates = manifest.result.get('templates', [])
+const getEntities = (manifest) => {
+  let dataSources = manifest.result.get('dataSources', immutable.List())
+  let templates = manifest.result.get('templates', immutable.List())
 
   return dataSources
     .concat(templates)
-    .map(dataSource => dataSource.mapping?.entities)
+    .map(dataSource => dataSource.getIn(['mapping', 'entities']))
     .flatten()
 }
 
-const getContractNames = manifest => {
-  let dataSources = manifest.result.get('dataSources', [])
-  let templates = manifest.result.get('templates', [])
+const getContractNames = (manifest) => {
+  let dataSources = manifest.result.get('dataSources', immutable.List())
+  let templates = manifest.result.get('templates', immutable.List())
 
-  return dataSources.concat(templates).map(dataSource => dataSource.get('name'))
+  return dataSources
+    .concat(templates)
+    .map(dataSource => dataSource.get('name'))
 }
 
 const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
@@ -196,7 +179,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
   for (let i = 0; i < abiData.size; i++) {
     let dataRow = abiData.get(i).asMutable()
 
-    if (dataRow.get('type') === 'event') {
+    if (dataRow.get('type') === 'event'){
       if (entities.indexOf(dataRow.get('name')) !== -1) {
         if (entities.indexOf(`${contractName}${dataRow.get('name')}`) !== -1) {
           print.error(`Contract name ('${contractName}')
@@ -207,7 +190,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
 
         if (mergeEntities) {
           collisionEntities.push(dataRow.get('name'))
-          abiData = abiData.delete(i)
+          abiData = abiData.asImmutable().delete(i) // needs to be immutable when deleting, yes you read that right - https://github.com/immutable-js/immutable-js/issues/1901
           i-- // deletion also shifts values to the left
           continue
         } else {
@@ -217,7 +200,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
         onlyCollisions = false
       }
     }
-    abiData = abiData.set(i, dataRow)
+    abiData = abiData.asMutable().set(i, dataRow)
   }
 
   return { abiData, collisionEntities, onlyCollisions }

package/src/compiler/index.js

@@ -1,6 +1,7 @@
 const chalk = require('chalk')
 const crypto = require('crypto')
 const fs = require('fs-extra')
+const immutable = require('immutable')
 const path = require('path')
 const yaml = require('js-yaml')
 const toolbox = require('gluegun/toolbox')
@@ -140,12 +141,12 @@ class Compiler {
       files.push(this.options.subgraphManifest)
 
       // Add all file paths specified in manifest
-      files.push(path.resolve(subgraph.schema?.file))
+      files.push(path.resolve(subgraph.getIn(['schema', 'file'])))
       subgraph.get('dataSources').map(dataSource => {
-        files.push(dataSource.mapping?.file)
+        files.push(dataSource.getIn(['mapping', 'file']))
         // Only watch ABI related files if the target protocol has support/need for them.
         if (this.protocol.hasABIs()) {
-          dataSource.mapping?.abis.map(abi => {
+          dataSource.getIn(['mapping', 'abis']).map(abi => {
             files.push(abi.get('file'))
           })
         }
@@ -257,7 +258,7 @@ class Compiler {
     }
 
     try {
-      let dataSourceName = dataSource.name
+      let dataSourceName = dataSource.getIn(['name'])
 
       let baseDir = this.sourceDir
       let absoluteMappingPath = path.resolve(baseDir, mappingPath)
@@ -551,7 +552,7 @@ class Compiler {
         updates.push({
           keyPath: ['schema', 'file'],
           value: await this._uploadFileToIPFS(
-            subgraph.schema?.file,
+            subgraph.getIn(['schema', 'file']),
             uploadedFiles,
             spinner,
           ),
@@ -559,7 +560,7 @@ class Compiler {
 
         if (this.protocol.hasABIs()) {
           for (let [i, dataSource] of subgraph.get('dataSources').entries()) {
-            for (let [j, abi] of dataSource.mapping?.abis.entries()) {
+            for (let [j, abi] of dataSource.getIn(['mapping', 'abis']).entries()) {
               updates.push({
                 keyPath: ['dataSources', i, 'mapping', 'abis', j, 'file'],
                 value: await this._uploadFileToIPFS(
@@ -578,7 +579,7 @@ class Compiler {
             updates.push({
               keyPath: ['dataSources', i, 'mapping', 'file'],
               value: await this._uploadFileToIPFS(
-                dataSource.mapping?.file,
+                dataSource.getIn(['mapping', 'file']),
                 uploadedFiles,
                 spinner,
               ),
@@ -589,7 +590,7 @@ class Compiler {
             updates.push({
               keyPath: ['dataSources', i, 'source', 'package', 'file'],
               value: await this._uploadFileToIPFS(
-                dataSource.source', 'package?.file,
+                dataSource.getIn(['source', 'package', 'file']),
                 uploadedFiles,
                 spinner,
               ),
@@ -597,9 +598,9 @@ class Compiler {
           }
         }
 
-        for (let [i, template] of subgraph.get('templates', []).entries()) {
+        for (let [i, template] of subgraph.get('templates', immutable.List()).entries()) {
           if (this.protocol.hasABIs()) {
-            for (let [j, abi] of template.mapping?.abis.entries()) {
+            for (let [j, abi] of template.getIn(['mapping', 'abis']).entries()) {
               updates.push({
                 keyPath: ['templates', i, 'mapping', 'abis', j, 'file'],
                 value: await this._uploadFileToIPFS(
@@ -614,7 +615,7 @@ class Compiler {
           updates.push({
             keyPath: ['templates', i, 'mapping', 'file'],
             value: await this._uploadFileToIPFS(
-              template.mapping?.file,
+              template.getIn(['mapping', 'file']),
               uploadedFiles,
               spinner,
             ),
@@ -660,7 +661,7 @@ class Compiler {
       '              ..',
       `${hash}${alreadyUploaded ? ' (already uploaded)' : ''}`,
     )
-    return { '/': `/ipfs/${hash}` }
+    return immutable.fromJS({ '/': `/ipfs/${hash}` })
   }
 
   async _uploadSubgraphDefinitionToIPFS(subgraph) {

package/src/protocols/arweave/subgraph.js

@@ -1,3 +1,5 @@
+const immutable = require('immutable')
+
 module.exports = class ArweaveSubgraph {
   constructor(options = {}) {
     this.manifest = options.manifest
@@ -6,10 +8,13 @@ module.exports = class ArweaveSubgraph {
   }
 
   validateManifest() {
-    return []
+    return immutable.List()
   }
 
   handlerTypes() {
-    return ['blockHandlers', 'transactionHandlers']
+    return immutable.List([
+      'blockHandlers',
+      'transactionHandlers',
+    ])
   }
 }

package/src/protocols/cosmos/subgraph.js

@@ -1,3 +1,5 @@
+const immutable = require('immutable')
+
 module.exports = class CosmosSubgraph {
   constructor(options = {}) {
     this.manifest = options.manifest
@@ -6,10 +8,15 @@ module.exports = class CosmosSubgraph {
   }
 
   validateManifest() {
-    return []
+    return immutable.List()
   }
 
   handlerTypes() {
-    return ['blockHandlers', 'eventHandlers', 'transactionHandlers', 'messageHandlers']
+    return immutable.List([
+      'blockHandlers',
+      'eventHandlers',
+      'transactionHandlers',
+      'messageHandlers',
+    ])
   }
 }

package/src/protocols/ethereum/abi.js

@@ -1,4 +1,5 @@
 const fs = require('fs-extra')
+const immutable = require('immutable')
 const path = require('path')
 
 const AbiCodeGenerator = require('./codegen/abi')
@@ -103,17 +104,17 @@ module.exports = class ABI {
   callFunctions() {
     // An entry is a function if its type is not set or if it is one of
     // 'constructor', 'function' or 'fallback'
-    let functionTypes = new Set(['constructor', 'function', 'fallback'])
+    let functionTypes = immutable.Set(['constructor', 'function', 'fallback'])
     let functions = this.data.filter(
-      entry => !entry.has('type') || functionTypes.has(entry.get('type')),
+      entry => !entry.has('type') || functionTypes.includes(entry.get('type')),
     )
 
     // A function is a call function if it is nonpayable, payable or
     // not constant
-    let mutabilityTypes =new Set(['nonpayable', 'payable'])
+    let mutabilityTypes = immutable.Set(['nonpayable', 'payable'])
     return functions.filter(
       entry =>
-        mutabilityTypes.has(entry.get('stateMutability')) ||
+        mutabilityTypes.includes(entry.get('stateMutability')) ||
         entry.get('constant') === false,
     )
   }
@@ -124,7 +125,7 @@ module.exports = class ABI {
       .map(entry => {
         const name = entry.get('name', '<default>')
         const inputs = entry
-          .get('inputs', [])
+          .get('inputs', immutable.List())
           .map(input => buildSignatureParameter(input))
 
         return `${name}(${inputs.join(',')})`
@@ -154,6 +155,6 @@ module.exports = class ABI {
       throw Error(`No valid ABI in file: ${path.relative(process.cwd(), file)}`)
     }
 
-    return new ABI(name, file, abi)
+    return new ABI(name, file, immutable.fromJS(abi))
   }
 }