@graphprotocol/graph-cli 0.25.2 → 0.27.0

package/src/protocols/ethereum/codegen/abi.js

@@ -1,16 +1,22 @@
 const immutable = require('immutable')
+const fs = require('fs')
+const yaml = require('yaml')
+const request = require('sync-request')
+const Web3EthAbi = require('web3-eth-abi');
 
 const tsCodegen = require('../../../codegen/typescript')
 const typesCodegen = require('../../../codegen/types')
 const util = require('../../../codegen/util')
 
+const doFixtureCodegen = fs.existsSync('./fixtures.yaml');
+
 module.exports = class AbiCodeGenerator {
   constructor(abi) {
     this.abi = abi
   }
 
   generateModuleImports() {
-    return [
+    let imports = [
       tsCodegen.moduleImports(
         [
           // Ethereum integration
@@ -27,8 +33,21 @@ module.exports = class AbiCodeGenerator {
           'BigInt',
         ],
         '@graphprotocol/graph-ts',
-      ),
+      )
     ]
+
+    if (doFixtureCodegen) {
+      imports.push(
+        tsCodegen.moduleImports(
+          [
+            'newMockEvent',
+          ],
+          'matchstick-as/assembly/index',
+        )
+      )
+    }
+
+    return imports
   }
 
   generateTypes() {
@@ -182,6 +201,7 @@ module.exports = class AbiCodeGenerator {
           setName: (input, name) => input.set('name', name),
         })
 
+        let namesAndTypes = []
         inputs.forEach((input, index) => {
           // Generate getters and classes for event params
           let paramObject = this._generateInputOrOutput(
@@ -192,6 +212,11 @@ module.exports = class AbiCodeGenerator {
             `parameters`,
           )
           paramsClass.addMethod(paramObject.getter)
+          let ethType = typesCodegen.ethereumTypeForAsc(paramObject.getter.returnType)
+          if (typeof ethType === typeof {} && (ethType.test("int256") || ethType.test("uint256"))) {
+            ethType = "int32"
+          }
+          namesAndTypes.push({name: paramObject.getter.name.slice(4), type: ethType})
           tupleClasses.push(...paramObject.classes)
         })
 
@@ -208,6 +233,51 @@ module.exports = class AbiCodeGenerator {
             `return new ${paramsClassName}(this)`,
           ),
         )
+
+        // Fixture generation
+        if (doFixtureCodegen) {
+          const args = yaml.parse(fs.readFileSync('./fixtures.yaml', 'utf8'))
+          const blockNumber = args['blockNumber']
+          const contractAddr = args['contractAddr']
+          const topic0 = args['topic0']
+          const apiKey = args['apiKey']
+          const url = `https://api.etherscan.io/api?module=logs&action=getLogs&fromBlock=${blockNumber}&toBlock=${blockNumber}&address=${contractAddr}&${topic0}=topic0&apikey=${apiKey}`;
+
+          let resp = request("GET", url)
+          let body = JSON.parse(resp.getBody("utf8"))
+          if (body.status === '0') {
+            throw new Error(body.result)
+          }
+
+          let res = Web3EthAbi.decodeLog(
+            namesAndTypes,
+            body.result[0].data,
+            []
+          );
+
+          let stmnts = ""
+          for (let i = 0; i < namesAndTypes.length; i++) {
+            let code = '"' + res[i] + '"'
+            if (namesAndTypes[i].type.toString() == "address") {
+              code = `Address.fromString(${code})`
+            }
+            stmnts = stmnts.concat(`event.parameters.push(new ethereum.EventParam(\"${namesAndTypes[i].name}\", ${typesCodegen.ethereumFromAsc(code, namesAndTypes[i].type)}));`, `\n`)
+          }
+
+          klass.addMethod(
+            tsCodegen.staticMethod(
+              `mock${eventClassName}`,
+              [],
+              tsCodegen.namedType(eventClassName),
+              `
+              let event = changetype<${eventClassName}>(newMockEvent());
+              ${stmnts}
+              return event;
+              `,
+            )
+          )
+        }
+
         return [klass, paramsClass, ...tupleClasses]
       })
 

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

@@ -60,10 +60,7 @@ module.exports = class Protocol {
         'aurora',
         'aurora-testnet',
       ],
-      near: [
-        'near-mainnet',
-        'near-testnet'
-      ],
+      near: ['near-mainnet', 'near-testnet'],
     })
   }
 
@@ -108,6 +105,15 @@ module.exports = class Protocol {
     }
   }
 
+  hasTemplates() {
+    switch (this.name) {
+      case 'ethereum':
+        return true
+      case 'near':
+        return false
+    }
+  }
+
   getTypeGenerator(options) {
     switch (this.name) {
       case 'ethereum':
@@ -118,13 +124,17 @@ module.exports = class Protocol {
   }
 
   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`)
     }
   }
 

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/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,7 @@ At least one such handler must be defined.`,
   }
 
   static validateContractValues(manifest, protocol) {
-    return validation.validateContractValues(
-      manifest,
-      protocol,
-    )
+    return validation.validateContractValues(manifest, protocol)
   }
 
   // Validate that data source names are unique, so they don't overwrite each other.
@@ -200,17 +209,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:
@@ -211,7 +213,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 +238,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 +265,7 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
             path: [],
             errors: [],
             resolveFile,
+            protocol,
           }),
         )
       : immutable.fromJS([

package/tests/cli/validation/example-values-found.stderr

@@ -1,10 +1,10 @@
 - Load subgraph from subgraph.yaml
 ⚠ Warnings while loading subgraph from subgraph.yaml: Warnings in subgraph.yaml:
-  
+
     Path: repository
     The repository is still set to https://github.com/graphprotocol/example-subgraph.
     Please replace it with a link to your subgraph source code.
-  
+
     Path: description
     The description is still the one from the example subgraph.
     Please update it to tell users more about your subgraph.

package/tests/cli/validation/invalid-manifest/subgraph.yaml

@@ -1,7 +1,8 @@
 schema:
   file: ./non-existent.grapqhl
 dataSources:
-  - name: 5
+  - kind: ethereum/contract
+    name: 5
     abis:
       name: Foo
     mapping:

package/tests/cli/validation/invalid-manifest-cannot-infer-protocol/subgraph.yaml

@@ -0,0 +1,12 @@
+schema:
+  file: ./non-existent.grapqhl
+dataSources:
+  - name: 5
+    abis:
+      name: Foo
+    mapping:
+      - 12
+      - 13
+      - 14
+templates:
+  field: foo

package/tests/cli/validation/invalid-manifest-cannot-infer-protocol.stderr

@@ -0,0 +1,5 @@
+- Load subgraph from subgraph.yaml
+✖ Failed to load subgraph from subgraph.yaml: Error in subgraph.yaml:
+
+  Path: /
+  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.

package/tests/cli/validation/invalid-manifest.stderr

@@ -7,9 +7,6 @@
   Path: schema > file
   File does not exist: non-existent.grapqhl
 
-  Path: dataSources > 0 > kind
-  No value provided
-
   Path: dataSources > 0 > name
   Expected string, found number:
   5

package/tests/cli/validation.test.js

@@ -9,6 +9,14 @@ describe('Validation', () => {
       exitCode: 1,
     },
   )
+  cliTest(
+    'Invalid subgraph manifest (cannot infer protocol)',
+    ['codegen', '--skip-migrations'],
+    'validation/invalid-manifest-cannot-infer-protocol',
+    {
+      exitCode: 1,
+    },
+  )
   cliTest(
     'ABI not found in data source',
     ['codegen', '--skip-migrations'],