@graphprotocol/graph-cli 0.22.4 → 0.23.2

package/manifest-schema.graphql

@@ -6,7 +6,10 @@ type Schema {
   file: File!
 }
 
-union DataSource = EthereumContractDataSource
+union DataSource =
+  EthereumContractDataSource |
+  NearContractDataSource
+
 union DataSourceTemplate = EthereumContractDataSourceTemplate
 
 type EthereumContractDataSource {
@@ -17,14 +20,27 @@ type EthereumContractDataSource {
   mapping: EthereumContractMapping!
 }
 
+type NearContractDataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: NearContractSource!
+  mapping: NearContractMapping!
+}
+
 type EthereumContractSource {
   address: String
   abi: String!
   startBlock: BigInt
 }
 
+type NearContractSource {
+  account: String
+  startBlock: BigInt
+}
+
 type EthereumContractMapping {
-  kind: String!
+  kind: String
   apiVersion: String!
   language: String!
   file: File!
@@ -35,6 +51,15 @@ type EthereumContractMapping {
   eventHandlers: [EthereumContractEventHandler!]
 }
 
+type NearContractMapping {
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [NearBlockHandler!]
+  receiptHandlers: [NearReceiptHandler!]
+}
+
 type EthereumContractAbi {
   name: String!
   file: File!
@@ -49,11 +74,19 @@ type EthereumBlockFilter {
   kind: String!
 }
 
+type NearBlockHandler {
+  handler: String!
+}
+
 type EthereumCallHandler {
   function: String!
   handler: String!
 }
 
+type NearReceiptHandler {
+  handler: String!
+}
+
 type EthereumContractEventHandler {
   event: String!
   topic0: String

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.22.4",
+  "version": "0.23.2",
   "description": "CLI for building for and deploying to The Graph",
   "dependencies": {
     "assemblyscript": "0.19.10",
@@ -40,10 +40,6 @@
   "scripts": {
     "test": "jest --verbose",
     "test:init": "jest tests/cli/init.test.js --verbose",
-    "test:validation": "jest tests/cli/validation.test.js --verbose",
-    "release:patch": "npm version patch && npm publish && git push origin master && git push --tags",
-    "release:minor": "npm version minor && npm publish && git push origin master && git push --tags",
-    "release:alpha:minor": "npm version preminor --preid alpha && npm publish --tag alpha && git push origin master && git push --tags",
-    "release:alpha:prerelease": "npm version prerelease --preid alpha && npm publish --tag alpha && git push origin master && git push --tags"
+    "test:validation": "jest tests/cli/validation.test.js --verbose"
   }
 }

package/src/codegen/schema.js

@@ -23,8 +23,7 @@ module.exports = class SchemaCodeGenerator {
           // APIs
           'store',
 
-          // Basic Ethereum types
-          'Address',
+          // Basic Scalar types
           'Bytes',
           'BigInt',
           'BigDecimal',

package/src/codegen/template.js

@@ -3,14 +3,19 @@ const immutable = require('immutable')
 const tsCodegen = require('./typescript')
 
 module.exports = class DataSourceTemplateCodeGenerator {
-  constructor(template) {
+  constructor(template, protocol) {
     this.template = template
+    this.protocolTemplateCodeGen = protocol.getTemplateCodeGen(template)
   }
 
   generateModuleImports() {
     return [
       tsCodegen.moduleImports(
-        ['Address', 'DataSourceTemplate', 'DataSourceContext'],
+        [
+          ...this.protocolTemplateCodeGen.generateModuleImports(),
+          'DataSourceTemplate',
+          'DataSourceContext',
+        ],
         '@graphprotocol/graph-ts',
       ),
     ]
@@ -24,55 +29,8 @@ module.exports = class DataSourceTemplateCodeGenerator {
     let name = this.template.get('name')
 
     let klass = tsCodegen.klass(name, { export: true, extends: 'DataSourceTemplate' })
-    klass.addMethod(this._generateCreateMethod())
-    klass.addMethod(this._generateCreateWithContextMethod())
+    klass.addMethod(this.protocolTemplateCodeGen.generateCreateMethod())
+    klass.addMethod(this.protocolTemplateCodeGen.generateCreateWithContextMethod())
     return klass
   }
-
-  _generateCreateMethod() {
-    let name = this.template.get('name')
-    let kind = this.template.get('kind')
-
-    switch (kind) {
-      case 'ethereum/contract':
-        return tsCodegen.staticMethod(
-          'create',
-          [tsCodegen.param('address', tsCodegen.namedType('Address'))],
-          tsCodegen.namedType('void'),
-          `
-          DataSourceTemplate.create('${name}', [address.toHex()])
-          `,
-        )
-
-      default:
-        throw new Error(
-          `Data sources with kind != 'ethereum/contract' are not supported yet`,
-        )
-    }
-  }
-
-  _generateCreateWithContextMethod() {
-    let name = this.template.get('name')
-    let kind = this.template.get('kind')
-
-    switch (kind) {
-      case 'ethereum/contract':
-        return tsCodegen.staticMethod(
-          'createWithContext',
-          [
-            tsCodegen.param('address', tsCodegen.namedType('Address')),
-            tsCodegen.param('context', tsCodegen.namedType('DataSourceContext')),
-          ],
-          tsCodegen.namedType('void'),
-          `
-          DataSourceTemplate.createWithContext('${name}', [address.toHex()], context)
-          `,
-        )
-
-      default:
-        throw new Error(
-          `Data sources with kind != 'ethereum/contract' are not supported yet`,
-        )
-    }
-  }
 }

package/src/codegen/typescript.js

@@ -179,6 +179,10 @@ const klassMember = (name, type) => new ClassMember(name, type)
 const nullableType = type => new NullableType(type)
 const moduleImports = (nameOrNames, module) => new ModuleImports(nameOrNames, module)
 
+const GENERATED_FILE_NOTE = `
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+`
+
 module.exports = {
   // Types
   NullableType,
@@ -194,4 +198,7 @@ module.exports = {
   param,
   nullableType,
   moduleImports,
+
+  // Utilities
+  GENERATED_FILE_NOTE,
 }

package/src/command-helpers/compiler.js

@@ -4,7 +4,10 @@ const toolbox = require('gluegun/toolbox')
 const Compiler = require('../compiler')
 
 // Helper function to construct a subgraph compiler
-const createCompiler = (manifest, { ipfs, outputDir, outputFormat, skipMigrations, blockIpfsMethods }) => {
+const createCompiler = (
+  manifest,
+  { ipfs, outputDir, outputFormat, skipMigrations, blockIpfsMethods, protocol }
+) => {
   // Parse the IPFS URL
   let url
   try {
@@ -31,7 +34,8 @@ The IPFS URL must be of the following format: http(s)://host[:port]/[path]`)
     outputDir: outputDir,
     outputFormat: outputFormat,
     skipMigrations,
-    blockIpfsMethods
+    blockIpfsMethods,
+    protocol,
   })
 }
 

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

@@ -0,0 +1,38 @@
+const immutable = require('immutable')
+const { loadManifest } = require('../migrations/util/load-manifest')
+
+// Loads manifest from file path and returns all:
+// - data sources
+// - templates
+// In a single list.
+const fromFilePath = async manifestPath => {
+  const { dataSources = [], templates = [] } = await loadManifest(manifestPath)
+
+  return dataSources.concat(templates)
+}
+
+const extractDataSourceByType = (manifest, dataSourceType, protocol) =>
+  manifest
+    .get(dataSourceType, immutable.List())
+    .reduce(
+      (dataSources, dataSource, dataSourceIndex) =>
+      protocol.isValidKindName(dataSource.get('kind'))
+      ? dataSources.push(
+        immutable.Map({ path: [dataSourceType, dataSourceIndex], dataSource }),
+      )
+      : dataSources,
+      immutable.List(),
+    )
+
+// Extracts data sources and templates from a immutable manifest data structure
+const fromManifest = (manifest, protocol) => {
+  const dataSources = extractDataSourceByType(manifest, 'dataSources', protocol)
+  const templates = extractDataSourceByType(manifest, 'templates', protocol)
+
+  return dataSources.concat(templates)
+}
+
+module.exports = {
+  fromFilePath,
+  fromManifest,
+}

package/src/command-helpers/fs.js

@@ -0,0 +1,8 @@
+const path = require('path')
+
+const displayPath = p =>
+  path.relative(process.cwd(), p)
+
+module.exports = {
+  displayPath,
+}

package/src/commands/build.js

@@ -2,6 +2,8 @@ const chalk = require('chalk')
 
 const { createCompiler } = require('../command-helpers/compiler')
 const { fixParameters } = require('../command-helpers/gluegun')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
+const Protocol = require('../protocols')
 
 const HELP = `
 ${chalk.bold('graph build')} [options] ${chalk.bold('[<subgraph-manifest>]')}
@@ -73,11 +75,23 @@ module.exports = {
       return
     }
 
+    let protocol
+    try {
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
+    } catch (e) {
+      print.error(e.message)
+      process.exitCode = 1
+      return
+    }
+
     let compiler = createCompiler(manifest, {
       ipfs,
       outputDir,
       outputFormat,
       skipMigrations,
+      protocol,
     })
 
     // Exit with an error code if the compiler couldn't be created

package/src/commands/codegen.js

@@ -2,7 +2,9 @@ const chalk = require('chalk')
 const path = require('path')
 
 const TypeGenerator = require('../type-generator')
+const Protocol = require('../protocols')
 const { fixParameters } = require('../command-helpers/gluegun')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
 
 const HELP = `
@@ -60,6 +62,7 @@ module.exports = {
       return
     }
 
+    let protocol
     try {
       // Checks to make sure codegen doesn't run against
       // older subgraphs (both apiVersion and graph-ts version).
@@ -69,6 +72,10 @@ module.exports = {
       // the wrong AssemblyScript version.
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {
       print.error(e.message)
       process.exitCode = 1
@@ -79,6 +86,7 @@ module.exports = {
       subgraphManifest: manifest,
       outputDir: outputDir,
       skipMigrations,
+      protocol,
     })
 
     // Watch working directory for file updates or additions, trigger

package/src/commands/deploy.js

@@ -11,8 +11,9 @@ const { withSpinner } = require('../command-helpers/spinner')
 const { validateSubgraphName } = require('../command-helpers/subgraph')
 const { DEFAULT_IPFS_URL } = require('../command-helpers/ipfs')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
-const { loadManifest } = require('../migrations/util/load-manifest')
+const Protocol = require('../protocols')
 
 const HELP = `
 ${chalk.bold('graph deploy')} [options] ${chalk.bold('<subgraph-name>')} ${chalk.bold(
@@ -128,13 +129,9 @@ module.exports = {
         : filesystem.resolve('subgraph.yaml')
 
     try {
-      let manifestFile = await loadManifest(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
-      for (const { network } of manifestFile.dataSources || []) {
-        validateStudioNetwork({ studio, product, network })
-      }
-
-      for (const { network } of manifestFile.templates || []) {
+      for (const { network } of dataSourcesAndTemplates) {
         validateStudioNetwork({ studio, product, network })
       }
     } catch (e) {
@@ -192,6 +189,7 @@ module.exports = {
       return
     }
 
+    let protocol
     try {
       // Checks to make sure deploy doesn't run against
       // older subgraphs (both apiVersion and graph-ts version).
@@ -201,6 +199,10 @@ module.exports = {
       // using the wrong AssemblyScript compiler.
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {
       print.error(e.message)
       process.exitCode = 1
@@ -215,7 +217,8 @@ module.exports = {
       outputDir,
       outputFormat: 'wasm',
       skipMigrations,
-      blockIpfsMethods: isStudio  // Network does not support publishing subgraphs with IPFS methods
+      blockIpfsMethods: isStudio,  // Network does not support publishing subgraphs with IPFS methods
+      protocol,
     })
 
     // Exit with an error code if the compiler couldn't be created

package/src/commands/init.js

@@ -9,13 +9,14 @@ const {
   getSubgraphBasename,
   validateSubgraphName,
 } = require('../command-helpers/subgraph')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
 const { withSpinner, step } = require('../command-helpers/spinner')
 const { fixParameters } = require('../command-helpers/gluegun')
 const { chooseNodeUrl } = require('../command-helpers/node')
-const { loadManifest } = require('../migrations/util/load-manifest')
 const { abiEvents, generateScaffold, writeScaffold } = require('../scaffold')
-const ABI = require('../abi')
+// TODO: Use Protocol class to getABI
+const ABI = require('../protocols/ethereum/abi')
 
 const networkChoices = [
   'mainnet',
@@ -256,16 +257,25 @@ const loadAbiFromBlockScout = async (network, address) =>
     },
   )
 
+const getEtherscanLikeAPIUrl = (network) => {
+  switch(network){
+    case "mainnet": return `https://api.etherscan.io/api`;
+    case "bsc": return `https://api.bscscan.com/api`;
+    case "matic": return `https://api.polygonscan.com/api`;
+    case "mumbai": return `https://api-testnet.polygonscan.com/api`;
+    default: return `https://api-${network}.etherscan.io/api`;
+  }
+} 
+
 const loadAbiFromEtherscan = async (network, address) =>
   await withSpinner(
     `Fetching ABI from Etherscan`,
     `Failed to fetch ABI from Etherscan`,
     `Warnings while fetching ABI from Etherscan`,
     async spinner => {
+      const scanApiUrl = getEtherscanLikeAPIUrl(network);
       let result = await fetch(
-        `https://${
-          network === 'mainnet' ? 'api' : `api-${network}`
-        }.etherscan.io/api?module=contract&action=getabi&address=${address}`,
+        `${scanApiUrl}?module=contract&action=getabi&address=${address}`,
       )
       let json = await result.json()
 
@@ -529,12 +539,26 @@ const initRepository = async (toolbox, directory) =>
     },
   )
 
+// Only used for local testing / continuous integration.
+//
+// This requires that the command `npm link` is called
+// on the root directory of this repository, as described here:
+// https://docs.npmjs.com/cli/v7/commands/npm-link.
+const npmLinkToLocalCli = async (toolbox, directory) => {
+  if (process.env.GRAPH_CLI_TESTS) {
+    await toolbox.system.run('npm link @graphprotocol/graph-cli', { cwd: directory })
+  }
+}
+
 const installDependencies = async (toolbox, directory, installCommand) =>
   await withSpinner(
     `Install dependencies with ${toolbox.print.colors.muted(installCommand)}`,
     `Failed to install dependencies`,
     `Warnings while installing dependencies`,
     async spinner => {
+      // Links to local graph-cli if we're running the automated tests
+      await npmLinkToLocalCli(toolbox, directory)
+
       await toolbox.system.run(installCommand, { cwd: directory })
       return true
     },
@@ -613,13 +637,9 @@ const initSubgraphFromExample = async (
   try {
     // It doesn't matter if we changed the URL we clone the YAML,
     // we'll check it's network anyway. If it's a studio subgraph we're dealing with.
-    let manifestFile = await loadManifest(path.join(directory, 'subgraph.yaml'))
+    const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(path.join(directory, 'subgraph.yaml'))
 
-    for (const { network } of manifestFile.dataSources || []) {
-      validateStudioNetwork({ studio, product, network })
-    }
-
-    for (const { network } of manifestFile.templates || []) {
+    for (const { network } of dataSourcesAndTemplates) {
       validateStudioNetwork({ studio, product, network })
     }
   } catch (e) {
@@ -646,6 +666,11 @@ const initSubgraphFromExample = async (
         delete pkgJson['license']
         delete pkgJson['repository']
 
+        // Remove example's cli in favor of the local one (added via `npm link`)
+        if (process.env.GRAPH_CLI_TESTS) {
+          delete pkgJson['devDependencies']['@graphprotocol/graph-cli']
+        }
+
         // Write package.json
         await filesystem.write(pkgJsonFilename, pkgJson, { jsonIndent: 2 })
         return true

package/src/commands/test.js

@@ -11,6 +11,7 @@ ${chalk.dim('Options:')}
 
   -f  --force                   Overwrite folder + file when downloading
   -h, --help                    Show usage information
+  -l, --logs                    Logs to the console information about the OS, CPU model and download url (debugging purposes)
   -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
   `
 
@@ -21,12 +22,13 @@ module.exports = {
     let { print } = toolbox
 
     // Read CLI parameters
-    let { f, force, h, help, v, version } = toolbox.parameters.options
+    let { f, force, h, help, l, logs, v, version } = toolbox.parameters.options
     let datasource = toolbox.parameters.first
 
     // Support both long and short option variants
     force = force || f
     help = help || h
+    logs = logs || l
     version = version || v
 
     // Show help text if requested
@@ -35,48 +37,56 @@ module.exports = {
       return
     }
 
-    const platform = getPlatform();
+    const platform = getPlatform(logs)
     if (!version) {
-      let result = await fetch('https://api.github.com/repos/LimeChain/matchstick/releases/latest');
-      let json = await result.json();
-      version = json.tag_name;
+      let result = await fetch('https://api.github.com/repos/LimeChain/matchstick/releases/latest')
+      let json = await result.json()
+      version = json.tag_name
     }
 
-    const url = `https://github.com/LimeChain/matchstick/releases/download/${version}/${platform}`;
+    const url = `https://github.com/LimeChain/matchstick/releases/download/${version}/${platform}`
 
-    let binary = new Binary(platform, url, version);
-    await binary.install(force);
-    binary.run(datasource);
+    if (logs) {
+      console.log(`Download link: ${url}`)
+    }
+
+    let binary = new Binary(platform, url, version)
+    await binary.install(force)
+    datasource ? binary.run(datasource) : binary.run()
   }
 }
 
-function getPlatform() {
-  const type = os.type();
-  const arch = os.arch();
-  const release = os.release();
-  const cpuCore = os.cpus()[0];
-  const majorVersion = semver.major(release);
-  const isM1 = cpuCore.model.includes("Apple M1");
+function getPlatform(logs) {
+  const type = os.type()
+  const arch = os.arch()
+  const release = os.release()
+  const cpuCore = os.cpus()[0]
+  const majorVersion = semver.major(release)
+  const isM1 = cpuCore.model.includes("Apple M1")
+
+  if (logs) {
+    console.log(`OS type: ${type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`)
+  }
 
   if (arch === 'x64' || (arch === 'arm64' && isM1)) {
     if (type === 'Darwin') {
-      if (majorVersion === '19') {
-        return 'binary-macos-10.15';
-      } else if (majorVersion === '18') {
-        return 'binary-macos-10.14';
+      if (majorVersion === 19) {
+        return 'binary-macos-10.15'
+      } else if (majorVersion === 18) {
+        return 'binary-macos-10.14'
       } else if (isM1) {
-        return 'binary-macos-11-m1';
+        return 'binary-macos-11-m1'
       }
-      return 'binary-macos-11';
+      return 'binary-macos-11'
     } else if (type === 'Linux') {
-      if (majorVersion === '18') {
-        return 'binary-linux-18';
+      if (majorVersion === 18) {
+        return 'binary-linux-18'
       }
-      return 'binary-linux-20';
+      return 'binary-linux-20'
     } else if (type === 'Windows_NT') {
-      return 'binary-windows';
+      return 'binary-windows'
     }
   }
 
-  throw new Error(`Unsupported platform: ${type} ${arch} ${majorVersion}`);
+  throw new Error(`Unsupported platform: ${type} ${arch} ${majorVersion}`)
 }