@graphprotocol/graph-cli 0.27.1 → 0.28.2

package/README.md

@@ -1,7 +1,7 @@
 # The Graph CLI (graph-cli)
 
 [![npm (scoped)](https://img.shields.io/npm/v/@graphprotocol/graph-cli.svg)](https://www.npmjs.com/package/@graphprotocol/graph-cli)
-[![Build Status](https://travis-ci.org/graphprotocol/graph-cli.svg?branch=master)](https://travis-ci.org/graphprotocol/graph-cli)
+[![Build Status](https://travis-ci.org/graphprotocol/graph-cli.svg?branch=main)](https://travis-ci.org/graphprotocol/graph-cli)
 
 ## The Graph Command Line Interface
 
@@ -57,9 +57,9 @@ If you are ready to dive into the details of building a subgraph from scratch, t
 
 The steps to create a new version of the `graph-cli` are:
 
-1. Decide which version number you'll be rolling out. You can check the differences between the current `master` branch and the latest release.
+1. Decide which version number you'll be rolling out. You can check the differences between the current `main` branch and the latest release.
 2. Create a PR with the commit generated by `npm version <VERSION> [<PREID>]`.
-3. Once that's approved and merged to `master`, you can publish it to `npm` and push the git tags as well.
+3. Once that's approved and merged to `main`, you can publish it to `npm` and push the git tags as well.
 4. Last but not least, create a Github Release refering to the pushed git tag, linking to the PRs involved.
 
 Helpful links:
@@ -84,7 +84,7 @@ npm version minor
 git push --set-upstream <REMOTE> <BRANCH>
 ```
 
-Once that's approved and merged, you can update your local `master` and:
+Once that's approved and merged, you can update your local `main` and:
 
 ```
 npm publish
@@ -106,7 +106,7 @@ npm version preminor --preid alpha
 git push --set-upstream <REMOTE> <BRANCH>
 ```
 
-Once that's approved and merged, you can update your local `master` and:
+Once that's approved and merged, you can update your local `main` and:
 
 ```
 npm publish --tag alpha
@@ -128,7 +128,7 @@ npm version prerelease --preid alpha
 git push --set-upstream <REMOTE> <BRANCH>
 ```
 
-Once that's approved and merged, you can update your local `master` and:
+Once that's approved and merged, you can update your local `main` and:
 
 ```
 npm publish --tag alpha

package/examples/basic-event-handlers/package.json

@@ -9,7 +9,7 @@
     "deploy-test": "../../bin/graph deploy test/basic-event-handlers --version-label v0.0.1 --ipfs http://localhost:15001 --node http://127.0.0.1:18020"
   },
   "devDependencies": {
-    "@graphprotocol/graph-ts": "0.24.1",
+    "@graphprotocol/graph-ts": "0.26.0",
     "apollo-fetch": "^0.7.0"
   },
   "dependencies": {

package/examples/basic-event-handlers/yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@graphprotocol/graph-ts@0.24.1":
-  version "0.24.1"
-  resolved "https://registry.yarnpkg.com/@graphprotocol/graph-ts/-/graph-ts-0.24.1.tgz#50961b52b5383f9c5cf5e6e23fa039f24e729ddf"
-  integrity sha512-2vU4m5ZPQIqMlMce/z5vmOtGHRlRmcRhMfemS3NIwxCSxSBGVnX2zb7QBTzzdQKGwsAZdbz6V0okkOtvohELfQ==
+"@graphprotocol/graph-ts@0.26.0":
+  version "0.26.0"
+  resolved "https://registry.yarnpkg.com/@graphprotocol/graph-ts/-/graph-ts-0.26.0.tgz#576f995531eebaca4374901aeaff499219e382e8"
+  integrity sha512-GW/emOJl+35MXgmIxTnUK7dJtPCaB9u5aAwoLVqJ8swogC794O92UrXMVrAJsherUriu+yI9bLMGmNPOIi60jw==
   dependencies:
     assemblyscript "0.19.10"
 

package/examples/example-subgraph/package.json

@@ -7,7 +7,7 @@
     "build-wast": "../../bin/graph build -t wast subgraph.yaml"
   },
   "devDependencies": {
-    "@graphprotocol/graph-ts": "0.24.1"
+    "@graphprotocol/graph-ts": "0.26.0"
   },
   "resolutions": {
     "assemblyscript": "0.19.10"

package/examples/example-subgraph/yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@graphprotocol/graph-ts@0.24.1":
-  version "0.24.1"
-  resolved "https://registry.yarnpkg.com/@graphprotocol/graph-ts/-/graph-ts-0.24.1.tgz#50961b52b5383f9c5cf5e6e23fa039f24e729ddf"
-  integrity sha512-2vU4m5ZPQIqMlMce/z5vmOtGHRlRmcRhMfemS3NIwxCSxSBGVnX2zb7QBTzzdQKGwsAZdbz6V0okkOtvohELfQ==
+"@graphprotocol/graph-ts@0.26.0":
+  version "0.26.0"
+  resolved "https://registry.yarnpkg.com/@graphprotocol/graph-ts/-/graph-ts-0.26.0.tgz#576f995531eebaca4374901aeaff499219e382e8"
+  integrity sha512-GW/emOJl+35MXgmIxTnUK7dJtPCaB9u5aAwoLVqJ8swogC794O92UrXMVrAJsherUriu+yI9bLMGmNPOIi60jw==
   dependencies:
     assemblyscript "0.19.10"
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.27.1",
+  "version": "0.28.2",
   "license": "(Apache-2.0 OR MIT)",
   "description": "CLI for building for and deploying to The Graph",
   "dependencies": {

package/src/codegen/schema.js

@@ -5,6 +5,53 @@ const typesCodegen = require('./types')
 
 const List = immutable.List
 
+class IdField {
+  static BYTES = Symbol("Bytes")
+  static STRING = Symbol("String")
+
+  constructor(idField) {
+    const typeName = idField.getIn(['type', 'type', 'name', 'value'])
+    this.kind = typeName === "Bytes" ? IdField.BYTES : IdField.STRING
+  }
+
+  typeName() {
+    return this.kind === IdField.BYTES ? "Bytes" : "string"
+  }
+
+  gqlTypeName() {
+    return this.kind === IdField.BYTES ? "Bytes" : "String"
+  }
+
+  tsNamedType() {
+    return tsCodegen.namedType(this.typeName())
+  }
+
+  tsValueFrom() {
+    return this.kind === IdField.BYTES ? "Value.fromBytes(id)" : "Value.fromString(id)"
+  }
+
+  tsValueKind() {
+    return this.kind === IdField.BYTES ? "ValueKind.BYTES" : "ValueKind.STRING"
+  }
+
+  tsValueToString() {
+    return this.kind == IdField.BYTES ? "id.toBytes().toHexString()" : "id.toString()"
+  }
+
+  tsToString() {
+    return this.kind == IdField.BYTES ? "id.toHexString()" : "id"
+  }
+
+  static fromFields(fields) {
+    const idField = fields.find(field => field.getIn(['name', 'value']) === 'id')
+    return new IdField(idField)
+  }
+
+  static fromTypeDef(def) {
+    return IdField.fromFields(def.get("fields"))
+  }
+}
+
 module.exports = class SchemaCodeGenerator {
   constructor(schema) {
     this.schema = schema
@@ -52,12 +99,14 @@ module.exports = class SchemaCodeGenerator {
   _generateEntityType(def) {
     let name = def.getIn(['name', 'value'])
     let klass = tsCodegen.klass(name, { export: true, extends: 'Entity' })
+    const fields = def.get('fields')
+    const idField = IdField.fromFields(fields)
 
     // Generate and add a constructor
-    klass.addMethod(this._generateConstructor(name))
+    klass.addMethod(this._generateConstructor(name, fields))
 
     // Generate and add save() and getById() methods
-    this._generateStoreMethods(name).forEach(method => klass.addMethod(method))
+    this._generateStoreMethods(name, idField).forEach(method => klass.addMethod(method))
 
     // Generate and add entity field getters and setters
     def
@@ -71,19 +120,20 @@ module.exports = class SchemaCodeGenerator {
     return klass
   }
 
-  _generateConstructor(entityName) {
+  _generateConstructor(entityName, fields) {
+    const idField = IdField.fromFields(fields)
     return tsCodegen.method(
       'constructor',
-      [tsCodegen.param('id', tsCodegen.namedType('string'))],
+      [tsCodegen.param('id', idField.tsNamedType())],
       undefined,
       `
       super()
-      this.set('id', Value.fromString(id))
+      this.set('id', ${idField.tsValueFrom()})
       `,
     )
   }
 
-  _generateStoreMethods(entityName) {
+  _generateStoreMethods(entityName, idField) {
     return List.of(
       tsCodegen.method(
         'save',
@@ -91,23 +141,21 @@ module.exports = class SchemaCodeGenerator {
         tsCodegen.namedType('void'),
         `
         let id = this.get('id')
-        assert(id != null, 'Cannot save ${entityName} entity without an ID')
+        assert(id != null,
+               'Cannot save ${entityName} entity without an ID')
         if (id) {
-          assert(
-            id.kind == ValueKind.STRING,
-            'Cannot save ${entityName} entity with non-string ID. ' +
-            'Considering using .toHex() to convert the "id" to a string.'
-          )
-          store.set('${entityName}', id.toString(), this)
+          assert(id.kind == ${idField.tsValueKind()},
+                 \`Entities of type ${entityName} must have an ID of type ${idField.gqlTypeName()} but the id '\${id.displayData()}' is of type \${id.displayKind()}\`)
+          store.set('${entityName}', ${idField.tsValueToString()}, this)
         }`,
       ),
 
       tsCodegen.staticMethod(
         'load',
-        [tsCodegen.param('id', tsCodegen.namedType('string'))],
+        [tsCodegen.param('id', tsCodegen.namedType(idField.typeName()))],
         tsCodegen.nullableType(tsCodegen.namedType(entityName)),
         `
-        return changetype<${entityName} | null>(store.get('${entityName}', id))
+        return changetype<${entityName} | null>(store.get('${entityName}', ${idField.tsToString()}))
         `,
       ),
     )
@@ -158,13 +206,12 @@ module.exports = class SchemaCodeGenerator {
       isArray &&
       paramType.inner instanceof tsCodegen.NullableType
     ) {
-      let arrayTypeWithoutClosingBracked = fieldValueType.slice(0, -1)
-      let suggestedType = `${arrayTypeWithoutClosingBracked}!]`
+      let baseType = this._baseType(gqlType)
 
       throw new Error(`
 GraphQL schema can't have List's with Nullable members.
-Error in '${name}' field of type '${fieldValueType}'.
-Suggestion: add an '!' to the member type of the List, change from '${fieldValueType}' to '${suggestedType}'`
+Error in '${name}' field of type '[${baseType}]'.
+Suggestion: add an '!' to the member type of the List, change from '[${baseType}]' to '[${baseType}!]'`
       )
     }
 
@@ -176,7 +223,7 @@ Suggestion: add an '!' to the member type of the List, change from '${fieldValue
         this.unset('${name}')
       } else {
         this.set('${name}', ${typesCodegen.valueFromAsc(
-        `<${paramTypeString}>value`,
+      `<${paramTypeString}>value`,
       fieldValueType,
     )})
       }
@@ -190,12 +237,44 @@ Suggestion: add an '!' to the member type of the List, change from '${fieldValue
     )
   }
 
+  _resolveFieldType(gqlType) {
+    let typeName = gqlType.getIn(['name', 'value'])
+
+    // If this is a reference to another type, the field has the type of
+    // the referred type's id field
+    const typeDef = this.schema.ast.get("definitions").
+      find(def => this._isEntityTypeDefinition(def) && def.getIn(["name", "value"]) === typeName)
+    if (typeDef) {
+      return IdField.fromTypeDef(typeDef).typeName()
+    } else {
+      return typeName
+    }
+  }
+
+  /** Return the type that values for this field must have. For scalar
+   * types, that's the type from the subgraph schema. For references to
+   * other entity types, this is the same as the type of the id of the
+   * referred type, i.e., `string` or `Bytes`*/
   _valueTypeFromGraphQl(gqlType) {
-    return gqlType.get('kind') === 'NonNullType'
-      ? this._valueTypeFromGraphQl(gqlType.get('type'), false)
-      : gqlType.get('kind') === 'ListType'
-      ? '[' + this._valueTypeFromGraphQl(gqlType.get('type')) + ']'
-      : gqlType.getIn(['name', 'value'])
+    if (gqlType.get('kind') === 'NonNullType') {
+      return this._valueTypeFromGraphQl(gqlType.get('type'), false)
+    } else if (gqlType.get('kind') === 'ListType') {
+      return '[' + this._valueTypeFromGraphQl(gqlType.get('type')) + ']'
+    } else {
+      return this._resolveFieldType(gqlType)
+    }
+  }
+
+  /** Determine the base type of `gqlType` by removing any non-null
+   * constraints and using the type of elements of lists */
+  _baseType(gqlType) {
+    if (gqlType.get('kind') === 'NonNullType') {
+      return this._baseType(gqlType.get('type'))
+    } else if (gqlType.get('kind') === 'ListType') {
+      return this._baseType(gqlType.get('type'))
+    } else {
+      return gqlType.getIn(['name', 'value'])
+    }
   }
 
   _typeFromGraphQl(gqlType, nullable = true) {
@@ -207,7 +286,7 @@ Suggestion: add an '!' to the member type of the List, change from '${fieldValue
     } else {
       // NamedType
       let type = tsCodegen.namedType(
-        typesCodegen.ascTypeForValue(gqlType.getIn(['name', 'value'])),
+        typesCodegen.ascTypeForValue(this._resolveFieldType(gqlType)),
       )
       // In AssemblyScript, primitives cannot be nullable.
       return nullable && !type.isPrimitive() ? tsCodegen.nullableType(type) : type

package/src/codegen/schema.test.js

@@ -126,9 +126,7 @@ describe('Schema code generator', () => {
               if (id) {
                 assert(
                   id.kind == ValueKind.STRING,
-                  'Cannot save Account entity with non-string ID. ' +
-                  'Considering using .toHex() to convert the "id" to a string.'
-                )
+                  \`Entities of type Account must have an ID of type String but the id '\${id.displayData()}' is of type \${id.displayKind()}\`)
                 store.set('Account', id.toString(), this)
               }
             `,
@@ -288,9 +286,7 @@ describe('Schema code generator', () => {
               if (id) {
                 assert(
                   id.kind == ValueKind.STRING,
-                  'Cannot save Wallet entity with non-string ID. ' +
-                  'Considering using .toHex() to convert the "id" to a string.'
-                )
+                  \`Entities of type Wallet must have an ID of type String but the id '\${id.displayData()}' is of type \${id.displayKind()}\`)
                 store.set('Wallet', id.toString(), this)
               }
             `,

package/src/commands/codegen.js

@@ -71,7 +71,7 @@ module.exports = {
       // because that would mean the CLI would generate code to
       // the wrong AssemblyScript version.
       await assertManifestApiVersion(manifest, '0.0.5')
-      await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+      await assertGraphTsVersion(path.dirname(manifest), '0.25.0')
 
       const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 

package/src/commands/deploy.js

@@ -200,7 +200,7 @@ module.exports = {
       // because that would mean the CLI would try to compile code
       // using the wrong AssemblyScript compiler.
       await assertManifestApiVersion(manifest, '0.0.5')
-      await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
+      await assertGraphTsVersion(path.dirname(manifest), '0.25.0')
 
       const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 

package/src/commands/init.js

@@ -285,6 +285,7 @@ const getEtherscanLikeAPIUrl = (network) => {
     case "mumbai": return `https://api-testnet.polygonscan.com/api`;
     case "aurora": return `https://api.aurorascan.dev/api`;
     case "aurora-testnet": return `https://api-testnet.aurorascan.dev/api`;
+    case "optimism-kovan": return `https://api-kovan-optimistic.etherscan.io/api`;
     default: return `https://api-${network}.etherscan.io/api`;
   }
 } 

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']
     })
   }
 
@@ -61,6 +63,7 @@ module.exports = class Protocol {
         'aurora-testnet',
       ],
       near: ['near-mainnet', 'near-testnet'],
+      tendermint: ['cosmoshub-4']
     })
   }
 
@@ -76,6 +79,8 @@ module.exports = class Protocol {
         return 'Ethereum'
       case 'near':
         return 'NEAR'
+      case 'tendermint':
+        return 'Tendermint'
     }
   }
 
@@ -93,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
     }
   }
 
@@ -102,6 +120,8 @@ module.exports = class Protocol {
         return true
       case 'near':
         return false
+      case 'tendermint':
+        return false
     }
   }
 
@@ -111,6 +131,8 @@ module.exports = class Protocol {
         return true
       case 'near':
         return false
+      case 'tendermint':
+        return false
     }
   }
 
@@ -120,6 +142,8 @@ module.exports = class Protocol {
         return new EthereumTypeGenerator(options)
       case 'near':
         return null
+      case 'tendermint':
+        return null
     }
   }
 
@@ -144,6 +168,8 @@ module.exports = class Protocol {
         return EthereumABI
       case 'near':
         return null
+      case 'tendermint':
+        return null
     }
   }
 
@@ -155,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`)
     }
@@ -166,6 +194,8 @@ module.exports = class Protocol {
         return EthereumContract
       case 'near':
         return NearContract
+      case 'tendermint':
+        return null
     }
   }
 
@@ -175,6 +205,8 @@ module.exports = class Protocol {
         return EthereumManifestScaffold
       case 'near':
         return NearManifestScaffold
+      case 'tendermint':
+        return null
     }
   }
 
@@ -184,6 +216,8 @@ module.exports = class Protocol {
         return EthereumMappingScaffold
       case 'near':
         return NearMappingScaffold
+      case 'tendermint':
+        return null
     }
   }
 }

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

@@ -158,6 +158,10 @@ At least one such handler must be defined.`,
   }
 
   static validateContractValues(manifest, protocol) {
+    if (!protocol.hasContract()){
+      return immutable.List()
+    }
+
     return validation.validateContractValues(manifest, protocol)
   }
 

package/src/validation/manifest.js

@@ -151,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()