@graphprotocol/graph-cli 0.26.0 → 0.28.1

package/src/protocols/ethereum/manifest.graphql

@@ -0,0 +1,92 @@
+# Each referenced type's in any of the types below must be listed
+# here either as `scalar` or `type` for the validation code to work
+# properly.
+#
+# That's why `String` is listed as a scalar even though it's built-in
+# GraphQL basic types.
+scalar String
+scalar File
+scalar BigInt
+
+type SubgraphManifest {
+  specVersion: String!
+  features: [String!]
+  schema: Schema!
+  description: String
+  repository: String
+  graft: Graft
+  dataSources: [DataSource!]!
+  templates: [DataSourceTemplate!]
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: ContractSource!
+  mapping: ContractMapping!
+}
+
+type ContractSource {
+  address: String
+  abi: String!
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  kind: String
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  abis: [ContractAbi!]!
+  blockHandlers: [BlockHandler!]
+  callHandlers: [CallHandler!]
+  eventHandlers: [ContractEventHandler!]
+}
+
+type ContractAbi {
+  name: String!
+  file: File!
+}
+
+type BlockHandler {
+  handler: String!
+  filter: BlockFilter
+}
+
+type BlockFilter {
+  kind: String!
+}
+
+type CallHandler {
+  function: String!
+  handler: String!
+}
+
+type ContractEventHandler {
+  event: String!
+  topic0: String
+  handler: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}
+
+type DataSourceTemplate {
+  kind: String!
+  name: String!
+  network: String
+  source: ContractSourceTemplate!
+  mapping: ContractMapping!
+}
+
+type ContractSourceTemplate {
+  abi: String!
+}

package/src/protocols/index.js

@@ -4,6 +4,7 @@ const EthereumTemplateCodeGen = require('./ethereum/codegen/template')
 const EthereumABI = require('./ethereum/abi')
 const EthereumSubgraph = require('./ethereum/subgraph')
 const NearSubgraph = require('./near/subgraph')
+const TendermintSubgraph = require('./tendermint/subgraph')
 const EthereumContract = require('./ethereum/contract')
 const NearContract = require('./near/contract')
 const EthereumManifestScaffold = require('./ethereum/scaffold/manifest')
@@ -27,6 +28,7 @@ module.exports = class Protocol {
       // New networks (or protocol perhaps) shouldn't have the `/contract` anymore (unless a new case makes use of it).
       ethereum: ['ethereum', 'ethereum/contract'],
       near: ['near'],
+      tendermint: ['tendermint']
     })
   }
 
@@ -60,10 +62,8 @@ module.exports = class Protocol {
         'aurora',
         'aurora-testnet',
       ],
-      near: [
-        'near-mainnet',
-        'near-testnet'
-      ],
+      near: ['near-mainnet', 'near-testnet'],
+      tendermint: ['cosmoshub-4']
     })
   }
 
@@ -79,6 +79,8 @@ module.exports = class Protocol {
         return 'Ethereum'
       case 'near':
         return 'NEAR'
+      case 'tendermint':
+        return 'Tendermint'
     }
   }
 
@@ -96,6 +98,19 @@ module.exports = class Protocol {
         return true
       case 'near':
         return false
+      case 'tendermint':
+        return false
+    }
+  }
+
+  hasContract() {
+    switch (this.name) {
+      case 'ethereum':
+        return true
+      case 'near':
+        return true
+      case 'tendermint':
+        return false
     }
   }
 
@@ -105,6 +120,19 @@ module.exports = class Protocol {
         return true
       case 'near':
         return false
+      case 'tendermint':
+        return false
+    }
+  }
+
+  hasTemplates() {
+    switch (this.name) {
+      case 'ethereum':
+        return true
+      case 'near':
+        return false
+      case 'tendermint':
+        return false
     }
   }
 
@@ -114,17 +142,23 @@ module.exports = class Protocol {
         return new EthereumTypeGenerator(options)
       case 'near':
         return null
+      case 'tendermint':
+        return null
     }
   }
 
   getTemplateCodeGen(template) {
+    if (!this.hasTemplates()) {
+      throw new Error(
+        `Template data sources with kind '${this.name}' are not supported yet`,
+      )
+    }
+
     switch (this.name) {
       case 'ethereum':
         return new EthereumTemplateCodeGen(template)
       default:
-        throw new Error(
-          `Template data sources with kind '${this.name}' are not supported yet`,
-        )
+        throw new Error(`Template data sources with kind '${this.name}' is unknown`)
     }
   }
 
@@ -134,6 +168,8 @@ module.exports = class Protocol {
         return EthereumABI
       case 'near':
         return null
+      case 'tendermint':
+        return null
     }
   }
 
