@graphprotocol/graph-cli 0.37.2 → 0.37.3-alpha-20230110163550-d64bef6

package/src/commands/remove.js

@@ -1,8 +1,8 @@
-const URL = require('url').URL
-const chalk = require('chalk')
-const { validateNodeUrl } = require('../command-helpers/node')
-const { identifyDeployKey: identifyAccessToken } = require('../command-helpers/auth')
-const { createJsonRpcClient } = require('../command-helpers/jsonrpc')
+import { URL } from 'url'
+import chalk from 'chalk'
+import { validateNodeUrl } from '../command-helpers/node'
+import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth'
+import { createJsonRpcClient } from '../command-helpers/jsonrpc'
 
 const HELP = `
 ${chalk.bold('graph remove')} ${chalk.dim('[options]')} ${chalk.bold('<subgraph-name>')}
@@ -14,7 +14,7 @@ ${chalk.dim('Options:')}
   -g, --node <url>              Graph node to create the subgraph in
 `
 
-module.exports = {
+export default {
   description: 'Unregisters a subgraph name',
   run: async toolbox => {
     // Obtain tools
@@ -73,21 +73,21 @@ module.exports = {
     }
 
     let spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`)
-    client.request('subgraph_remove', { name: subgraphName }, function(
-      requestError,
-      jsonRpcError,
-      res
-    ) {
-      if (jsonRpcError) {
-        spinner.fail(`Error removing the subgraph: ${jsonRpcError.message}`)
-        process.exitCode = 1
-      } else if (requestError) {
-        spinner.fail(`HTTP error removing the subgraph: ${requestError.code}`)
-        process.exitCode = 1
-      } else {
-        spinner.stop()
-        print.success(`Removed subgraph: ${subgraphName}`)
-      }
-    })
+    client.request(
+      'subgraph_remove',
+      { name: subgraphName },
+      function (requestError, jsonRpcError, res) {
+        if (jsonRpcError) {
+          spinner.fail(`Error removing the subgraph: ${jsonRpcError.message}`)
+          process.exitCode = 1
+        } else if (requestError) {
+          spinner.fail(`HTTP error removing the subgraph: ${requestError.code}`)
+          process.exitCode = 1
+        } else {
+          spinner.stop()
+          print.success(`Removed subgraph: ${subgraphName}`)
+        }
+      },
+    )
   },
 }

package/src/commands/test.js

@@ -1,13 +1,13 @@
-const { Binary } = require('binary-install-raw')
-const os = require('os')
-const chalk = require('chalk')
-const fetch = require('node-fetch')
-const { filesystem, patching, print, system } = require('gluegun')
-const { fixParameters } = require('../command-helpers/gluegun')
-const path = require('path')
-const semver = require('semver')
-const { spawn, exec } = require('child_process')
-const yaml = require('js-yaml')
+import { Binary } from 'binary-install-raw'
+import os from 'os'
+import chalk from 'chalk'
+import fetch from 'node-fetch'
+import { filesystem, patching, print, system } from 'gluegun'
+import { fixParameters } from '../command-helpers/gluegun'
+import path from 'path'
+import semver from 'semver'
+import { spawn, exec } from 'child_process'
+import yaml from 'js-yaml'
 
 const HELP = `
 ${chalk.bold('graph test')} ${chalk.dim('[options]')} ${chalk.bold('<datasource>')}
@@ -22,26 +22,12 @@ ${chalk.dim('Options:')}
   -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
   `
 
-module.exports = {
+export default {
   description: 'Runs rust binary for subgraph testing',
   run: async toolbox => {
     // Read CLI parameters
-    let {
-      c,
-      coverage,
-      d,
-      docker,
-      f,
-      force,
-      h,
-      help,
-      l,
-      logs,
-      r,
-      recompile,
-      v,
-      version,
-    } = toolbox.parameters.options
+    let { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version } =
+      toolbox.parameters.options
 
     let opts = {}
     // Support both long and short option variants
@@ -67,7 +53,7 @@ module.exports = {
         l,
         logs,
         r,
-        recompile
+        recompile,
       })
     } catch (e) {
       print.error(e.message)
@@ -83,18 +69,20 @@ module.exports = {
     }
 
     // Check if matchstick.yaml config exists
-    if(filesystem.exists('matchstick.yaml')) {
+    if (filesystem.exists('matchstick.yaml')) {
       try {
         // Load the config
         let config = await yaml.load(filesystem.read('matchstick.yaml', 'utf8'))
 
         // Check if matchstick.yaml and testsFolder not null
-        if(config && config.testsFolder) {
+        if (config && config.testsFolder) {
           // assign test folder from matchstick.yaml if present
           opts.testsFolder = config.testsFolder
         }
       } catch (error) {
-        print.info('A problem occurred while reading matchstick.yaml. Please attend to the errors below:')
+        print.info(
+          'A problem occurred while reading matchstick.yaml. Please attend to the errors below:',
+        )
         print.error(error.message)
         process.exit(1)
       }
@@ -105,29 +93,31 @@ module.exports = {
 
     // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
     if (opts.force || (!opts.version && !opts.latestVersion)) {
-      print.info("Fetching latest version tag")
-      let result = await fetch('https://api.github.com/repos/LimeChain/matchstick/releases/latest')
+      print.info('Fetching latest version tag')
+      let result = await fetch(
+        'https://api.github.com/repos/LimeChain/matchstick/releases/latest',
+      )
       let json = await result.json()
       opts.latestVersion = json.tag_name
 
       filesystem.file(opts.cachePath, {
         content: {
           version: json.tag_name,
-          timestamp: Date.now()
-        }
+          timestamp: Date.now(),
+        },
       })
     }
 
-    if(opts.docker) {
+    if (opts.docker) {
       runDocker(datasource, opts)
     } else {
       runBinary(datasource, opts)
     }
-  }
+  },
 }
 
 async function setVersionFromCache(opts) {
-  if(filesystem.exists(opts.cachePath) == 'file') {
+  if (filesystem.exists(opts.cachePath) == 'file') {
     let cached = filesystem.read(opts.cachePath, 'json')
     // Get the cache age in days
     let cacheAge = (Date.now() - cached.timestamp) / (1000 * 60 * 60 * 24)
@@ -148,7 +138,9 @@ async function runBinary(datasource, opts) {
 
   const platform = await getPlatform(logsOpt)
 
-  const url = `https://github.com/LimeChain/matchstick/releases/download/${versionOpt || latestVersion}/${platform}`
+  const url = `https://github.com/LimeChain/matchstick/releases/download/${
+    versionOpt || latestVersion
+  }/${platform}`
 
   if (logsOpt) {
     print.info(`Download link: ${url}`)
@@ -168,14 +160,20 @@ async function getPlatform(logsOpt) {
   const type = os.type()
   const arch = os.arch()
   const cpuCore = os.cpus()[0]
-  const isAppleSilicon = (arch === 'arm64' && /Apple (M1|M2|processor)/.test(cpuCore.model))
+  const isAppleSilicon = arch === 'arm64' && /Apple (M1|M2|processor)/.test(cpuCore.model)
   const linuxInfo = type === 'Linux' ? await getLinuxInfo() : {}
   const linuxDistro = linuxInfo.name
   const release = linuxInfo.version || os.release()
   const majorVersion = parseInt(linuxInfo.version, 10) || semver.major(release)
 
   if (logsOpt) {
-    print.info(`OS type: ${linuxDistro || type}\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${cpuCore.model}`)
+    print.info(
+      `OS type: ${
+        linuxDistro || type
+      }\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${
+        cpuCore.model
+      }`,
+    )
   }
 
   if (arch === 'x64' || isAppleSilicon) {
@@ -189,7 +187,8 @@ async function getPlatform(logsOpt) {
     } else if (type === 'Linux') {
       if (majorVersion === 18) {
         return 'binary-linux-18'
-      } if (majorVersion === 22) {
+      }
+      if (majorVersion === 22) {
         return 'binary-linux-22'
       } else {
         return 'binary-linux-20'
@@ -202,13 +201,18 @@ async function getPlatform(logsOpt) {
 
 async function getLinuxInfo() {
   try {
-    let result = await system.run("cat /etc/*-release | grep -E '(^VERSION|^NAME)='", {trim: true})
-    let infoArray = result.replace(/['"]+/g, '').split('\n').map(p => p.split('='))
+    let result = await system.run("cat /etc/*-release | grep -E '(^VERSION|^NAME)='", {
+      trim: true,
+    })
+    let infoArray = result
+      .replace(/['"]+/g, '')
+      .split('\n')
+      .map(p => p.split('='))
     let linuxInfo = {}
 
-    infoArray.forEach((val) => {
+    infoArray.forEach(val => {
       linuxInfo[val[0].toLowerCase()] = val[1]
-    });
+    })
 
     return linuxInfo
   } catch (error) {
@@ -239,7 +243,7 @@ async function runDocker(datasource, opts) {
 
   // Generate the Dockerfile only if it doesn't exists,
   // version flag and/or force flag is passed.
-  if(!dockerfileExists || versionOpt || forceOpt) {
+  if (!dockerfileExists || versionOpt || forceOpt) {
     await dockerfile(dockerfilePath, versionOpt, latestVersion)
   }
 
@@ -252,9 +256,15 @@ async function runDocker(datasource, opts) {
     if (datasource) testArgs = testArgs + ' ' + datasource
 
     // Build the `docker run` command options and flags
-    let dockerRunOpts = ['run', '-it', '--rm', '--mount', `type=bind,source=${current_folder},target=/matchstick`]
-
-    if(testArgs !== '') {
+    let dockerRunOpts = [
+      'run',
+      '-it',
+      '--rm',
+      '--mount',
+      `type=bind,source=${current_folder},target=/matchstick`,
+    ]
+
+    if (testArgs !== '') {
       dockerRunOpts.push('-e')
       dockerRunOpts.push(`ARGS=${testArgs.trim()}`)
     }
@@ -265,7 +275,7 @@ async function runDocker(datasource, opts) {
     // else it'll return the image ID. Skip `docker build` if an image already exists
     // Delete current image(if any) and rebuild.
     // Use spawn() and {stdio: 'inherit'} so we can see the logs in real time.
-    if(!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
+    if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
       if (stdout !== '') {
         exec('docker image rm matchstick', (error, stdout, stderr) => {
           print.info(chalk.bold(`Removing matchstick image\n${stdout}`))
@@ -273,17 +283,15 @@ async function runDocker(datasource, opts) {
       }
       // Build a docker image. If the process has executed successfully
       // run a container from that image.
-      spawn(
-        'docker',
-        ['build', '-f', dockerfilePath, '-t', 'matchstick', '.'],
-        { stdio: 'inherit' }
-      ).on('close', code => {
+      spawn('docker', ['build', '-f', dockerfilePath, '-t', 'matchstick', '.'], {
+        stdio: 'inherit',
+      }).on('close', code => {
         if (code === 0) {
-           spawn('docker', dockerRunOpts, { stdio: 'inherit' })
+          spawn('docker', dockerRunOpts, { stdio: 'inherit' })
         }
       })
     } else {
-      print.info("Docker image already exists. Skipping `docker build` command.")
+      print.info('Docker image already exists. Skipping `docker build` command.')
       // Run the container from the existing matchstick docker image
       spawn('docker', dockerRunOpts, { stdio: 'inherit' })
     }
@@ -293,27 +301,35 @@ async function runDocker(datasource, opts) {
 // Downloads Dockerfile template from the demo-subgraph repo
 // Replaces the placeholders with their respective values
 async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
-  let spinner = print.spin("Generating Dockerfile...")
+  let spinner = print.spin('Generating Dockerfile...')
 
   try {
     // Fetch the Dockerfile template content from the demo-subgraph repo
-    let content = await fetch('https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile')
-        .then((response) => {
-          if (response.ok) {
-            return response.text()
-          } else {
-            throw new Error(`Status Code: ${response.status}, with error: ${response.statusText}`);
-          }
-        })
+    let content = await fetch(
+      'https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile',
+    ).then(response => {
+      if (response.ok) {
+        return response.text()
+      } else {
+        throw new Error(
+          `Status Code: ${response.status}, with error: ${response.statusText}`,
+        )
+      }
+    })
 
     // Write the Dockerfile
     await filesystem.write(dockerfilePath, content)
 
     // Replaces the version placeholders
-    await patching.replace(dockerfilePath, '<MATCHSTICK_VERSION>', versionOpt || latestVersion)
-
+    await patching.replace(
+      dockerfilePath,
+      '<MATCHSTICK_VERSION>',
+      versionOpt || latestVersion,
+    )
   } catch (error) {
-    spinner.fail(`A problem occurred while generating the Dockerfile. Please attend to the errors below:\n ${error.message}`)
+    spinner.fail(
+      `A problem occurred while generating the Dockerfile. Please attend to the errors below:\n ${error.message}`,
+    )
     process.exit(1)
   }
 

package/src/compiler/{asc.js → asc.ts}

@@ -1,6 +1,6 @@
-const asc = require('assemblyscript/cli/asc')
+import * as asc from 'assemblyscript/cli/asc'
 
-const createExitHandler = inputFile => () => {
+const createExitHandler = (inputFile: string) => () => {
   throw new Error(`The AssemblyScript compiler crashed when compiling this file: '${inputFile}'
 Suggestion: try to comment the whole file and uncomment it little by little while re-running the graph-cli until you isolate the line where the problem happens.
 Also, please contact us so we can make the CLI better by handling errors like this. You can reach out in any of these links:
@@ -8,17 +8,21 @@ Also, please contact us so we can make the CLI better by handling errors like th
 - Github issues: https://github.com/graphprotocol/graph-cli/issues`)
 }
 
-const setupExitHandler = exitHandler => process.addListener('exit', exitHandler)
+const setupExitHandler = (exitHandler: (code: number) => void) =>
+  process.addListener('exit', exitHandler)
 
-const removeExitHandler = exitHandler =>  process.removeListener('exit', exitHandler)
+const removeExitHandler = (exitHandler: (code: number) => void) =>
+  process.removeListener('exit', exitHandler)
 
 // Important note, the `asc.main` callback function parameter is synchronous,
 // that's why this function doesn't need to be `async` and the throw works properly.
-const assemblyScriptCompiler = (...args) => asc.main(...args, err => {
-  if (err) {
-    throw err
-  }
-})
+const assemblyScriptCompiler = (argv: string[], options: asc.APIOptions) =>
+  asc.main(argv, options, err => {
+    if (err) {
+      throw err
+    }
+    return 0
+  })
 
 const compilerDefaults = {
   stdout: process.stdout,
@@ -28,15 +32,29 @@ const compilerDefaults = {
 // You MUST call this function once before compiling anything.
 // Internally it just delegates to the AssemblyScript compiler
 // which just delegates to the binaryen lib.
-const ready = async () => {
+export const ready = async () => {
   await asc.ready
 }
 
+export interface CompileOptions {
+  inputFile: string
+  global: string
+  baseDir: string
+  libs: string
+  outputFile: string
+}
+
 // For now this function doesn't check if `asc` is ready, because
 // it requires an asynchronous wait. Whenever you call this function,
 // it doesn't matter how many times, just make sure you call `ready`
 // once before everything..
-const compile = ({ inputFile, global, baseDir, libs, outputFile }) => {
+export const compile = ({
+  inputFile,
+  global,
+  baseDir,
+  libs,
+  outputFile,
+}: CompileOptions) => {
   const exitHandler = createExitHandler(inputFile)
 
   setupExitHandler(exitHandler)
@@ -63,8 +81,3 @@ const compile = ({ inputFile, global, baseDir, libs, outputFile }) => {
   // only if compiler succeded, that is, when the line above doesn't throw
   removeExitHandler(exitHandler)
 }
-
-module.exports = {
-  ready,
-  compile,
-}

package/src/compiler/index.js

@@ -1,19 +1,19 @@
-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')
-
-const { step, withSpinner } = require('../command-helpers/spinner')
-const Subgraph = require('../subgraph')
-const Watcher = require('../watcher')
-const { applyMigrations } = require('../migrations')
-const asc = require('./asc')
-const SubstreamsSubgraph = require('../protocols/substreams/subgraph')
-
-let compilerDebug = require('../debug')('graph-cli:compiler')
+import chalk from 'chalk'
+import crypto from 'crypto'
+import fs from 'fs-extra'
+import immutable from 'immutable'
+import path from 'path'
+import yaml from 'js-yaml'
+import * as toolbox from 'gluegun/toolbox'
+import { step, withSpinner } from '../command-helpers/spinner'
+import Subgraph from '../subgraph'
+import Watcher from '../watcher'
+import { applyMigrations } from '../migrations'
+import * as asc from './asc'
+import SubstreamsSubgraph from '../protocols/substreams/subgraph'
+import debug from '../debug'
+
+let compilerDebug = debug('graph-cli:compiler')
 
 class Compiler {
   constructor(options) {
@@ -59,7 +59,7 @@ class Compiler {
     this.protocol = this.options.protocol
     this.ABI = this.protocol.getABI()
 
-    process.on('uncaughtException', function(e) {
+    process.on('uncaughtException', function (e) {
       toolbox.print.error(`UNCAUGHT EXCEPTION: ${e}`)
     })
   }
@@ -681,4 +681,4 @@ class Compiler {
   }
 }
 
-module.exports = Compiler
+export default Compiler

package/src/{debug.js → debug.ts}

@@ -1,4 +1,4 @@
-const debugFactory = require('debug')
+import debugFactory from 'debug'
 
 debugFactory.formatters.L = immutableList => {
   return JSON.stringify(immutableList)
@@ -12,4 +12,4 @@ debugFactory.formatters.M = immutableMap => {
   return immutableMap
 }
 
-module.exports = debugFactory
+export default debugFactory

package/src/migrations/mapping_api_version_0_0_1.js

@@ -1,12 +1,12 @@
-const fs = require('fs-extra')
-const semver = require('semver')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { getGraphTsVersion } = require('./util/versions')
-const { loadManifest } = require('./util/load-manifest')
+import fs from 'fs-extra'
+import semver from 'semver'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { getGraphTsVersion } from './util/versions'
+import { loadManifest } from './util/load-manifest'
 
 // If any of the manifest apiVersions are 0.0.1, replace them with 0.0.2
-module.exports = {
+export default {
   name: 'Bump mapping apiVersion from 0.0.1 to 0.0.2',
   predicate: async ({ sourceDir, manifestFile }) => {
     // Obtain the graph-ts version, if possible

package/src/migrations/mapping_api_version_0_0_2.js

@@ -1,10 +1,10 @@
-const semver = require('semver')
-const toolbox = require('gluegun/toolbox')
-const { loadManifest } = require('./util/load-manifest')
-const { getGraphTsVersion } = require('./util/versions')
+import semver from 'semver'
+import * as toolbox from 'gluegun/toolbox'
+import { loadManifest } from './util/load-manifest'
+import { getGraphTsVersion } from './util/versions'
 
 // If any of the manifest apiVersions are 0.0.2, replace them with 0.0.3
-module.exports = {
+export default {
   name: 'Bump mapping apiVersion from 0.0.2 to 0.0.3',
   predicate: async ({ sourceDir, manifestFile }) => {
     // Obtain the graph-ts version, if possible

package/src/migrations/mapping_api_version_0_0_3.js

@@ -1,12 +1,12 @@
-const fs = require('fs-extra')
-const semver = require('semver')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { loadManifest } = require('./util/load-manifest')
-const { getGraphTsVersion } = require('./util/versions')
+import fs from 'fs-extra'
+import semver from 'semver'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { loadManifest } from './util/load-manifest'
+import { getGraphTsVersion } from './util/versions'
 
 // If any of the manifest apiVersions are 0.0.3, replace them with 0.0.4
-module.exports = {
+export default {
   name: 'Bump mapping apiVersion from 0.0.3 to 0.0.4',
   predicate: async ({ sourceDir, manifestFile }) => {
     // Obtain the graph-ts version, if possible

package/src/migrations/mapping_api_version_0_0_4.js

@@ -1,12 +1,12 @@
-const fs = require('fs-extra')
-const semver = require('semver')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { loadManifest } = require('./util/load-manifest')
-const { getGraphTsVersion } = require('./util/versions')
+import fs from 'fs-extra'
+import semver from 'semver'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { loadManifest } from './util/load-manifest'
+import { getGraphTsVersion } from './util/versions'
 
 // If any of the manifest apiVersions are 0.0.4, replace them with 0.0.5
-module.exports = {
+export default {
   name: 'Bump mapping apiVersion from 0.0.4 to 0.0.5',
   predicate: async ({ sourceDir, manifestFile }) => {
     // Obtain the graph-ts version, if possible

package/src/migrations/mapping_api_version_0_0_5.js

@@ -1,12 +1,12 @@
-const fs = require('fs-extra')
-const semver = require('semver')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { loadManifest } = require('./util/load-manifest')
-const { getGraphTsVersion } = require('./util/versions')
+import fs from 'fs-extra'
+import semver from 'semver'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { loadManifest } from './util/load-manifest'
+import { getGraphTsVersion } from './util/versions'
 
 // If any of the manifest apiVersions are 0.0.5, replace them with 0.0.6
-module.exports = {
+export default {
   name: 'Bump mapping apiVersion from 0.0.5 to 0.0.6',
   predicate: async ({ sourceDir, manifestFile }) => {
     // Obtain the graph-ts version, if possible

package/src/migrations/spec_version_0_0_2.js

@@ -1,11 +1,11 @@
-const fs = require('fs-extra')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { loadManifest } = require('./util/load-manifest')
+import fs from 'fs-extra'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { loadManifest } from './util/load-manifest'
 
 // Spec version to 0.0.2 uses top level templates. graph-cli no longer supports
 // 0.0.1 which used nested templates.
-module.exports = {
+export default {
   name: 'Bump manifest specVersion from 0.0.1 to 0.0.2',
   predicate: async ({ sourceDir, manifestFile }) => {
     let manifest = await loadManifest(manifestFile)

package/src/migrations/spec_version_0_0_3.js

@@ -1,7 +1,7 @@
-const fs = require('fs-extra')
-const toolbox = require('gluegun/toolbox')
-const yaml = require('js-yaml')
-const { loadManifest } = require('./util/load-manifest')
+import fs from 'fs-extra'
+import * as toolbox from 'gluegun/toolbox'
+import yaml from 'js-yaml'
+import { loadManifest } from './util/load-manifest'
 
 // Spec version 0.0.4 uses feature management, but features are
 // detected and validated by the graph-node instance during subgraph
@@ -9,7 +9,7 @@ const { loadManifest } = require('./util/load-manifest')
 //
 // Also, we skip spec version 0.0.3, which is considered invalid and
 // non-canonical.
-module.exports = {
+export default {
   name: 'Bump manifest specVersion from 0.0.2 to 0.0.4',
   predicate: async ({ sourceDir, manifestFile }) => {
     let manifest = await loadManifest(manifestFile)