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

package/src/protocols/ethereum/subgraph.js

@@ -1,4 +1,3 @@
-const immutable = require('immutable')
 const ABI = require('./abi')
 const DataSourcesExtractor = require('../../command-helpers/data-sources')
 
@@ -16,7 +15,10 @@ module.exports = class EthereumSubgraph {
   }
 
   validateAbis() {
-    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol)
+    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(
+      this.manifest,
+      this.protocol,
+    )
 
     return dataSourcesAndTemplates.reduce(
       (errors, dataSourceOrTemplate) =>
@@ -26,18 +28,18 @@ module.exports = class EthereumSubgraph {
             dataSourceOrTemplate.get('path'),
           ),
         ),
-      immutable.List(),
+      [],
     )
   }
 
   validateDataSourceAbis(dataSource, path) {
     // Validate that the the "source > abi" reference of all data sources
     // points to an existing ABI in the data source ABIs
-    let abiName = dataSource.getIn(['source', 'abi'])
-    let abiNames = dataSource.getIn(['mapping', 'abis']).map(abi => abi.get('name'))
+    let abiName = dataSource.source?.abi
+    let abiNames = dataSource.mapping?.abis.map(abi => abi.get('name'))
     let nameErrors = abiNames.includes(abiName)
-      ? immutable.List()
-      : immutable.fromJS([
+      ? []
+      : [
           {
             path: [...path, 'source', 'abi'],
             message: `\
@@ -48,61 +50,57 @@ ${abiNames
   .map(name => `- ${name}`)
   .join('\n')}`,
           },
-        ])
+        ]
 
     // Validate that all ABI files are valid
-    let fileErrors = dataSource
-      .getIn(['mapping', 'abis'])
-      .reduce((errors, abi, abiIndex) => {
-        try {
-          ABI.load(abi.get('name'), this.resolveFile(abi.get('file')))
-          return errors
-        } catch (e) {
-          return errors.push(
-            immutable.fromJS({
-              path: [...path, 'mapping', 'abis', abiIndex, 'file'],
-              message: e.message,
-            }),
-          )
-        }
-      }, immutable.List())
+    let fileErrors = dataSource.mapping?.abis.reduce((errors, abi, abiIndex) => {
+      try {
+        ABI.load(abi.get('name'), this.resolveFile(abi.get('file')))
+        return errors
+      } catch (e) {
+        return errors.push({
+          path: [...path, 'mapping', 'abis', abiIndex, 'file'],
+          message: e.message,
+        })
+      }
+    }, [])
 
     return nameErrors.concat(fileErrors)
   }
 
   validateEvents() {
-    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol)
+    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(
+      this.manifest,
+      this.protocol,
+    )
 
