@graphprotocol/graph-cli 0.23.2 → 0.25.0

package/src/scaffold/schema.js

@@ -0,0 +1,62 @@
+const { ascTypeForProtocol, valueTypeForAsc } = require('../codegen/types')
+const util = require('../codegen/util')
+
+const abiEvents = abi =>
+  util.disambiguateNames({
+    values: abi.data.filter(item => item.get('type') === 'event'),
+    getName: event => event.get('name'),
+    setName: (event, name) => event.set('_alias', name),
+  })
+
+const protocolTypeToGraphQL = (protocol, name) => {
+  let ascType = ascTypeForProtocol(protocol, name)
+  return valueTypeForAsc(ascType)
+}
+
+const generateField = ({ name, type, protocolName }) =>
+  `${name}: ${protocolTypeToGraphQL(protocolName, type)}! # ${type}`
+
+const generateEventFields = ({ index, input, protocolName }) =>
+  input.type == 'tuple'
+    ? util
+        .unrollTuple({ value: input, path: [input.name || `param${index}`], index })
+        .map(({ path, type }) => generateField({ name: path.join('_'), type, protocolName }))
+    : [generateField({ name: input.name || `param${index}`, type: input.type, protocolName })]
+
+const generateEventType = (event, protocolName) => `type ${event._alias} @entity {
+      id: ID!
+      ${event.inputs
+        .reduce(
+          (acc, input, index) => acc.concat(generateEventFields({ input, index, protocolName })),
+          [],
+        )
+        .join('\n')}
+    }`
+
+const generateExampleEntityType = (protocol, events) => {
+    if (protocol.hasABIs() && events.length > 0) {
+      return `type ExampleEntity @entity {
+  id: ID!
+  count: BigInt!
+  ${events[0].inputs
+    .reduce((acc, input, index) => acc.concat(generateEventFields({ input, index, protocolName: protocol.name })), [])
+    .slice(0, 2)
+    .join('\n')}
+}`
+    } else {
+      return `type ExampleEntity @entity {
+  id: ID!
+  block: Bytes!
+  count: BigInt!
+}`
+    }
+}
+
+module.exports = {
+  abiEvents,
+  protocolTypeToGraphQL,
+  generateField,
+  generateEventFields,
+  generateEventType,
+  generateExampleEntityType,
+}

package/src/subgraph.js

@@ -145,6 +145,13 @@ At least one such handler must be defined.`,
       }, immutable.List())
   }
 
+  static validateContractValues(manifest, protocol) {
+    return validation.validateContractValues(
+      manifest,
+      protocol,
+    )
+  }
+
   // Validate that data source names are unique, so they don't overwrite each other.
   static validateUniqueDataSourceNames(manifest) {
     let names = []
@@ -231,6 +238,7 @@ More than one template named '${name}', template names must be unique.`,
       ? immutable.List()
       : immutable.List.of(
           ...protocolSubgraph.validateManifest(),
+          ...Subgraph.validateContractValues(manifest, protocol),
           ...Subgraph.validateUniqueDataSourceNames(manifest),
           ...Subgraph.validateUniqueTemplateNames(manifest),
           ...Subgraph.validateHandlers(manifest, protocol, protocolSubgraph),

package/src/validation/contract.js

@@ -0,0 +1,56 @@
+const immutable = require('immutable')
+
+const validateContract = (value, ProtocolContract) => {
+  const contract = new ProtocolContract(value)
+
+  const { valid, error } = contract.validate()
+
+  if (!valid) {
+    return {
+      valid,
+      error: `Contract ${ProtocolContract.identifierName()} is invalid: ${value}\n${error}`,
+    }
+  }
+
+  return { valid, error }
+}
+
+const validateContractValues = (manifest, protocol) => {
+  const ProtocolContract = protocol.getContract()
+
+  const fieldName = ProtocolContract.identifierName()
+
+  return manifest
+    .get('dataSources')
+    .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
+    .reduce((errors, dataSource, dataSourceIndex) => {
+      let path = ['dataSources', dataSourceIndex, 'source', fieldName]
+
+      // No need to validate if the source has no contract field
+      if (!dataSource.get('source').has(fieldName)) {
+        return errors
+      }
+
+      let contractValue = dataSource.getIn(['source', fieldName])
+
+
+      const { valid, error } = validateContract(contractValue, ProtocolContract)
+
+      // Validate whether the contract is valid for the protocol
+      if (valid) {
+        return errors
+      } else {
+        return errors.push(
+          immutable.fromJS({
+            path,
+            message: error,
+          }),
+        )
+      }
+    }, immutable.List())
+}
+
+module.exports = {
+  validateContract,
+  validateContractValues,
+}

package/src/validation/index.js

@@ -1,5 +1,6 @@
 module.exports = {
   validateSchema: require('./schema').validateSchema,
   validateManifest: require('./manifest').validateManifest,
-  validateContractValues: require('./manifest').validateContractValues,
+  validateContractValues: require('./contract').validateContractValues,
+  validateContract: require('./contract').validateContract,
 }

package/src/validation/manifest.js

@@ -282,35 +282,6 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
   return validateDataSourceNetworks(value, protocol)
 }
 
