@graphprotocol/graph-cli 0.30.2 → 0.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.30.2",
+  "version": "0.31.0",
   "license": "(Apache-2.0 OR MIT)",
   "description": "CLI for building for and deploying to The Graph",
   "dependencies": {
@@ -8,7 +8,7 @@
     "binary-install-raw": "0.0.13",
     "chalk": "3.0.0",
     "chokidar": "3.5.1",
-    "debug": "4.1.1",
+    "debug": "4.3.1",
     "docker-compose": "0.23.4",
     "dockerode": "2.5.8",
     "fs-extra": "9.0.0",
@@ -17,7 +17,7 @@
     "graphql": "15.5.0",
     "immutable": "3.8.2",
     "ipfs-http-client": "34.0.0",
-    "jayson": "3.2.0",
+    "jayson": "3.6.6",
     "js-yaml": "3.13.1",
     "node-fetch": "2.6.0",
     "pkginfo": "0.4.1",

package/src/command-helpers/abi.js

@@ -59,6 +59,9 @@ const getEtherscanLikeAPIUrl = (network) => {
     case "aurora": return `https://api.aurorascan.dev/api`
     case "aurora-testnet": return `https://api-testnet.aurorascan.dev/api`
     case "optimism-kovan": return `https://api-kovan-optimistic.etherscan.io/api`
+    case "optimism": return `https://api-optimistic.etherscan.io/api`
+    case "avalanche": return `https://api.snowtrace.io/api`;
+    case "fuji": return `https://api-testnet.snowtrace.io/api`;
     default: return `https://api-${network}.etherscan.io/api`
   }
 }

package/src/command-helpers/compiler.js

@@ -6,7 +6,7 @@ const Compiler = require('../compiler')
 // Helper function to construct a subgraph compiler
 const createCompiler = (
   manifest,
-  { ipfs, outputDir, outputFormat, skipMigrations, blockIpfsMethods, protocol }
+  { ipfs, headers, outputDir, outputFormat, skipMigrations, blockIpfsMethods, protocol }
 ) => {
   // Parse the IPFS URL
   let url
@@ -25,6 +25,7 @@ The IPFS URL must be of the following format: http(s)://host[:port]/[path]`)
         host: url.hostname,
         port: url.port,
         'api-path': url.pathname.replace(/\/$/, '') + '/api/v0/',
+        headers,
       })
     : undefined
 

package/src/command-helpers/network.js

@@ -107,7 +107,19 @@ function hasChanges(identifierName, network, networkConfig, dataSource) {
   return networkChanged || addressChanged || startBlockChanged
 }
 
+const updateNetworksFile = async (toolbox, network, dataSource, address, networksFile) => {
+  await toolbox.patching.update(networksFile, (config) => {
+    if(Object.keys(config).includes(network)) {
+      Object.assign(config[network], { [dataSource]: { address } })
+    } else {
+      Object.assign(config, { [network]: { [dataSource]: { address } }})
+    }
+    return config
+  })
+}
+
 module.exports = {
   updateSubgraphNetwork,
-  initNetworksConfig
+  initNetworksConfig,
+  updateNetworksFile
 }

package/src/command-helpers/scaffold.js

@@ -79,12 +79,12 @@ const writeScaffold = async (scaffold, directory, spinner) => {
   await writeScaffoldDirectory(scaffold, directory, spinner)
 }
 
