@graphprotocol/graph-cli 0.23.0 → 0.24.0

package/src/commands/init.js

@@ -257,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()
 
@@ -530,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
     },
@@ -643,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}`)
 }

package/src/migrations/mapping_api_version_0_0_5.js

@@ -0,0 +1,74 @@
+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')
+
+// If any of the manifest apiVersions are 0.0.5, replace them with 0.0.6
+module.exports = {
+  name: 'Bump mapping apiVersion from 0.0.5 to 0.0.6',
+  predicate: async ({ sourceDir, manifestFile }) => {
+    // Obtain the graph-ts version, if possible
+    let graphTsVersion
+    try {
+      graphTsVersion = await getGraphTsVersion(sourceDir)
+    } catch (_) {
+      // If we cannot obtain the version, return a hint that the graph-ts
+      // hasn't been installed yet
+      return 'graph-ts dependency not installed yet'
+    }
+
+    let manifest = loadManifest(manifestFile)
+    return (
+      // Only migrate if the graph-ts version is >= 0.23.0...
+      // Coerce needed because we may be dealing with an alpha version
+      // and in the `semver` library this would not return true on equality.
+      semver.gte(semver.coerce(graphTsVersion), '0.24.0') &&
+      // ...and we have a manifest with mapping > apiVersion = 0.0.5
+      manifest &&
+      typeof manifest === 'object' &&
+      Array.isArray(manifest.dataSources) &&
+      (manifest.dataSources.reduce(
+        (hasOldMappings, dataSource) =>
+          hasOldMappings ||
+          (typeof dataSource === 'object' &&
+            dataSource.mapping &&
+            typeof dataSource.mapping === 'object' &&
+            dataSource.mapping.apiVersion === '0.0.5'),
+        false,
+      ) ||
+        (Array.isArray(manifest.templates) &&
+          manifest.templates.reduce(
+            (hasOldMappings, template) =>
+              hasOldMappings ||
+              (typeof template === 'object' &&
+                template.mapping &&
+                typeof template.mapping === 'object' &&
+                template.mapping.apiVersion === '0.0.5'),
+            false,
+          )))
+    )
+  },
+  apply: async ({ manifestFile }) => {
+    // Make sure we catch all variants; we could load the manifest
+    // and replace the values in the data structures here; unfortunately
+    // writing that back to the file messes with the formatting more than
+    // we'd like; that's why for now, we use a simple patching approach
+    await toolbox.patching.replace(
+      manifestFile,
+      new RegExp('apiVersion: 0.0.5', 'g'),
+      'apiVersion: 0.0.6',
+    )
+    await toolbox.patching.replace(
+      manifestFile,
+      new RegExp("apiVersion: '0.0.5'", 'g'),
+      "apiVersion: '0.0.6'",
+    )
+    await toolbox.patching.replace(
+      manifestFile,
+      new RegExp('apiVersion: "0.0.5"', 'g'),
+      'apiVersion: "0.0.6"',
+    )
+  },
+}

package/src/scaffold.js

@@ -18,6 +18,13 @@ const abiEvents = abi =>
     setName: (event, name) => event.set('_alias', name),
   })
 
+const graphCliVersion = process.env.GRAPH_CLI_TESTS
+  // JSON.stringify should remove this key, we will install the local
+  // graph-cli for the tests using `npm link` instead of fetching from npm.
+  ? undefined
+  // For scaffolding real subgraphs
+  : `${module.exports.version}`
+
 // package.json
 
 const generatePackageJson = ({ subgraphName, node }) =>
@@ -41,8 +48,8 @@ const generatePackageJson = ({ subgraphName, node }) =>
           subgraphName,
       },
       dependencies: {
-        '@graphprotocol/graph-cli': `${module.exports.version}`,
-        '@graphprotocol/graph-ts': `0.22.1`,
+        '@graphprotocol/graph-cli': graphCliVersion,
+        '@graphprotocol/graph-ts': `0.24.0`,
       },
     }),
     { parser: 'json' },
@@ -145,6 +152,14 @@ const generateSchema = ({ abi, indexEvents }) => {
   )
 }
 
+const tsConfig = prettier.format(
+  JSON.stringify({
+    extends: '@graphprotocol/graph-ts/types/tsconfig.base.json',
+    include: ['src'],
+  }),
+  { parser: 'json' },
+)
+
 // Mapping
 
 const generateTupleFieldAssignments = ({ keyPath, index, component }) => {
@@ -303,6 +318,7 @@ const generateScaffold = async (
     'package.json': packageJson,
     'subgraph.yaml': manifest,
     'schema.graphql': schema,
+    'tsconfig.json': tsConfig,
     src: { 'mapping.ts': mapping },
     abis: {
       [`${contractName}.json`]: prettier.format(JSON.stringify(abi.data), {

package/tests/cli/globalSetup.js

@@ -0,0 +1,6 @@
+const { npmLinkCli } = require('./util')
+
+module.exports = async () => {
+  process.env.GRAPH_CLI_TESTS = '1'
+  await npmLinkCli()
+}

package/tests/cli/globalTeardown.js

@@ -0,0 +1,6 @@
+const { npmUnlinkCli } = require('./util')
+
+module.exports = async () => {
+  delete process.env.GRAPH_CLI_TESTS
+  await npmUnlinkCli()
+}

package/tests/cli/init.test.js

@@ -1,6 +1,6 @@
 const fs = require('fs-extra')
 const path = require('path')
-const cliTest = require('./util').cliTest
+const { cliTest } = require('./util')
 
 describe('Init', () => {
   let baseDir = path.join(__dirname, 'init')

package/tests/cli/util.js

@@ -13,7 +13,7 @@ const cliTest = (title, args, testPath, options) => {
       let cwd =
         options !== undefined && options.cwd ? options.cwd : resolvePath(`./${testPath}`)
 
-      let [exitCode, stdout, stderr] = await runCli(args, cwd)
+      let [exitCode, stdout, stderr] = await runGraphCli(args, cwd)
 
       let expectedExitCode = undefined
       if (options !== undefined && options.exitCode !== undefined) {
@@ -55,18 +55,14 @@ const cliTest = (title, args, testPath, options) => {
   )
 }
 
-const runCli = async (args = [], cwd = process.cwd()) => {
-  // Resolve the path to graph.js
-  let graphCli = path.join(__dirname, '..', '..', 'bin', 'graph')
-
+const runCommand = async (command, args = [], cwd = process.cwd()) => {
   // Make sure to set an absolute working directory
   cwd = cwd[0] !== '/' ? path.resolve(__dirname, cwd) : cwd
 
   return new Promise((resolve, reject) => {
     let stdout = ''
     let stderr = ''
-    const command = `${graphCli} ${args.join(' ')}`
-    const child = spawn(command, { cwd })
+    const child = spawn(`${command} ${args.join(' ')}`, { cwd })
 
     child.on('error', error => {
       reject(error)
@@ -86,7 +82,20 @@ const runCli = async (args = [], cwd = process.cwd()) => {
   })
 }
 
+const runGraphCli = async (args, cwd) => {
+  // Resolve the path to graph.js
+  let graphCli = path.join(__dirname, '..', '..', 'bin', 'graph')
+
+  return await runCommand(graphCli, args, cwd)
+}
+
+const npmLinkCli = () => runCommand('npm', ['link'])
+
+const npmUnlinkCli = () => runCommand('npm', ['unlink'])
+
 module.exports = {
   cliTest,
-  runCli,
+  npmLinkCli,
+  npmUnlinkCli,
+  runGraphCli,
 }

package/tests/cli/init/from-contract/abis/Contract.json

@@ -1,69 +0,0 @@
-[
-  {
-    "constant": true,
-    "inputs": [],
-    "name": "proxyOwner",
-    "outputs": [{ "name": "", "type": "address" }],
-    "payable": false,
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "constant": true,
-    "inputs": [],
-    "name": "currentContract",
-    "outputs": [{ "name": "", "type": "address" }],
-    "payable": false,
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "constant": true,
-    "inputs": [],
-    "name": "owner",
-    "outputs": [{ "name": "", "type": "address" }],
-    "payable": false,
-    "stateMutability": "view",
-    "type": "function"
-  },
-  {
-    "constant": false,
-    "inputs": [
-      { "name": "newContract", "type": "address" },
-      { "name": "data", "type": "bytes" }
-    ],
-    "name": "upgrade",
-    "outputs": [],
-    "payable": false,
-    "stateMutability": "nonpayable",
-    "type": "function"
-  },
-  {
-    "constant": false,
-    "inputs": [{ "name": "_newOwner", "type": "address" }],
-    "name": "transferOwnership",
-    "outputs": [],
-    "payable": false,
-    "stateMutability": "nonpayable",
-    "type": "function"
-  },
-  { "payable": true, "stateMutability": "payable", "type": "fallback" },
-  {
-    "anonymous": false,
-    "inputs": [
-      { "indexed": true, "name": "newContract", "type": "address" },
-      { "indexed": false, "name": "initializedWith", "type": "bytes" }
-    ],
-    "name": "Upgrade",
-    "type": "event"
-  },
-  {
-    "anonymous": false,
-    "inputs": [
-      { "indexed": false, "name": "_prevOwner", "type": "address" },
-      { "indexed": false, "name": "_newOwner", "type": "address" }
-    ],
-    "name": "OwnerUpdate",
-    "type": "event"
-  }
-]

package/tests/cli/init/from-contract/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "subgraph-from-contract",
-  "license": "UNLICENSED",
-  "scripts": {
-    "codegen": "graph codegen",
-    "build": "graph build",
-    "deploy": "graph deploy --node https://api.studio.thegraph.com/deploy/ user/subgraph-from-contract",
-    "create-local": "graph create --node http://localhost:8020/ user/subgraph-from-contract",
-    "remove-local": "graph remove --node http://localhost:8020/ user/subgraph-from-contract",
-    "deploy-local": "graph deploy --node http://localhost:8020/ --ipfs http://localhost:5001 user/subgraph-from-contract"
-  },
-  "dependencies": {
-    "@graphprotocol/graph-cli": "file:../../../../",
-    "@graphprotocol/graph-ts": "0.22.1"
-  }
-}

package/tests/cli/init/from-contract/schema.graphql

@@ -1,6 +0,0 @@
-type ExampleEntity @entity {
-  id: ID!
-  count: BigInt!
-  newContract: Bytes! # address
-  initializedWith: Bytes! # bytes
-}

package/tests/cli/init/from-contract/src/mapping.ts

@@ -1,49 +0,0 @@
-import { BigInt } from "@graphprotocol/graph-ts"
-import { Contract, Upgrade, OwnerUpdate } from "../generated/Contract/Contract"
-import { ExampleEntity } from "../generated/schema"
-
-export function handleUpgrade(event: Upgrade): void {
-  // Entities can be loaded from the store using a string ID; this ID
-  // needs to be unique across all entities of the same type
-  let entity = ExampleEntity.load(event.transaction.from.toHex())
-
-  // Entities only exist after they have been saved to the store;
-  // `null` checks allow to create entities on demand
-  if (!entity) {
-    entity = new ExampleEntity(event.transaction.from.toHex())
-
-    // Entity fields can be set using simple assignments
-    entity.count = BigInt.fromI32(0)
-  }
-
-  // BigInt and BigDecimal math are supported
-  entity.count = entity.count + BigInt.fromI32(1)
-
-  // Entity fields can be set based on event parameters
-  entity.newContract = event.params.newContract
-  entity.initializedWith = event.params.initializedWith
-
-  // Entities can be written to the store with `.save()`
-  entity.save()
-
-  // Note: If a handler doesn't require existing field values, it is faster
-  // _not_ to load the entity from the store. Instead, create it fresh with
-  // `new Entity(...)`, set the fields that should be updated and save the
-  // entity back to the store. Fields that were not set or unset remain
-  // unchanged, allowing for partial updates to be applied.
-
-  // It is also possible to access smart contracts from mappings. For
-  // example, the contract that has emitted the event can be connected to
-  // with:
-  //
-  // let contract = Contract.bind(event.address)
-  //
-  // The following functions can then be called on this contract to access
-  // state variables and other data:
-  //
-  // - contract.proxyOwner(...)
-  // - contract.currentContract(...)
-  // - contract.owner(...)
-}
-
-export function handleOwnerUpdate(event: OwnerUpdate): void {}

package/tests/cli/init/from-contract/subgraph.yaml

@@ -1,26 +0,0 @@
-specVersion: 0.0.1
-schema:
-  file: ./schema.graphql
-dataSources:
-  - kind: ethereum/contract
-    name: Contract
-    network: mainnet
-    source:
-      address: "0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d"
-      abi: Contract
-    mapping:
-      kind: ethereum/events
-      apiVersion: 0.0.5
-      language: wasm/assemblyscript
-      entities:
-        - Upgrade
-        - OwnerUpdate
-      abis:
-        - name: Contract
-          file: ./abis/Contract.json
-      eventHandlers:
-        - event: Upgrade(indexed address,bytes)
-          handler: handleUpgrade
-        - event: OwnerUpdate(address,address)
-          handler: handleOwnerUpdate
-      file: ./src/mapping.ts