@@ -145,6 +181,8 @@ module.exports = class Protocol {
         return new EthereumSubgraph(optionsWithProtocol)
       case 'near':
         return new NearSubgraph(optionsWithProtocol)
+      case 'tendermint':
+        return new TendermintSubgraph(optionsWithProtocol)
       default:
         throw new Error(`Data sources with kind '${this.name}' are not supported yet`)
     }
@@ -156,6 +194,8 @@ module.exports = class Protocol {
         return EthereumContract
       case 'near':
         return NearContract
+      case 'tendermint':
+        return null
     }
   }
 
@@ -165,6 +205,8 @@ module.exports = class Protocol {
         return EthereumManifestScaffold
       case 'near':
         return NearManifestScaffold
+      case 'tendermint':
+        return null
     }
   }
 
@@ -174,6 +216,8 @@ module.exports = class Protocol {
         return EthereumMappingScaffold
       case 'near':
         return NearMappingScaffold
+      case 'tendermint':
+        return null
     }
   }
 }

package/src/protocols/near/manifest.graphql

@@ -0,0 +1,57 @@
+# Each referenced type's in any of the types below must be listed
+# here either as `scalar` or `type` for the validation code to work
+# properly.
+#
+# That's why `String` is listed as a scalar even though it's built-in
+# GraphQL basic types.
+scalar String
+scalar File
+scalar BigInt
+
+type SubgraphManifest {
+  specVersion: String!
+  schema: Schema!
+  description: String
+  repository: String
+  graft: Graft
+  dataSources: [DataSource!]!
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: ContractSource!
+  mapping: ContractMapping!
+}
+
+type ContractSource {
+  account: String
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [BlockHandler!]
+  receiptHandlers: [ReceiptHandler!]
+}
+
+type BlockHandler {
+  handler: String!
+}
+
+type ReceiptHandler {
+  handler: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}

package/src/protocols/tendermint/manifest.graphql

@@ -0,0 +1,64 @@
+# Each referenced type's in any of the types below must be listed
+# here either as `scalar` or `type` for the validation code to work
+# properly.
+#
+# That's why `String` is listed as a scalar even though it's built-in
+# GraphQL basic types.
+scalar String
+scalar File
+scalar BigInt
+
+type SubgraphManifest {
+  specVersion: String!
+  schema: Schema!
+  description: String
+  repository: String
+  graft: Graft
+  dataSources: [DataSource!]!
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: ContractSource!
+  mapping: ContractMapping!
+}
+
+type ContractSource {
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  blockHandlers: [BlockHandler!]
+  eventHandlers: [EventHandler!]
+}
+
+type BlockHandler {
+  handler: String!
+}
+
+enum EventOrigin {
+  BeginBlock
+  DeliverTx
+  EndBlock
+}
+
+type EventHandler {
+  event: String!
+  origin: EventOrigin
+  handler: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}

package/src/protocols/tendermint/subgraph.js

@@ -0,0 +1,20 @@
+const immutable = require('immutable')
+
+module.exports = class TendermintSubgraph {
+  constructor(options = {}) {
+    this.manifest = options.manifest
+    this.resolveFile = options.resolveFile
+    this.protocol = options.protocol
+  }
+
+  validateManifest() {
+    return immutable.List()
+  }
+
+  handlerTypes() {
+    return immutable.List([
+      'blockHandlers',
+      'eventHandlers',
+    ])
+  }
+}

package/src/scaffold/index.js

@@ -50,7 +50,7 @@ module.exports = class Scaffold {
         },
         dependencies: {
           '@graphprotocol/graph-cli': GRAPH_CLI_VERSION,
-          '@graphprotocol/graph-ts': `0.24.1`,
+          '@graphprotocol/graph-ts': `0.26.0`,
         },
       }),
       { parser: 'json' },

package/src/subgraph.js