-    return dataSourcesAndTemplates
-      .reduce((errors, dataSourceOrTemplate) => {
-        return errors.concat(
-          this.validateDataSourceEvents(
-            dataSourceOrTemplate.get('dataSource'),
-            dataSourceOrTemplate.get('path'),
-          ),
-        )
-      }, immutable.List())
+    return dataSourcesAndTemplates.reduce((errors, dataSourceOrTemplate) => {
+      return errors.concat(
+        this.validateDataSourceEvents(
+          dataSourceOrTemplate.get('dataSource'),
+          dataSourceOrTemplate.get('path'),
+        ),
+      )
+    }, [])
   }
 
   validateDataSourceEvents(dataSource, path) {
     let abi
     try {
       // Resolve the source ABI name into a real ABI object
-      let abiName = dataSource.getIn(['source', 'abi'])
-      let abiEntry = dataSource
-        .getIn(['mapping', 'abis'])
-        .find(abi => abi.get('name') === abiName)
+      let abiName = dataSource.source?.abi
+      let abiEntry = dataSource.mapping?.abis.find(abi => abi.get('name') === abiName)
       abi = ABI.load(abiEntry.get('name'), this.resolveFile(abiEntry.get('file')))
     } catch (_) {
       // Ignore errors silently; we can't really say anything about
       // the events if the ABI can't even be loaded
-      return immutable.List()
+      return []
     }
 
     // Obtain event signatures from the mapping
-    let manifestEvents = dataSource
-      .getIn(['mapping', 'eventHandlers'], immutable.List())
-      .map(handler => handler.get('event'))
+    let manifestEvents = (dataSource.mapping?.eventHandlers || []).map(handler =>
+      handler.get('event'),
+    )
 
     // Obtain event signatures from the ABI
     let abiEvents = abi.eventSignatures()
@@ -113,19 +111,17 @@ ${abiNames
       (errors, manifestEvent, index) =>
         abiEvents.includes(manifestEvent)
           ? errors
-          : errors.push(
-              immutable.fromJS({
-                path: [...path, 'eventHandlers', index],
-                message: `\
+          : errors.push({
+              path: [...path, 'eventHandlers', index],
+              message: `\
 Event with signature '${manifestEvent}' not present in ABI '${abi.name}'.
 Available events:
 ${abiEvents
   .sort()
   .map(event => `- ${event}`)
   .join('\n')}`,
-              }),
-            ),
-      immutable.List(),
+            }),
+      [],
     )
   }
 
@@ -139,10 +135,8 @@ ${abiEvents
         let abi
         try {
           // Resolve the source ABI name into a real ABI object
-          let abiName = dataSource.getIn(['source', 'abi'])
-          let abiEntry = dataSource
-            .getIn(['mapping', 'abis'])
-            .find(abi => abi.get('name') === abiName)
+          let abiName = dataSource.source?.abi
+          let abiEntry = dataSource.mapping?.abis.find(abi => abi.get('name') === abiName)
           abi = ABI.load(abiEntry.get('name'), this.resolveFile(abiEntry.get('file')))
         } catch (e) {
           // Ignore errors silently; we can't really say anything about
@@ -151,9 +145,9 @@ ${abiEvents
         }
 
         // Obtain event signatures from the mapping
-        let manifestFunctions = dataSource
-          .getIn(['mapping', 'callHandlers'], immutable.List())
-          .map(handler => handler.get('function'))
+        let manifestFunctions = (dataSource.mapping?.callHandlers || []).map(handler =>
+          handler.get('function'),
+        )
 
         // Obtain event signatures from the ABI
         let abiFunctions = abi.callFunctionSignatures()
@@ -164,28 +158,22 @@ ${abiEvents
           (errors, manifestFunction, index) =>
             abiFunctions.includes(manifestFunction)
               ? errors
-              : errors.push(
-                  immutable.fromJS({
-                    path: [...path, index],
-                    message: `\
+              : errors.push({
+                  path: [...path, index],
+                  message: `\
 Call function with signature '${manifestFunction}' not present in ABI '${abi.name}'.
 Available call functions:
 ${abiFunctions
   .sort()
   .map(tx => `- ${tx}`)
   .join('\n')}`,
-                  }),
-                ),
+                }),
           errors,
         )
-      }, immutable.List())
+      }, [])
   }
 
   handlerTypes() {
-    return immutable.List([
-      'blockHandlers',
-      'callHandlers',
-      'eventHandlers',
-    ])
+    return ['blockHandlers', 'callHandlers', 'eventHandlers']
   }
 }

package/src/protocols/ethereum/type-generator.js

@@ -1,6 +1,5 @@
 const fs = require('fs-extra')
 const path = require('path')
-const immutable = require('immutable')
 const prettier = require('prettier')
 const ABI = require('./abi')
 const { step, withSpinner } = require('../../command-helpers/spinner')
