@graphprotocol/graph-cli 0.30.3 → 0.32.0

package/README.md

@@ -16,6 +16,7 @@ As of today, the command line interface supports the following commands:
 - `graph auth` — Stores a [Graph Node](https://github.com/graphprotocol/graph-node) access token in the system's keychain.
 - `graph local` — Runs tests against a [Graph Node](https://github.com/graphprotocol/graph-node) test environment (using Ganache by default).
 - `graph test` — Downloads and runs the [Matchstick](https://github.com/LimeChain/matchstick) rust binary in order to test a subgraph.
+- `graph add` - Adds a new datasource to the yaml file and writes the necessary changes to other files - schema.graphql, abi and mapping.
 
 ## How It Works
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.30.3",
+  "version": "0.32.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/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,11 +19,12 @@ ${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 config file path (default: "./networks.json")
   -h, --help                    Show usage information
 `
 
 module.exports = {
-  description: 'Creates a new subgraph with basic scaffolding',
+  description: 'Adds a new datasource to a subgraph',
   run: async toolbox => {
     // Obtain tools
     let { print, system } = toolbox
@@ -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 })
@@ -100,7 +104,7 @@ module.exports = {
     await writeMapping(ethabi, protocol, contractName, collisionEntities)
 
     let dataSources = result.get('dataSources')
-    let dataSource = await generateDataSource(protocol, 
+    let dataSource = await generateDataSource(protocol,
       contractName, network, address, ethabi)
 
     // Handle the collisions edge case by copying another data source yaml data
@@ -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')
@@ -173,12 +181,12 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
     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}') 
+          print.error(`Contract name ('${contractName}')
             + event name ('${dataRow.get('name')}') entity already exists.`)
           process.exitCode = 1
           return
         }
-        
+
         if (mergeEntities) {
           collisionEntities.push(dataRow.get('name'))
           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

package/src/commands/build.js

@@ -17,8 +17,8 @@ Options:
   -t, --output-format <format>  Output format for mappings (wasm, wast) (default: wasm)
       --skip-migrations         Skip subgraph migrations (default: false)
   -w, --watch                   Regenerate types when subgraph files change (default: false)
-      --network <name>          Network to use from networks.json
-      --network-file <path>    Networks file (default: "./networks.json")
+      --network <name>          Network configuration to use from the networks config file
+      --network-file <path>     Networks config file path (default: "./networks.json")
 `
 
 module.exports = {

package/src/commands/deploy.js

@@ -14,6 +14,7 @@ const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-h
 const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
 const Protocol = require('../protocols')
+const { updateSubgraphNetwork } = require('../command-helpers/network')
 
 const HELP = `
 ${chalk.bold('graph deploy')} [options] ${chalk.bold('<subgraph-name>')} ${chalk.bold(
@@ -22,18 +23,21 @@ ${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)
+        --network <name>          Network configuration to use from the networks config file
+        --network-file <path>     Networks config file path (default: "./networks.json")
 `
 
 const processForm = async (
@@ -51,7 +55,7 @@ const processForm = async (
       name: 'product',
       message: 'Product for which to deploy',
       choices: ['subgraph-studio', 'hosted-service'],
-      skip: 
+      skip:
         product === 'subgraph-studio' ||
         product === 'hosted-service' ||
         studio !== undefined || node !== undefined,
@@ -91,6 +95,8 @@ module.exports = {
       i,
       help,
       ipfs,
+      headers,
+      hdr,
       node,
       o,
       outputDir,
@@ -98,16 +104,27 @@ module.exports = {
       w,
       watch,
       debugFork,
+      network,
+      networkFile,
     } = toolbox.parameters.options
 
     // 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, {
@@ -129,6 +146,10 @@ module.exports = {
       manifest !== undefined && manifest !== ''
         ? manifest
         : filesystem.resolve('subgraph.yaml')
+    networkFile =
+      networkFile !== undefined && networkFile !== ''
+        ? networkFile
+        : filesystem.resolve("networks.json")
 
     try {
       const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
@@ -211,11 +232,17 @@ module.exports = {
       return
     }
 
+    if (network) {
+      let identifierName = protocol.getContract().identifierName()
+      await updateSubgraphNetwork(toolbox, manifest, network, networkFile, identifierName)
+    }
+
     const isStudio = node.match(/studio/)
     const isHostedService = node.match(/thegraph.com/) && !isStudio
 
     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/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',

package/src/protocols/near/manifest.graphql

@@ -33,6 +33,12 @@ type DataSource {
 type ContractSource {
   account: String
   startBlock: BigInt
+  accounts: PartialAccount
+}
+
+type PartialAccount {
+  prefixes: [String!]
+  suffixes: [String!]
 }
 
 type ContractMapping {

package/tests/cli/validation/near-is-valid/subgraph.yaml

@@ -10,6 +10,14 @@ dataSources:
     source:
       account: wnear.flux-dev
       startBlock: 1
+      accounts:
+        prefixes:
+          - some-prefix
+          - a-prefix.with-dot
+        suffixes:
+          - suffix.near
+          - near
+          - another-suffix.testnet
     mapping:
       apiVersion: 0.0.5
       language: wasm/assemblyscript