@@ -27,7 +27,7 @@ const buildCombinedWarning = (filename, warnings) =>
     ? warnings.reduce(
         (msg, w) =>
           `${msg}
-  
+
     Path: ${w.get('path').size === 0 ? '/' : w.get('path').join(' > ')}
     ${w
       .get('message')
@@ -39,9 +39,21 @@ const buildCombinedWarning = (filename, warnings) =>
 
 module.exports = class Subgraph {
   static async validate(data, protocol, { resolveFile }) {
+    if (protocol.name == null) {
+      return immutable.fromJS([
+        {
+          path: [],
+          message: `Unable to determine for which protocol manifest file is built for. Ensure you have at least one 'dataSources' and/or 'templates' elements defined in your subgraph.`,
+        },
+      ])
+    }
+
     // Parse the default subgraph schema
     let schema = graphql.parse(
-      await fs.readFile(path.join(__dirname, '..', 'manifest-schema.graphql'), 'utf-8'),
+      await fs.readFile(
+        path.join(__dirname, 'protocols', protocol.name, `manifest.graphql`),
+        'utf-8',
+      ),
     )
 
     // Obtain the root `SubgraphManifest` type from the schema
@@ -146,10 +158,11 @@ At least one such handler must be defined.`,
   }
 
   static validateContractValues(manifest, protocol) {
-    return validation.validateContractValues(
-      manifest,
-      protocol,
-    )
+    if (!protocol.hasContract()){
+      return immutable.List()
+    }
+
+    return validation.validateContractValues(manifest, protocol)
   }
 
   // Validate that data source names are unique, so they don't overwrite each other.
@@ -200,17 +213,13 @@ More than one template named '${name}', template names must be unique.`,
     return yaml.stringify(manifest.toJS())
   }
 
-  static async load(
-    filename,
-    { protocol, skipValidation } = { skipValidation: false }
-  ) {
+  static async load(filename, { protocol, skipValidation } = { skipValidation: false }) {
     // Load and validate the manifest
     let data = null
 
-    if(filename.match(/.js$/)) {
+    if (filename.match(/.js$/)) {
       data = require(path.resolve(filename))
-    }
-    else {
+    } else {
       data = yaml.parse(await fs.readFile(filename, 'utf-8'))
     }
 

package/src/validation/manifest.js

@@ -52,8 +52,7 @@ const validators = immutable.fromJS({
     validators.get(ctx.getIn(['type', 'name', 'value']))(value, ctx),
 
   UnionTypeDefinition: (value, ctx) => {
-    const unionVariants = ctx
-      .getIn(['type', 'types'])
+    const unionVariants = ctx.getIn(['type', 'types'])
 
     let errors = List()
 
@@ -78,7 +77,10 @@ const validators = immutable.fromJS({
 
   NonNullType: (value, ctx) =>
     value !== null && value !== undefined
-      ? validateValue(value, ctx.update('type', type => type.get('type')))
+      ? validateValue(
+          value,
+          ctx.update('type', type => type.get('type')),
+        )
       : immutable.fromJS([
           {
             path: ctx.get('path'),
@@ -126,7 +128,7 @@ const validators = immutable.fromJS({
                     ),
                   )
                 : errors.push(
-                    key == 'templates'
+                    key == 'templates' && ctx.get('protocol').hasTemplates()
                       ? immutable.fromJS({
                           path: ctx.get('path'),
                           message:
@@ -149,6 +151,23 @@ const validators = immutable.fromJS({
         ])
   },
 
+  EnumTypeDefinition: (value, ctx) => {
+    const enumValues = ctx.getIn(['type', 'values']).map((v) => {
+      return v.getIn(['name', 'value'])
+    })
+
+    const allowedValues = enumValues.toArray().join(', ')
+
+    return enumValues.includes(value)
+      ? List()
+      : immutable.fromJS([
+        {
+          path: ctx.get('path'),
+          message: `Unexpected enum value: ${value}, allowed values: ${allowedValues}`,
+        },
+      ])
+  },
+
   String: (value, ctx) =>
     typeof value === 'string'
       ? List()
@@ -211,7 +230,8 @@ const validateValue = (value, ctx) => {
 }
 
 const validateDataSourceForNetwork = (dataSources, protocol) =>
-  dataSources.filter(dataSource => protocol.isValidKindName(dataSource.kind))
+  dataSources
+    .filter(dataSource => protocol.isValidKindName(dataSource.kind))
     .reduce(
       (networks, dataSource) =>
         networks.update(dataSource.network, dataSources =>
@@ -235,11 +255,11 @@ const validateDataSourceNetworks = (value, protocol) => {
 ${networks
   .map(
     (dataSources, network) =>
-    `  ${
+      `  ${
         network === undefined
           ? 'Data sources and templates having no network set'
-        : `Data sources and templates using '${network}'`
-        }:\n${dataSources.map(ds => `    - ${ds}`).join('\n')}`,
+          : `Data sources and templates using '${network}'`
+      }:\n${dataSources.map(ds => `    - ${ds}`).join('\n')}`,
   )
   .join('\n')}
 Recommendation: Make all data sources and templates use the same network name.`,
@@ -262,6 +282,7 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
             path: [],
             errors: [],
             resolveFile,
+            protocol,
           }),
         )
       : immutable.fromJS([