-const validateContractValues = (manifest, protocol, fieldName, validator, errorMessage) =>
-  manifest
-    .get('dataSources')
-    .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
-    .reduce((errors, dataSource, dataSourceIndex) => {
-      let path = ['dataSources', dataSourceIndex, 'source', fieldName]
-
-      // No need to validate if the source has no contract field
-      if (!dataSource.get('source').has(fieldName)) {
-        return errors
-      }
-
-      let contractValue = dataSource.getIn(['source', fieldName])
-
-      // Validate whether the contract is valid
-      if (validator(contractValue)) {
-        return errors
-      } else {
-        return errors.push(
-          immutable.fromJS({
-            path,
-            message: `\
-Contract ${fieldName} is invalid: ${contractValue}${errorMessage ? `\n${errorMessage}` : ''}`,
-          }),
-        )
-      }
-    }, immutable.List())
-
 module.exports = {
   validateManifest,
-  validateContractValues,
 }

package/tests/cli/init/{from-contract-with-abi-and-structs.stderr → ethereum/from-contract-with-abi-and-structs.stderr}

@@ -1,5 +1,5 @@
 - Create subgraph scaffold
-  Generate subgraph from ABI
+  Generate subgraph
 - Create subgraph scaffold
   Write subgraph to directory
 - Create subgraph scaffold

package/tests/cli/init/{from-contract-with-abi.stderr → ethereum/from-contract-with-abi.stderr}

@@ -1,5 +1,5 @@
 - Create subgraph scaffold
-  Generate subgraph from ABI
+  Generate subgraph
 - Create subgraph scaffold
   Write subgraph to directory
 - Create subgraph scaffold

package/tests/cli/init/{from-contract-with-overloaded-elements.stderr → ethereum/from-contract-with-overloaded-elements.stderr}

@@ -1,5 +1,5 @@
 - Create subgraph scaffold
-  Generate subgraph from ABI
+  Generate subgraph
 - Create subgraph scaffold
   Write subgraph to directory
 - Create subgraph scaffold

package/tests/cli/init/{from-contract.stderr → ethereum/from-contract.stderr}

@@ -1,7 +1,7 @@
 - Fetching ABI from Etherscan
 ✔ Fetching ABI from Etherscan
 - Create subgraph scaffold
-  Generate subgraph from ABI
+  Generate subgraph
 - Create subgraph scaffold
   Write subgraph to directory
 - Create subgraph scaffold

package/tests/cli/init/near/from-contract.stderr

@@ -0,0 +1,12 @@
+- Create subgraph scaffold
+  Generate subgraph
+- Create subgraph scaffold
+  Write subgraph to directory
+- Create subgraph scaffold
+✔ Create subgraph scaffold
+- Initialize subgraph repository
+✔ Initialize subgraph repository
+- Install dependencies with yarn
+✔ Install dependencies with yarn
+- Generate ABI and schema types with yarn codegen
+✔ Generate ABI and schema types with yarn codegen

package/tests/cli/init/near/from-contract.stdout