-const writeABI = async (abi, contractName, abiPath = `./abis/${contractName}.json`) => {
+const writeABI = async (abi, contractName) => {
   let data = prettier.format(JSON.stringify(abi.data), {
     parser: 'json',
   })
 
-  await fs.writeFile(abiPath, data, { encoding: 'utf-8' })
+  await fs.writeFile(`./abis/${contractName}.json`, data, { encoding: 'utf-8' })
 }
 
 const writeSchema = async (abi, protocol, schemaPath, entities) => {

package/src/commands/add.js

@@ -9,6 +9,7 @@ const { generateDataSource, writeABI, writeSchema, writeMapping } = require('../
 const { loadAbiFromEtherscan, loadAbiFromBlockScout } = require('../command-helpers/abi')
 const EthereumABI = require('../protocols/ethereum/abi')
 const { fixParameters } = require('../command-helpers/gluegun')
+const { updateNetworksFile } = require('../command-helpers/network')
 
 const HELP = `
 ${chalk.bold('graph add')} <address> [<subgraph-manifest default: "./subgraph.yaml">]
@@ -18,6 +19,7 @@ ${chalk.dim('Options:')}
       --abi <path>              Path to the contract ABI (default: download from Etherscan)
       --contract-name           Name of the contract (default: Contract)
       --merge-entities          Whether to merge entities with the same name (default: false)
+      --network-file <path>     Networks file (default: "./networks.json")
   -h, --help                    Show usage information
 `
 
@@ -33,20 +35,12 @@ module.exports = {
       contractName,
       h,
       help,
-      mergeEntities
+      mergeEntities,
+      networkFile
     } = toolbox.parameters.options
 
-    let address = toolbox.parameters.first
-    let manifestPath = toolbox.parameters.second || './subgraph.yaml'
     contractName = contractName || 'Contract'
 
-    // Validate the address
-    if (!address) {
-      print.error('No contract address provided')
-      process.exitCode = 1
-      return
-    }
-
     try {
       fixParameters(toolbox.parameters, {
         h,
@@ -59,12 +53,22 @@ module.exports = {
       return
     }
 
+    let address = toolbox.parameters.first || toolbox.parameters.array[0]
+    let manifestPath = toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml'
+
     // Show help text if requested
     if (help || h) {
       print.info(HELP)
       return
     }
 
+    // Validate the address
+    if (!address) {
+      print.error('No contract address provided')
+      process.exitCode = 1
+      return
+    }
+
     const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath)
     let protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     let manifest = await Subgraph.load(manifestPath, { protocol })
@@ -95,7 +99,7 @@ module.exports = {
     let { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(ethabi, entities, contractName, mergeEntities)
     ethabi.data = abiData
 
-    await writeABI(ethabi, contractName, abi)
+    await writeABI(ethabi, contractName)
     await writeSchema(ethabi, protocol, result.getIn(['schema', 'file']), collisionEntities)
     await writeMapping(ethabi, protocol, contractName, collisionEntities)
 
@@ -120,6 +124,10 @@ module.exports = {
 
     await Subgraph.write(result, manifestPath)
 
+    // Update networks.json
+    const networksFile = networkFile || "./networks.json"
+    await updateNetworksFile(toolbox, network, contractName, address, networksFile)
+
     // Detect Yarn and/or NPM
     let yarn = await system.which('yarn')
     let npm = await system.which('npm')

package/src/commands/deploy.js

@@ -22,18 +22,19 @@ ${chalk.bold('graph deploy')} [options] ${chalk.bold('<subgraph-name>')} ${chalk
 
 Options:
 
-      --product <subgraph-studio|hosted-service>
+        --product <subgraph-studio|hosted-service>
                                 Selects the product to which to deploy
-      --studio                  Shortcut for --product subgraph-studio
-  -g, --node <node>             Graph node to which to deploy
-      --deploy-key <key>        User deploy key
-  -l  --version-label <label>   Version label used for the deployment
-  -h, --help                    Show usage information
-  -i, --ipfs <node>             Upload build results to an IPFS node (default: ${DEFAULT_IPFS_URL})
-      --debug-fork              ID of a remote subgraph whose store will be GraphQL queried
-  -o, --output-dir <path>       Output directory for build results (default: build/)
-      --skip-migrations         Skip subgraph migrations (default: false)
-  -w, --watch                   Regenerate types when subgraph files change (default: false)
+        --studio                  Shortcut for --product subgraph-studio
+  -g,   --node <node>             Graph node to which to deploy
+        --deploy-key <key>        User deploy key
+  -l    --version-label <label>   Version label used for the deployment
+  -h,   --help                    Show usage information
+  -i,   --ipfs <node>             Upload build results to an IPFS node (default: ${DEFAULT_IPFS_URL})
+  -hdr, --headers <map>           Add custom headers that will be used by the IPFS HTTP client (default: {})
+        --debug-fork              ID of a remote subgraph whose store will be GraphQL queried
+  -o,   --output-dir <path>       Output directory for build results (default: build/)
+        --skip-migrations         Skip subgraph migrations (default: false)
+  -w,   --watch                   Regenerate types when subgraph files change (default: false)
 `
 
 const processForm = async (
@@ -91,6 +92,8 @@ module.exports = {
       i,
       help,
       ipfs,
+      headers,
+      hdr,
       node,
       o,
       outputDir,
@@ -103,11 +106,20 @@ module.exports = {
     // Support both long and short option variants
     help = help || h
     ipfs = ipfs || i || DEFAULT_IPFS_URL
+    headers = headers || hdr || "{}"
     node = node || g
     outputDir = outputDir || o
     watch = watch || w
     versionLabel = versionLabel || l
 
+    try {
+      headers = JSON.parse(headers)
+    } catch (e) {
+      print.error("Please make sure headers is a valid JSON value")
+      process.exitCode = 1
+      return
+    }
+
     let subgraphName, manifest
     try {
       ;[subgraphName, manifest] = fixParameters(toolbox.parameters, {
@@ -216,6 +228,7 @@ module.exports = {
 
     let compiler = createCompiler(manifest, {
       ipfs,
+      headers,
       outputDir,
       outputFormat: 'wasm',
       skipMigrations,

package/src/commands/init.js

@@ -1,10 +1,9 @@
 const chalk = require('chalk')
-const fetch = require('node-fetch')
-const immutable = require('immutable')
 const os = require('os')
 const path = require('path')
 const toolbox = require('gluegun/toolbox')
-const yaml = require('yaml')
+const fs = require('fs')
+const graphCli = require('../cli')
 
 const {
   getSubgraphBasename,
@@ -423,9 +422,9 @@ module.exports = {
           contractName,
           node,
           studio,
-          product,
+          product
         },
-        { commands },
+        { commands, addContract: false },
       )
     }
 
@@ -484,9 +483,9 @@ module.exports = {
           contractName: inputs.contractName,
           node,
           studio: inputs.studio,
-          product: inputs.product,
+          product: inputs.product
         },
-        { commands },
+        { commands, addContract: true },
       )
     }
   },
@@ -720,9 +719,9 @@ const initSubgraphFromContract = async (
     contractName,
     node,
     studio,
-    product,
+    product
   },
-  { commands },
+  { commands, addContract },
 ) => {
   let { print } = toolbox
 
@@ -815,5 +814,85 @@ const initSubgraphFromContract = async (
     return
   }
 
+  while (addContract) {
+    addContract = await addAnotherContract(toolbox, { protocolInstance, directory })
+  }
+
   printNextSteps(toolbox, { subgraphName, directory }, { commands })
 }
+
+const addAnotherContract = async (toolbox, { protocolInstance, directory }) => {
+  const addContractConfirmation = await toolbox.prompt.confirm('Add another contract?')
+
+  if (addContractConfirmation) {
+    let abiFromFile
+    let ProtocolContract = protocolInstance.getContract()
+  
+    let questions = [
+      {
+        type: 'input',
+        name: 'contract',
+        message: () => `Contract ${ProtocolContract.identifierName()}`,
+        validate: async (value) => {
+          // Validate whether the contract is valid
+          const { valid, error } = validateContract(value, ProtocolContract)
+          return valid ? true : error
+        },
+      },
+      {
+        type: 'select',
+        name: 'localAbi',
+        message: 'Provide local ABI path?',
+        choices: ['yes', 'no'],
+        result: (value) => {
+          abiFromFile = value === 'yes' ? true : false
+          return abiFromFile
+        },
+      },
+      {
+        type: 'input',
+        name: 'abi',
+        message: 'ABI file (path)',
+        skip: () => abiFromFile === false
+      },
+      {
+        type: 'input',
+        name: 'contractName',
+        message: 'Contract Name',
+        initial: 'Contract',
+        validate: (value) => value && value.length > 0,
+      },
+    ]
+
+    // Get the cwd before process.chdir in order to switch back in the end of command execution
+    const cwd = process.cwd();
+  
+    try {
+      let { abi, contract, contractName } = await toolbox.prompt.ask(questions)
+  
+      if (fs.existsSync(directory)) {
+        process.chdir(directory)
+      }
+  
+      let commandLine = ['add', contract, '--contract-name', contractName]
+  
+      if (abiFromFile) {
+        if (abi.includes(directory)) {
+          commandLine.push('--abi', path.normalize(abi.replace(directory, '')))
+        } else {
+          commandLine.push('--abi', abi)
+        }
+      }
+
+      await graphCli.run(commandLine)
+    } catch (e) {
+      toolbox.print.error(e)
+      process.exit(1)
+    }
+    finally {
+      process.chdir(cwd)
+    }
+  }
+
+  return addContractConfirmation
+}

package/src/commands/test.js

@@ -13,12 +13,12 @@ const HELP = `
 ${chalk.bold('graph test')} ${chalk.dim('[options]')} ${chalk.bold('<datasource>')}
 
 ${chalk.dim('Options:')}
-  -c, --coverage                Run the tests in coverage mode. Works with v0.2.1 and above
+  -c, --coverage                Run the tests in coverage mode
   -d, --docker                  Run the tests in a docker container(Note: Please execute from the root folder of the subgraph)
   -f  --force                   Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image
   -h, --help                    Show usage information
   -l, --logs                    Logs to the console information about the OS, CPU model and download url (debugging purposes)
-  -r, --recompile               Force-recompile tests (Not available in 0.2.2 and earlier versions)
+  -r, --recompile               Force-recompile tests
   -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
   `
 
@@ -43,16 +43,16 @@ module.exports = {
       version,
     } = toolbox.parameters.options
 
-    let opts = new Map()
+    let opts = {}
     // Support both long and short option variants
-    opts.set("coverage", coverage || c)
-    opts.set("docker", docker || d)
-    opts.set("force", force || f)
-    opts.set("help", help || h)
-    opts.set("logs", logs || l)
-    opts.set("recompile", recompile || r)
-    opts.set("version", version || v)
-
+    opts.coverage = coverage || c
+    opts.docker = docker || d
+    opts.force = force || f
+    opts.help = help || h
+    opts.logs = logs || l
+    opts.recompile = recompile || r
+    opts.version = version || v
+    opts.testsFolder = './tests'
     // Fix if a boolean flag (e.g -c, --coverage) has an argument
     try {
       fixParameters(toolbox.parameters, {
@@ -76,18 +76,49 @@ module.exports = {
     }
 
     let datasource = toolbox.parameters.first || toolbox.parameters.array[0]
-
     // Show help text if requested
-    if (opts.get("help")) {
+    if (opts.help) {
       print.info(HELP)
       return
     }
 
-    let result = await fetch('https://api.github.com/repos/LimeChain/matchstick/releases/latest')
-    let json = await result.json()
-    opts.set("latestVersion", json.tag_name)
+    // Check if matchstick.yaml config exists
+    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) {
+          // 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.error(error.message)
+        process.exit(1)
+      }
+    }
+
+    opts.cachePath = path.join(opts.testsFolder, '.latest.json')
+    setVersionFromCache(opts)
+
+    // 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')
+      let json = await result.json()
+      opts.latestVersion = json.tag_name
+
+      filesystem.file(opts.cachePath, {
+        content: {
+          version: json.tag_name,
+          timestamp: Date.now()
+        }
+      })
+    }
 
-    if(opts.get("docker")) {
+    if(opts.docker) {
       runDocker(datasource, opts)
     } else {
       runBinary(datasource, opts)
@@ -95,13 +126,25 @@ module.exports = {
   }
 }
 
+async function setVersionFromCache(opts) {
+  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)
+    // If cache age is less than 1 day, use the cached version
+    if (cacheAge < 1) {
+      opts.latestVersion = cached.version
+    }
+  }
+}
+
 async function runBinary(datasource, opts) {
-  let coverageOpt = opts.get("coverage")
-  let forceOpt = opts.get("force")
-  let logsOpt = opts.get("logs")
-  let versionOpt = opts.get("version")
-  let latestVersion = opts.get("latestVersion")
-  let recompileOpt = opts.get("recompile")
+  let coverageOpt = opts.coverage
+  let forceOpt = opts.force
+  let logsOpt = opts.logs
+  let versionOpt = opts.version
+  let latestVersion = opts.latestVersion
+  let recompileOpt = opts.recompile
 
   const platform = await getPlatform(logsOpt)
 
@@ -126,10 +169,10 @@ async function getPlatform(logsOpt) {
   const arch = os.arch()
   const cpuCore = os.cpus()[0]
   const isM1 = (arch === 'arm64' && /Apple (M1|processor)/.test(cpuCore.model))
-  const linuxInfo = type === 'Linux' ? await getLinuxInfo() : new Map()
-  const linuxDistro = linuxInfo.get('name')
-  const release = linuxInfo.get('version') || os.release()
-  const majorVersion = parseInt(linuxInfo.get('version'), 10) || semver.major(release)
+  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}`)
@@ -148,6 +191,8 @@ async function getPlatform(logsOpt) {
     } else if (type === 'Linux') {
       if (majorVersion === 18) {
         return 'binary-linux-18'
+      } if (majorVersion === 22) {
+        return 'binary-linux-22'
       } else {
         return 'binary-linux-20'
       }
@@ -163,13 +208,13 @@ 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 infoMap = new Map();
+    let linuxInfo = {}
 
     infoArray.forEach((val) => {
-      infoMap.set(val[0].toLowerCase(), val[1])
+      linuxInfo[val[0].toLowerCase()] = val[1]
     });
 
-    return infoMap
+    return linuxInfo
   } catch (error) {
     print.error(`Error fetching the Linux version:\n ${error}`)
     process.exit(1)
@@ -177,39 +222,21 @@ async function getLinuxInfo() {
 }
 
 async function runDocker(datasource, opts) {
-  let coverageOpt = opts.get("coverage")
-  let forceOpt = opts.get("force")
-  let versionOpt = opts.get("version")
-  let latestVersion = opts.get("latestVersion")
-  let recompileOpt = opts.get("recompile")
+  let coverageOpt = opts.coverage
+  let forceOpt = opts.force
+  let versionOpt = opts.version
+  let latestVersion = opts.latestVersion
+  let recompileOpt = opts.recompile
 
   // Remove binary-install-raw binaries, because docker has permission issues
   // when building the docker images
-  await filesystem.remove("./node_modules/binary-install-raw/bin")
+  await filesystem.remove('./node_modules/binary-install-raw/bin')
 
   // Get current working directory
   let current_folder = await filesystem.cwd()
 
   // Declate dockerfilePath with default location
-  let dockerfilePath = "./tests/.docker/Dockerfile"
-
-  // Check if matchstick.yaml config exists
-  if(filesystem.exists('matchstick.yaml')) {
-    try {
-      // Load the config
-      let config = await yaml.load(filesystem.read('matchstick.yaml', 'utf8'))
-
-      // Check if matchstick.yaml is not empty
-      if(config != null) {
-        // If a custom tests folder is declared update dockerfilePath
-        dockerfilePath = path.join(config.testsFolder || 'tests', '.docker/Dockerfile')
-      }
-    } catch (error) {
-      print.info('A problem occurred while reading matchstick.yaml. Please attend to the errors below:')
-      print.error(error.message)
-      process.exit(1)
-    }
-  }
+  let dockerfilePath = path.join(opts.testsFolder || 'tests', '.docker/Dockerfile')
 
   // Check if the Dockerfil already exists
   let dockerfileExists = filesystem.exists(dockerfilePath)

package/src/protocols/index.js

@@ -52,6 +52,7 @@ module.exports = class Protocol {
         'matic',
         'mumbai',
         'fantom',
+        'fantom-testnet',
         'bsc',
         'chapel',
         'clover',
@@ -60,6 +61,8 @@ module.exports = class Protocol {
         'celo',
         'celo-alfajores',
         'fuse',
+        'moonbeam',
+        'moonriver',
         'mbase',
         'arbitrum-one',
         'arbitrum-rinkeby',