Merge pull request #760 from graphprotocol/otavio/near

NEAR support

Author: evaporei

manifest-schema.graphql

@@ -6,7 +6,10 @@ type Schema {
   file: File!
 }
 
-union DataSource = EthereumContractDataSource
+union DataSource =
+  EthereumContractDataSource |
+  NearContractDataSource
+
 union DataSourceTemplate = EthereumContractDataSourceTemplate
 
 type EthereumContractDataSource {
@@ -17,14 +20,27 @@ type EthereumContractDataSource {
   mapping: EthereumContractMapping!
 }
 
+type NearContractDataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: NearContractSource!
+  mapping: NearContractMapping!
+}
+
 type EthereumContractSource {
   address: String
   abi: String!
   startBlock: BigInt
 }
 
+type NearContractSource {
+  account: String
+  startBlock: BigInt
+}
+
 type EthereumContractMapping {
-  kind: String!
+  kind: String
   apiVersion: String!
   language: String!
   file: File!
@@ -35,6 +51,16 @@ type EthereumContractMapping {
   eventHandlers: [EthereumContractEventHandler!]
 }
 
+type NearContractMapping {
+  kind: String # This will be removed, it isn't used / it doesn't mean anything
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [NearBlockHandler!]
+  receiptHandlers: [NearReceiptHandler!]
+}
+
 type EthereumContractAbi {
   name: String!
   file: File!
@@ -49,11 +75,19 @@ type EthereumBlockFilter {
   kind: String!
 }
 
+type NearBlockHandler {
+  handler: String!
+}
+
 type EthereumCallHandler {
   function: String!
   handler: String!
 }
 
+type NearReceiptHandler {
+  handler: String!
+}
+
 type EthereumContractEventHandler {
   event: String!
   topic0: String

src/codegen/schema.js

@@ -23,8 +23,7 @@ module.exports = class SchemaCodeGenerator {
           // APIs
           'store',
 
-          // Basic Ethereum types
-          'Address',
+          // Basic Scalar types
           'Bytes',
           'BigInt',
           'BigDecimal',

src/codegen/template.js

@@ -3,14 +3,19 @@ const immutable = require('immutable')
 const tsCodegen = require('./typescript')
 
 module.exports = class DataSourceTemplateCodeGenerator {
-  constructor(template) {
+  constructor(template, protocol) {
     this.template = template
+    this.protocolTemplateCodeGen = protocol.getTemplateCodeGen(template)
   }
 
   generateModuleImports() {
     return [
       tsCodegen.moduleImports(
-        ['Address', 'DataSourceTemplate', 'DataSourceContext'],
+        [
+          ...this.protocolTemplateCodeGen.generateModuleImports(),
+          'DataSourceTemplate',
+          'DataSourceContext',
+        ],
         '@graphprotocol/graph-ts',
       ),
     ]
@@ -24,55 +29,8 @@ module.exports = class DataSourceTemplateCodeGenerator {
     let name = this.template.get('name')
 
     let klass = tsCodegen.klass(name, { export: true, extends: 'DataSourceTemplate' })
-    klass.addMethod(this._generateCreateMethod())
-    klass.addMethod(this._generateCreateWithContextMethod())
+    klass.addMethod(this.protocolTemplateCodeGen.generateCreateMethod())
+    klass.addMethod(this.protocolTemplateCodeGen.generateCreateWithContextMethod())
     return klass
   }
-
-  _generateCreateMethod() {
-    let name = this.template.get('name')
-    let kind = this.template.get('kind')
-
-    switch (kind) {
-      case 'ethereum/contract':
-        return tsCodegen.staticMethod(
-          'create',
-          [tsCodegen.param('address', tsCodegen.namedType('Address'))],
-          tsCodegen.namedType('void'),
-          `
-          DataSourceTemplate.create('${name}', [address.toHex()])
-          `,
-        )
-
-      default:
-        throw new Error(
-          `Data sources with kind != 'ethereum/contract' are not supported yet`,
-        )
-    }
-  }
-
-  _generateCreateWithContextMethod() {
-    let name = this.template.get('name')
-    let kind = this.template.get('kind')
-
-    switch (kind) {
-      case 'ethereum/contract':
-        return tsCodegen.staticMethod(
-          'createWithContext',
-          [
-            tsCodegen.param('address', tsCodegen.namedType('Address')),
-            tsCodegen.param('context', tsCodegen.namedType('DataSourceContext')),
-          ],
-          tsCodegen.namedType('void'),
-          `
-          DataSourceTemplate.createWithContext('${name}', [address.toHex()], context)
-          `,
-        )
-
-      default:
-        throw new Error(
-          `Data sources with kind != 'ethereum/contract' are not supported yet`,
-        )
-    }
-  }
 }

src/codegen/typescript.js

@@ -179,6 +179,10 @@ const klassMember = (name, type) => new ClassMember(name, type)
 const nullableType = type => new NullableType(type)
 const moduleImports = (nameOrNames, module) => new ModuleImports(nameOrNames, module)
 
+const GENERATED_FILE_NOTE = `
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+`
+
 module.exports = {
   // Types
   NullableType,
@@ -194,4 +198,7 @@ module.exports = {
   param,
   nullableType,
   moduleImports,
+
+  // Utilities
+  GENERATED_FILE_NOTE,
 }

src/command-helpers/compiler.js

@@ -4,7 +4,10 @@ const toolbox = require('gluegun/toolbox')
 const Compiler = require('../compiler')
 
 // Helper function to construct a subgraph compiler
-const createCompiler = (manifest, { ipfs, outputDir, outputFormat, skipMigrations, blockIpfsMethods }) => {
+const createCompiler = (
+  manifest,
+  { ipfs, outputDir, outputFormat, skipMigrations, blockIpfsMethods, protocol }
+) => {
   // Parse the IPFS URL
   let url
   try {
@@ -31,7 +34,8 @@ The IPFS URL must be of the following format: http(s)://host[:port]/[path]`)
     outputDir: outputDir,
     outputFormat: outputFormat,
     skipMigrations,
-    blockIpfsMethods
+    blockIpfsMethods,
+    protocol,
   })
 }
 

src/command-helpers/data-sources.js

@@ -0,0 +1,38 @@
+const immutable = require('immutable')
+const { loadManifest } = require('../migrations/util/load-manifest')
+
+// Loads manifest from file path and returns all:
+// - data sources
+// - templates
+// In a single list.
+const fromFilePath = async manifestPath => {
+  const { dataSources = [], templates = [] } = await loadManifest(manifestPath)
+
+  return dataSources.concat(templates)
+}
+
+const extractDataSourceByType = (manifest, dataSourceType, protocol) =>
+  manifest
+    .get(dataSourceType, immutable.List())
+    .reduce(
+      (dataSources, dataSource, dataSourceIndex) =>
+      protocol.isValidKindName(dataSource.get('kind'))
+      ? dataSources.push(
+        immutable.Map({ path: [dataSourceType, dataSourceIndex], dataSource }),
+      )
+      : dataSources,
+      immutable.List(),
+    )
+
+// Extracts data sources and templates from a immutable manifest data structure
+const fromManifest = (manifest, protocol) => {
+  const dataSources = extractDataSourceByType(manifest, 'dataSources', protocol)
+  const templates = extractDataSourceByType(manifest, 'templates', protocol)
+
+  return dataSources.concat(templates)
+}
+
+module.exports = {
+  fromFilePath,
+  fromManifest,
+}

src/command-helpers/fs.js

@@ -0,0 +1,8 @@
+const path = require('path')
+
+const displayPath = p =>
+  path.relative(process.cwd(), p)
+
+module.exports = {
+  displayPath,
+}

src/commands/build.js

@@ -2,6 +2,8 @@ const chalk = require('chalk')
 
 const { createCompiler } = require('../command-helpers/compiler')
 const { fixParameters } = require('../command-helpers/gluegun')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
+const Protocol = require('../protocols')
 
 const HELP = `
 ${chalk.bold('graph build')} [options] ${chalk.bold('[<subgraph-manifest>]')}
@@ -73,11 +75,23 @@ module.exports = {
       return
     }
 
+    let protocol
+    try {
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
+    } catch (e) {
+      print.error(e.message)
+      process.exitCode = 1
+      return
+    }
+
     let compiler = createCompiler(manifest, {
       ipfs,
       outputDir,
       outputFormat,
       skipMigrations,
+      protocol,
     })
 
     // Exit with an error code if the compiler couldn't be created

src/commands/codegen.js

@@ -2,7 +2,9 @@ const chalk = require('chalk')
 const path = require('path')
 
 const TypeGenerator = require('../type-generator')
+const Protocol = require('../protocols')
 const { fixParameters } = require('../command-helpers/gluegun')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
 
 const HELP = `
@@ -60,6 +62,7 @@ module.exports = {
       return
     }
 
+    let protocol
     try {
       // Checks to make sure codegen doesn't run against
       // older subgraphs (both apiVersion and graph-ts version).
@@ -69,6 +72,10 @@ module.exports = {
       // the wrong AssemblyScript version.
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {
       print.error(e.message)
       process.exitCode = 1
@@ -79,6 +86,7 @@ module.exports = {
       subgraphManifest: manifest,
       outputDir: outputDir,
       skipMigrations,
+      protocol,
     })
 
     // Watch working directory for file updates or additions, trigger

src/commands/deploy.js

@@ -11,8 +11,9 @@ const { withSpinner } = require('../command-helpers/spinner')
 const { validateSubgraphName } = require('../command-helpers/subgraph')
 const { DEFAULT_IPFS_URL } = require('../command-helpers/ipfs')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
-const { loadManifest } = require('../migrations/util/load-manifest')
+const Protocol = require('../protocols')
 
 const HELP = `
 ${chalk.bold('graph deploy')} [options] ${chalk.bold('<subgraph-name>')} ${chalk.bold(
@@ -128,13 +129,9 @@ module.exports = {
         : filesystem.resolve('subgraph.yaml')
 
     try {
-      let manifestFile = await loadManifest(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
-      for (const { network } of manifestFile.dataSources || []) {
-        validateStudioNetwork({ studio, product, network })
-      }
-
-      for (const { network } of manifestFile.templates || []) {
+      for (const { network } of dataSourcesAndTemplates) {
         validateStudioNetwork({ studio, product, network })
       }
     } catch (e) {
@@ -192,6 +189,7 @@ module.exports = {
       return
     }
 
+    let protocol
     try {
       // Checks to make sure deploy doesn't run against
       // older subgraphs (both apiVersion and graph-ts version).
@@ -201,6 +199,10 @@ module.exports = {
       // using the wrong AssemblyScript compiler.
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
+
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {
       print.error(e.message)
       process.exitCode = 1
@@ -215,7 +217,8 @@ module.exports = {
       outputDir,
       outputFormat: 'wasm',
       skipMigrations,
-      blockIpfsMethods: isStudio  // Network does not support publishing subgraphs with IPFS methods
+      blockIpfsMethods: isStudio,  // Network does not support publishing subgraphs with IPFS methods
+      protocol,
     })
 
     // Exit with an error code if the compiler couldn't be created