@@ -0,0 +1,12 @@
+
+Subgraph user/near-from-contract created in from-contract
+
+Next steps:
+
+  1. Run `graph auth` to authenticate with your deploy key.
+
+  2. Type `cd from-contract` to enter the subgraph.
+
+  3. Run `yarn deploy` to deploy the subgraph.
+
+Make sure to visit the documentation on https://thegraph.com/docs/ for further information.

package/tests/cli/init.test.js

@@ -1,125 +1,156 @@
-const fs = require('fs-extra')
 const path = require('path')
 const { cliTest } = require('./util')
 
 describe('Init', () => {
-  let baseDir = path.join(__dirname, 'init')
+  const baseDir = path.join(__dirname, 'init')
 
-  let subgraphDir1 = path.join(baseDir, 'from-example')
-  let subgraphDir2 = path.join(baseDir, 'from-contract')
-  let subgraphDir3 = path.join(baseDir, 'from-contract-with-abi')
-  let subgraphDir4 = path.join(baseDir, 'from-contract-with-abi-and-structs')
-  let subgraphDir5 = path.join(baseDir, 'from-contract-with-overloaded-elements')
+  describe('Ethereum', () => {
+    const ethereumBaseDir = path.join(baseDir, 'ethereum')
 
-  const removeSubgraphDirs = () => {
-    if (fs.existsSync(subgraphDir1)) {
-      fs.removeSync(subgraphDir1)
-    }
-    if (fs.existsSync(subgraphDir2)) {
-      fs.removeSync(subgraphDir2)
-    }
-    if (fs.existsSync(subgraphDir3)) {
-      fs.removeSync(subgraphDir3)
-    }
-    if (fs.existsSync(subgraphDir4)) {
-      fs.removeSync(subgraphDir4)
-    }
-    if (fs.existsSync(subgraphDir5)) {
-      fs.removeSync(subgraphDir5)
-    }
-  }
+    cliTest(
+      'From example',
+      [
+        'init',
+        '--protocol',
+        'ethereum',
+        '--studio',
+        '--from-example',
+        'user/example-subgraph',
+        path.join(ethereumBaseDir, 'from-example'),
+      ],
+      path.join('init', 'ethereum', 'from-example'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: ethereumBaseDir,
+        deleteDir: true,
+      },
+    )
 
-  beforeAll(removeSubgraphDirs)
-  afterAll(removeSubgraphDirs)
+    cliTest(
+      'From contract',
+      [
+        'init',
+        '--protocol',
+        'ethereum',
+        '--studio',
+        '--from-contract',
+        '0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d',
+        '--network',
+        'mainnet',
+        'user/subgraph-from-contract',
+        path.join(ethereumBaseDir, 'from-contract'),
+      ],
+      path.join('init', 'ethereum', 'from-contract'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: ethereumBaseDir,
+        deleteDir: true,
+      },
+    )
 
-  cliTest(
-    'From example',
-    [
-      'init', 
-      '--studio', 
-      '--from-example', 
-      'user/example-subgraph', 
-      subgraphDir1
-    ],
-    'init/from-example',
-    {
-      exitCode: 0,
-      timeout: 100000,
-      cwd: baseDir,
-    },
-  )
+    cliTest(
+      'From contract with abi',
+      [
+        'init',
+        '--protocol',
+        'ethereum',
+        '--studio',
+        '--from-contract',
+        '0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d',
+        '--abi',
+        path.join(ethereumBaseDir, 'abis', 'Marketplace.json'),
+        '--network',
+        'mainnet',
+        'user/subgraph-from-contract-with-abi',
+        path.join(ethereumBaseDir, 'from-contract-with-abi'),
+      ],
+      path.join('init', 'ethereum', 'from-contract-with-abi'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: ethereumBaseDir,
+        deleteDir: true,
+      },
+    )
 
-  cliTest(
-    'From contract',
-    [
-      'init',
-      '--studio', 
-      '--from-contract',
-      '0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d',
-      '--network',
-      'mainnet',
-      'user/subgraph-from-contract',
-      subgraphDir2,
-    ],
-    'init/from-contract',
-    {
-      exitCode: 0,
-      timeout: 100000,
-      cwd: baseDir,
-    },
-  )
+    cliTest(
+      'From contract with abi and structs',
+      [
+        'init',
+        '--protocol',
+        'ethereum',
+        '--studio',
+        '--from-contract',
+        '0x1E0447b19BB6EcFdAe1e4AE1694b0C3659614e4e',
+        '--abi',
+        path.join(ethereumBaseDir, 'abis', 'SoloMargin.json'),
+        '--network',
+        'mainnet',
+        'user/subgraph-from-contract-with-abi-and-structs',
+        path.join(ethereumBaseDir, 'from-contract-with-abi-and-structs'),
+      ],
+      path.join('init', 'ethereum', 'from-contract-with-abi-and-structs'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: ethereumBaseDir,
+        deleteDir: true,
+      },
+    )
 
-  cliTest(
-    'From contract with abi',
-    [
-      'init',
-      '--studio', 
-      '--from-contract',
-      '0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d',
-      '--abi',
-      path.join(baseDir, 'abis', 'Marketplace.json'),
-      '--network',
-      'mainnet',
-      'user/subgraph-from-contract-with-abi',
-      subgraphDir3,
-    ],
-    'init/from-contract-with-abi',
-    { exitCode: 0, timeout: 100000, cwd: baseDir },
-  )
+    cliTest(
+      'From contract with overloaded elements',
+      [
+        'init',
+        '--protocol',
+        'ethereum',
+        '--studio',
+        '--from-contract',
+        '0x1E0447b19BB6EcFdAe1e4AE1694b0C3659614e4e',
+        '--abi',
+        path.join(ethereumBaseDir, 'abis', 'OverloadedElements.json'),
+        '--network',
+        'mainnet',
+        'user/subgraph-from-contract-with-overloaded-elements',
+        path.join(ethereumBaseDir, 'from-contract-with-overloaded-elements'),
+      ],
+      path.join('init', 'ethereum', 'from-contract-with-overloaded-elements'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: ethereumBaseDir,
+        deleteDir: true,
+      },
+    )
+  })
 
-  cliTest(
-    'From contract with abi and structs',
-    [
-      'init',
-      '--studio', 
-      '--from-contract',
-      '0x1E0447b19BB6EcFdAe1e4AE1694b0C3659614e4e',
-      '--abi',
-      path.join(baseDir, 'abis', 'SoloMargin.json'),
-      '--network',
-      'mainnet',
-      'user/subgraph-from-contract-with-abi-and-structs',
-      subgraphDir4,
-    ],
-    'init/from-contract-with-abi-and-structs',
-    { exitCode: 0, timeout: 100000, cwd: baseDir },
-  )
+  describe('NEAR', () => {
+    const nearBaseDir = path.join(baseDir, 'near')
 
-  cliTest(
-    'From contract with overloaded elements',
-    [
-      'init',
-      '--studio', 
-      '--from-contract',
-      '0x1E0447b19BB6EcFdAe1e4AE1694b0C3659614e4e',
-      '--abi',
-      path.join(baseDir, 'abis', 'OverloadedElements.json'),
-      '--network',
-      'mainnet',
-      'user/subgraph-from-contract-with-overloaded-elements',
-      subgraphDir5,
-    ],
-    'init/from-contract-with-overloaded-elements',
-    { exitCode: 0, timeout: 100000, cwd: baseDir },
-  )
+    cliTest(
+      'From contract',
+      [
+        'init',
+        '--protocol',
+        'near',
+        '--product',
+        'hosted-service',
+        '--from-contract',
+        'app.good-morning.near',
+        '--network',
+        'near-mainnet',
+        'user/near-from-contract',
+        path.join(nearBaseDir, 'from-contract'),
+      ],
+      path.join('init', 'near', 'from-contract'),
+      {
+        exitCode: 0,
+        timeout: 100000,
+        cwd: nearBaseDir,
+        deleteDir: true,
+      },
+    )
+  })
 })