@@ -24,21 +23,19 @@ module.exports = class EthereumTypeGenerator {
             .get('dataSources')
             .reduce(
               (abis, dataSource) =>
-              dataSource
-              .getIn(['mapping', 'abis'])
-              .reduce(
-                (abis, abi) =>
-                abis.push(
-                  this._loadABI(
-                    dataSource,
-                    abi.get('name'),
-                    abi.get('file'),
-                    spinner,
-                  ),
+                dataSource.mapping?.abis.reduce(
+                  (abis, abi) =>
+                    abis.push(
+                      this._loadABI(
+                        dataSource,
+                        abi.get('name'),
+                        abi.get('file'),
+                        spinner,
+                      ),
+                    ),
+                  abis,
                 ),
-                abis,
-              ),
-              immutable.List(),
+              [],
             )
         } catch (e) {
           throw Error(`Failed to load contract ABIs: ${e.message}`)
@@ -68,8 +65,8 @@ module.exports = class EthereumTypeGenerator {
       `Warnings while loading data source template ABIs`,
       async spinner => {
         let abis = []
-        for (let template of subgraph.get('templates', immutable.List())) {
-          for (let abi of template.getIn(['mapping', 'abis'])) {
+        for (let template of subgraph.get('templates', [])) {
+          for (let abi of template.mapping?.abis) {
             abis.push(
               this._loadDataSourceTemplateABI(
                 template,
@@ -89,11 +86,7 @@ module.exports = class EthereumTypeGenerator {
     try {
       if (this.sourceDir) {
         let absolutePath = path.resolve(this.sourceDir, maybeRelativePath)
-        step(
-          spinner,
-          `Load data source template ABI from`,
-          displayPath(absolutePath),
-        )
+        step(spinner, `Load data source template ABI from`, displayPath(absolutePath))
         return { template, abi: ABI.load(name, absolutePath) }
       } else {
         return { template, abi: ABI.load(name, maybeRelativePath) }
@@ -170,9 +163,7 @@ module.exports = class EthereumTypeGenerator {
       step(
         spinner,
         `Generate types for data source template ABI:`,
-        `${abi.template.get('name')} > ${abi.abi.name} (${displayPath(
-          abi.abi.file,
-        )})`,
+        `${abi.template.get('name')} > ${abi.abi.name} (${displayPath(abi.abi.file)})`,
       )
 
       let codeGenerator = abi.abi.codeGenerator()

package/src/protocols/index.js

@@ -1,4 +1,3 @@
-const immutable = require('immutable')
 const ArweaveSubgraph = require('./arweave/subgraph')
 const EthereumTypeGenerator = require('./ethereum/type-generator')
 const EthereumTemplateCodeGen = require('./ethereum/codegen/template')
@@ -54,7 +53,7 @@ class Protocol {
   }
 
   static availableProtocols() {
-    return immutable.fromJS({
+    return Object.freeze({
       // `ethereum/contract` is kept for backwards compatibility.
       // New networks (or protocol perhaps) shouldn't have the `/contract` anymore (unless a new case makes use of it).
       arweave: ['arweave'],
@@ -66,7 +65,7 @@ class Protocol {
   }
 
   static availableNetworks() {
-    let networks = immutable.fromJS({
+    let networks = {
       arweave: ['arweave-mainnet'],
       ethereum: [
         'mainnet',
@@ -106,14 +105,14 @@ class Protocol {
         'juno-1',
         'uni-3', // Juno testnet
       ],
-    })
+    }
 
     let allNetworks = []
     networks.forEach(value => {
       allNetworks.push(...value)
     })
 
-    networks = networks.set('substreams', immutable.fromJS(allNetworks))
+    networks['substreams'] = allNetworks
 
     return networks
   }
@@ -132,7 +131,7 @@ class Protocol {
   // for the given protocol instance (this).
   isValidKindName(kind) {
     return Protocol.availableProtocols()
-      .get(this.name, immutable.List())
+      .get(this.name, [])
       .includes(kind)
   }
 

package/src/protocols/near/subgraph.js

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

package/src/protocols/substreams/subgraph.js

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

package/src/scaffold/cosmos.test.js

@@ -1,4 +1,3 @@
-const immutable = require('immutable')
 const Scaffold = require('./')
 const Protocol = require('../protocols')
 

package/src/scaffold/ethereum.test.js

@@ -1,5 +1,4 @@
 const ABI = require('../protocols/ethereum/abi')
-const immutable = require('immutable')
 const Scaffold = require('./')
 const Protocol = require('../protocols')
 
@@ -61,12 +60,12 @@ const TEST_CALLABLE_FUNCTIONS = [
 const TEST_ABI = new ABI(
   'Contract',
   undefined,
-  immutable.fromJS([
+  [
     TEST_EVENT,
     OVERLOADED_EVENT,
     TEST_CONTRACT,
     ...TEST_CALLABLE_FUNCTIONS,
-  ]),
+  ],
 )
 
 const protocol = new Protocol('ethereum')

package/src/scaffold/near.test.js

@@ -1,4 +1,3 @@
-const immutable = require('immutable')
 const Scaffold = require('./')
 const Protocol = require('../protocols')
 

package/src/schema.js

@@ -1,6 +1,5 @@
 let fs = require('fs-extra')
 let graphql = require('graphql/language')
-let immutable = require('immutable')
 
 let SchemaCodeGenerator = require('./codegen/schema')
 
@@ -18,6 +17,6 @@ module.exports = class Schema {
   static async load(filename) {
     let document = await fs.readFile(filename, 'utf-8')
     let ast = graphql.parse(document)
-    return new Schema(filename, document, immutable.fromJS(ast))
+    return new Schema(filename, document, ast)
   }
 }

package/src/subgraph.js

@@ -1,5 +1,4 @@
 let fs = require('fs-extra')
-let immutable = require('immutable')
 let path = require('path')
 let yaml = require('yaml')
 let { strOptions } = require('yaml/types')
@@ -43,12 +42,12 @@ module.exports = class Subgraph {
   static async validate(data, protocol, { resolveFile }) {
     subgraphDebug(`Validating Subgraph with protocol "%s"`, protocol)
     if (protocol.name == null) {
-      return immutable.fromJS([
+      return [
         {
           path: [],
           message: `Unable to determine for which protocol manifest file is built for. Ensure you have at least one 'dataSources' and/or 'templates' elements defined in your subgraph.`,
         },
-      ])
+      ]
     }
 
     // Parse the default subgraph schema
@@ -69,7 +68,7 @@ module.exports = class Subgraph {
   }
 
   static validateSchema(manifest, { resolveFile }) {
-    let filename = resolveFile(manifest.getIn(['schema', 'file']))
+    let filename = resolveFile(manifest.schema?.file)
     let errors = validation.validateSchema(filename)
 
     if (errors.size > 0) {
@@ -106,29 +105,29 @@ module.exports = class Subgraph {
     const repository = manifest.get('repository')
 
     return /^https:\/\/github\.com\/graphprotocol\/example-subgraphs?$/.test(repository)
-      ? immutable.List().push(
-          immutable.fromJS({
+      ? [
+          {
             path: ['repository'],
             message: `\
 The repository is still set to ${repository}.
 Please replace it with a link to your subgraph source code.`,
-          }),
-        )
-      : immutable.List()
+          },
+        ]
+      : []
   }
 
   static validateDescription(manifest, { resolveFile }) {
     // TODO: Maybe implement this in the future for each protocol example description
     return manifest.get('description', '').startsWith('Gravatar for ')
-      ? immutable.List().push(
-          immutable.fromJS({
+      ? [
+          {
             path: ['description'],
             message: `\
 The description is still the one from the example subgraph.
 Please update it to tell users more about your subgraph.`,
-          }),
-        )
-      : immutable.List()
+          },
+        ]
+      : []
   }
 
   static validateHandlers(manifest, protocol, protocolSubgraph) {
@@ -151,27 +150,25 @@ Please update it to tell users more about your subgraph.`,
         }
 
         const areAllHandlersEmpty = handlerTypes
-          .map(handlerType => mapping.get(handlerType, immutable.List()))
+          .map(handlerType => mapping.get(handlerType, []))
           .every(handlers => handlers.isEmpty())
 
         const handlerNamesWithoutLast = handlerTypes.pop().join(', ')
 
         return areAllHandlersEmpty
-          ? errors.push(
-              immutable.fromJS({
-                path: path,
-                message: `\
+          ? errors.push({
+              path: path,
+              message: `\
 Mapping has no ${handlerNamesWithoutLast} or ${handlerTypes.get(-1)}.
 At least one such handler must be defined.`,
-              }),
-            )
+            })
           : errors
-      }, immutable.List())
+      }, [])
   }
 
   static validateContractValues(manifest, protocol) {
     if (!protocol.hasContract()) {
-      return immutable.List()
+      return []
     }
 
     return validation.validateContractValues(manifest, protocol)
@@ -184,38 +181,32 @@ At least one such handler must be defined.`,
       let path = ['dataSources', dataSourceIndex, 'name']
       let name = dataSource.get('name')
       if (names.includes(name)) {
-        errors = errors.push(
-          immutable.fromJS({
-            path,
-            message: `\
+        errors = errors.push({
+          path,
+          message: `\
 More than one data source named '${name}', data source names must be unique.`,
-          }),
-        )
+        })
       }
       names.push(name)
       return errors
-    }, immutable.List())
+    }, [])
   }
 
   static validateUniqueTemplateNames(manifest) {
     let names = []
-    return manifest
-      .get('templates', immutable.List())
-      .reduce((errors, template, templateIndex) => {
-        let path = ['templates', templateIndex, 'name']
-        let name = template.get('name')
-        if (names.includes(name)) {
-          errors = errors.push(
-            immutable.fromJS({
-              path,
-              message: `\
+    return manifest.get('templates', []).reduce((errors, template, templateIndex) => {
+      let path = ['templates', templateIndex, 'name']
+      let name = template.get('name')
+      if (names.includes(name)) {
+        errors = errors.push({
+          path,
+          message: `\
 More than one template named '${name}', template names must be unique.`,
-            }),
-          )
-        }
-        names.push(name)
-        return errors
-      }, immutable.List())
+        })
+      }
+      names.push(name)
+      return errors
+    }, [])
   }
 
   static dump(manifest) {
@@ -250,7 +241,7 @@ More than one template named '${name}', template names must be unique.`,
       }
     }
 
-    let manifest = immutable.fromJS(data)
+    let manifest = data
 
     // Validate the schema
     Subgraph.validateSchema(manifest, { resolveFile })
@@ -262,14 +253,14 @@ More than one template named '${name}', template names must be unique.`,
     })
 
     let errors = skipValidation
-      ? immutable.List()
-      : immutable.List.of(
+      ? []
+      : [
           ...protocolSubgraph.validateManifest(),
           ...Subgraph.validateContractValues(manifest, protocol),
           ...Subgraph.validateUniqueDataSourceNames(manifest),
           ...Subgraph.validateUniqueTemplateNames(manifest),
           ...Subgraph.validateHandlers(manifest, protocol, protocolSubgraph),
-        )
+        ]
 
     if (errors.size > 0) {
       throwCombinedError(filename, errors)
@@ -277,11 +268,11 @@ More than one template named '${name}', template names must be unique.`,
 
     // Perform warning validations
     let warnings = skipValidation
-      ? immutable.List()
-      : immutable.List.of(
+      ? []
+      : [
           ...Subgraph.validateRepository(manifest, { resolveFile }),
           ...Subgraph.validateDescription(manifest, { resolveFile }),
-        )
+        ]
 
     return {
       result: manifest,