package/tests/cli/util.js

@@ -1,57 +1,72 @@
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 const spawn = require('spawn-command')
 const stripAnsi = require('strip-ansi')
 
-const cliTest = (title, args, testPath, options) => {
+// Deletes folder if:
+// - flag is true
+// - folder exists
+const deleteDir = (dir, flag) => {
+  if (flag && fs.existsSync(dir)) {
+    fs.removeSync(dir)
+  }
+}
+
+const resolvePath = p => path.join(__dirname, p)
+
+const cliTest = (title, args, testPath, options = {}) => {
   test(
     title,
     async () => {
-      const resolvePath = p => path.join(__dirname, p)
-
-      // Use the provided cwd if desired
-      let cwd =
-        options !== undefined && options.cwd ? options.cwd : resolvePath(`./${testPath}`)
+      try {
+        deleteDir(resolvePath(`./${testPath}`), options.deleteDir)
 
-      let [exitCode, stdout, stderr] = await runGraphCli(args, cwd)
+        // Use the provided cwd if desired
+        let cwd =
+          options.cwd ? options.cwd : resolvePath(`./${testPath}`)
 
-      let expectedExitCode = undefined
-      if (options !== undefined && options.exitCode !== undefined) {
-        expectedExitCode = options.exitCode
-      }
-      let expectedStdout = undefined
-      try {
-        expectedStdout = fs.readFileSync(resolvePath(`./${testPath}.stdout`), 'utf-8')
-      } catch (e) {}
+        let [exitCode, stdout, stderr] = await runGraphCli(args, cwd)
 
-      let expectedStderr = undefined
-      try {
-        expectedStderr = fs.readFileSync(resolvePath(`./${testPath}.stderr`), 'utf-8')
-      } catch (e) {}
-
-      if (expectedStderr !== undefined) {
-        // For some reason the error sometimes comes in stdout, then
-        // stderr comes empty.
-        //
-        // If that's the case, we should throw it so it's easier
-        // to debug the error.
-        //
-        // TODO: investigate why that happens (somewhere it should
-        // be using console.error or print.error for example) so this
-        // check can be removed.
-        if (stderr.length === 0 && stdout.length !== 0) {
-          throw new Error(stdout)
+        let expectedExitCode = undefined
+        if (options.exitCode !== undefined) {
+          expectedExitCode = options.exitCode
         }
-        expect(stripAnsi(stderr)).toBe(expectedStderr)
-      }
-      if (expectedExitCode !== undefined) {
-        expect(exitCode).toBe(expectedExitCode)
-      }
-      if (expectedStdout !== undefined) {
-        expect(stripAnsi(stdout)).toBe(expectedStdout)
+        let expectedStdout = undefined
+        try {
+          expectedStdout = fs.readFileSync(resolvePath(`./${testPath}.stdout`), 'utf-8')
+        } catch (e) {}
+
+        let expectedStderr = undefined
+        try {
+          expectedStderr = fs.readFileSync(resolvePath(`./${testPath}.stderr`), 'utf-8')
+        } catch (e) {}
+
+        if (expectedStderr !== undefined) {
+          // For some reason the error sometimes comes in stdout, then
+          // stderr comes empty.
+          //
+          // If that's the case, we should throw it so it's easier
+          // to debug the error.
+          //
+          // TODO: investigate why that happens (somewhere it should
+          // be using console.error or print.error for example) so this
+          // check can be removed.
+          if (stderr.length === 0 && stdout.length !== 0) {
+            throw new Error(stdout)
+          }
+          expect(stripAnsi(stderr)).toBe(expectedStderr)
+        }
+        if (expectedExitCode !== undefined) {
+          expect(exitCode).toBe(expectedExitCode)
+        }
+        if (expectedStdout !== undefined) {
+          expect(stripAnsi(stdout)).toBe(expectedStdout)
+        }
+      } finally {
+        deleteDir(resolvePath(`./${testPath}`), options.deleteDir)
       }
     },
-    (options !== undefined && options.timeout) || undefined,
+    options.timeout || undefined,
   )
 }
 

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

@@ -6,6 +6,7 @@ schema:
 dataSources:
   - kind: near
     name: NearSubgraph
+    network: near-mainnet
     source:
       account: wnear.flux-dev
       startBlock: 1