@graphprotocol/graph-cli 0.30.0-alpha.0 → 0.30.1

package/src/scaffold/cosmos.test.js

@@ -0,0 +1,86 @@
+const immutable = require('immutable')
+const Scaffold = require('./')
+const Protocol = require('../protocols')
+
+const protocol = new Protocol('cosmos')
+
+const scaffoldOptions = {
+  protocol,
+  network: 'cosmoshub-4',
+  dataSourceName: 'CosmosHub'
+}
+
+const scaffold = new Scaffold(scaffoldOptions)
+
+describe('Cosmos subgraph scaffolding', () => {
+  test('Manifest', () => {
+    expect(
+      scaffold.generateManifest(),
+    ).toEqual(`\
+specVersion: 0.0.1
+schema:
+  file: ./schema.graphql
+dataSources:
+  - kind: cosmos
+    name: CosmosHub
+    network: cosmoshub-4
+    source:
+      startBlock: 0
+    mapping:
+      apiVersion: 0.0.5
+      language: wasm/assemblyscript
+      entities:
+        - ExampleEntity
+      blockHandlers:
+        - handler: handleBlock
+      file: ./src/mapping.ts
+`)
+  })
+
+  test('Schema (default)', () => {
+    expect(scaffold.generateSchema()).toEqual(`\
+type ExampleEntity @entity {
+  id: ID!
+  block: Bytes!
+  count: BigInt!
+}
+`)
+  })
+
+  test('Mapping (default)', () => {
+    expect(scaffold.generateMapping()).toEqual(`\
+import { cosmos, BigInt } from "@graphprotocol/graph-ts"
+import { ExampleEntity } from "../generated/schema"
+
+export function handleBlock(block: cosmos.Block): void {
+  // Entities can be loaded from the store using a string ID; this ID
+  // needs to be unique across all entities of the same type
+  let entity = ExampleEntity.load(block.header.hash.toHex())
+
+  // Entities only exist after they have been saved to the store;
+  // \`null\` checks allow to create entities on demand
+  if (!entity) {
+    entity = new ExampleEntity(block.header.hash.toHex())
+
+    // Entity fields can be set using simple assignments
+    entity.count = BigInt.fromI32(0)
+  }
+
+  // BigInt and BigDecimal math are supported
+  entity.count = entity.count + BigInt.fromI32(1)
+
+  // Entity fields can be set based on receipt information
+  entity.height = block.header.height
+
+  // Entities can be written to the store with \`.save()\`
+  entity.save()
+
+  // Note: If a handler doesn't require existing field values, it is faster
+  // _not_ to load the entity from the store. Instead, create it fresh with
+  // \`new Entity(...)\`, set the fields that should be updated and save the
+  // entity back to the store. Fields that were not set or unset remain
+  // unchanged, allowing for partial updates to be applied.
+}
+`)
+  })
+})

package/src/scaffold/ethereum.test.js

@@ -77,6 +77,7 @@ const scaffoldOptions = {
   contract: '0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d',
   network: 'kovan',
   contractName: 'Contract',
+  dataSourceName: 'Contract'
 }
 
 const scaffold = new Scaffold(scaffoldOptions)
@@ -116,7 +117,7 @@ dataSources:
           handler: handleExampleEvent
         - event: ExampleEvent(bytes32)
           handler: handleExampleEvent1
-      file: ./src/mapping.ts
+      file: ./src/contract.ts
 `)
   })
 

package/src/scaffold/index.js

@@ -1,5 +1,6 @@
 const prettier = require('prettier')
 const pkginfo = require('pkginfo')(module)
+const { strings } = require('gluegun')
 
 const GRAPH_CLI_VERSION = process.env.GRAPH_CLI_TESTS
   // JSON.stringify should remove this key, we will install the local
@@ -25,6 +26,7 @@ module.exports = class Scaffold {
     this.network = options.network
     this.contractName = options.contractName
     this.subgraphName = options.subgraphName
+    this.dataSourceName = options.dataSourceName
     this.node = options.node
   }
 
@@ -50,7 +52,7 @@ module.exports = class Scaffold {
         },
         dependencies: {
           '@graphprotocol/graph-cli': GRAPH_CLI_VERSION,
-          '@graphprotocol/graph-ts': `0.27.0-alpha.0`,
+          '@graphprotocol/graph-ts': `0.27.0`,
         },
       }),
       { parser: 'json' },
@@ -66,7 +68,7 @@ schema:
   file: ./schema.graphql
 dataSources:
   - kind: ${this.protocol.name}
-    name: ${this.contractName}
+    name: ${this.dataSourceName}
     network: ${this.network}
     source: ${protocolManifest.source(this)}
     mapping: ${protocolManifest.mapping(this)}
@@ -142,7 +144,7 @@ dataSources:
       'subgraph.yaml': this.generateManifest(),
       'schema.graphql': this.generateSchema(),
       'tsconfig.json': this.generateTsConfig(),
-      src: { 'mapping.ts': this.generateMapping() },
+      src: { [`${strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() },
       abis: this.generateABIs(),
     }
   }

package/src/scaffold/near.test.js

@@ -9,6 +9,7 @@ const scaffoldOptions = {
   contract: 'abc.def.near',
   network: 'near-mainnet',
   contractName: 'Contract',
+  dataSourceName: 'Contract'
 }
 
 const scaffold = new Scaffold(scaffoldOptions)
@@ -34,7 +35,7 @@ dataSources:
         - ExampleEntity
       receiptHandlers:
         - handler: handleReceipt
-      file: ./src/mapping.ts
+      file: ./src/contract.ts
 `)
   })
 

package/src/validation/manifest.js

@@ -2,6 +2,8 @@ const immutable = require('immutable')
 const yaml = require('js-yaml')
 const path = require('path')
 
+const Protocol = require('../protocols')
+
 const List = immutable.List
 const Map = immutable.Map
 
@@ -241,23 +243,61 @@ const validateValue = (value, ctx) => {
   }
 }
 
-const validateDataSourceForNetwork = (dataSources, protocol) =>
+// Transforms list of data sources like this:
+// [
+//   { name: 'contract0', kind: 'ethereum/contract', network: 'mainnet' },
+//   { name: 'contract1', kind: 'ethereum', network: 'mainnet' },
+//   { name: 'contract2', kind: 'ethereum/contract', network: 'xdai' },
+//   { name: 'contract3', kind: 'near', network: 'near-mainnet' },
+// ]
+//
+// Into Immutable JS structure like this (protocol kind is normalized):
+// {
+//   ethereum: {
+//     mainnet: ['contract0', 'contract1'],
+//     xdai: ['contract2'],
+//   },
+//   near: {
+//     'near-mainnet': ['contract3'],
+//   },
+// }
+const dataSourceListToMap = dataSources =>
   dataSources
-    .filter(dataSource => protocol.isValidKindName(dataSource.kind))
     .reduce(
-      (networks, dataSource) =>
-        networks.update(dataSource.network, dataSources =>
-          (dataSources || immutable.OrderedSet()).add(dataSource.name),
+      (protocolKinds, dataSource) =>
+        protocolKinds.update(Protocol.normalizeName(dataSource.kind), networks =>
+          (networks || immutable.OrderedMap()).update(dataSource.network, dataSourceNames =>
+            (dataSourceNames || immutable.OrderedSet()).add(dataSource.name)),
         ),
       immutable.OrderedMap(),
     )
 
-const validateDataSourceNetworks = (value, protocol) => {
+const validateDataSourceProtocolAndNetworks = value => {
   const dataSources = [...value.dataSources, ...(value.templates || [])]
 
-  // Networks found valid for a protocol.
-  // By searching through all data sources and templates.
-  const networks = validateDataSourceForNetwork(dataSources, protocol)
+  const protocolNetworkMap = dataSourceListToMap(dataSources)
+
+  if (protocolNetworkMap.size > 1) {
+    return immutable.fromJS([
+      {
+        path: [],
+        message: `Conflicting protocol kinds used in data sources and templates:
+${protocolNetworkMap
+  .map(
+    (dataSourceNames, protocolKind) =>
+      `  ${
+        protocolKind === undefined
+          ? 'Data sources and templates having no protocol kind set'
+          : `Data sources and templates using '${protocolKind}'`
+      }:\n${dataSourceNames.valueSeq().flatten().map(ds => `    - ${ds}`).join('\n')}`,
+  )
+  .join('\n')}
+Recommendation: Make all data sources and templates use the same protocol kind.`,
+      },
+    ])
+  }
+
+  const networks = protocolNetworkMap.first()
 
   if (networks.size > 1) {
     return immutable.fromJS([
@@ -310,9 +350,9 @@ const validateManifest = (value, type, schema, protocol, { resolveFile }) => {
     return errors
   }
 
-  // Validate that all data sources are for the same `network` (this includes
-  // _no_ network at all)
-  return validateDataSourceNetworks(value, protocol)
+  // Validate that all data sources are for the same `network` and `protocol` (kind)
+  // (this includes _no_ network/protocol at all)
+  return validateDataSourceProtocolAndNetworks(value)
 }
 
 module.exports = {

package/src/validation/schema.js

@@ -35,6 +35,8 @@ const TYPE_SUGGESTIONS = [
   ['Float', 'BigDecimal'],
   ['int', 'Int'],
   ['uint', 'BigInt'],
+  ['owner', 'String'],
+  ['Owner', 'String'],
   [/^(u|uint)(8|16|24)$/, 'Int'],
   [/^(i|int)(8|16|24|32)$/, 'Int'],
   [/^(u|uint)32$/, 'BigInt'],

package/tests/cli/validation/conflicting-protocol-names/Abi.json

@@ -0,0 +1,7 @@
+[
+  {
+    "type": "event",
+    "name": "ExampleEvent",
+    "inputs": [{ "type": "string" }]
+  }
+]

package/tests/cli/validation/conflicting-protocol-names/schema.graphql

@@ -0,0 +1,3 @@
+type MyEntity @entity {
+  id: ID!
+}

package/tests/cli/validation/conflicting-protocol-names/subgraph.yaml

@@ -0,0 +1,41 @@
+specVersion: 0.0.1
+schema:
+  file: ./schema.graphql
+dataSources:
+- kind: ethereum/contract
+  name: ExampleSubgraph
+  network: mainnet
+  source:
+    address: 22843e74c59580b3eaf6c233fa67d8b7c561a835
+    abi: ExampleContract
+  mapping:
+    kind: ethereum/events
+    apiVersion: 0.0.5
+    language: wasm/assemblyscript
+    file: ./mapping.ts
+    entities:
+    - ExampleEntity
+    abis:
+    - name: ExampleContract
+      file: ./Abi.json
+    eventHandlers:
+    - event: ExampleEvent(string)
+      handler: handleExampleEvent
+templates:
+- kind: near
+  name: ExampleTemplate
+  source:
+    abi: ExampleContract
+  mapping:
+    kind: ethereum/events
+    apiVersion: 0.0.5
+    language: wasm/assemblyscript
+    file: ./mapping.ts
+    entities:
+    - ExampleEntity
+    abis:
+    - name: ExampleContract
+      file: ./Abi.json
+    eventHandlers:
+    - event: ExampleEvent(string)
+      handler: handleExampleEvent

package/tests/cli/validation/conflicting-protocol-names.stderr

@@ -0,0 +1,10 @@
+- Load subgraph from subgraph.yaml
+✖ Failed to load subgraph from subgraph.yaml: Error in subgraph.yaml:
+
+  Path: /
+  Conflicting protocol kinds used in data sources and templates:
+    Data sources and templates using 'ethereum':
+      - ExampleSubgraph
+    Data sources and templates using 'near':
+      - ExampleTemplate
+  Recommendation: Make all data sources and templates use the same protocol kind.

package/tests/cli/validation.test.js

@@ -205,6 +205,15 @@ describe('Validation', () => {
     },
   )
 
+  cliTest(
+    'Conflicting protocol names',
+    ['codegen', '--skip-migrations'],
+    'validation/conflicting-protocol-names',
+    {
+      exitCode: 1,
+    },
+  )
+
   cliTest(
     'Invalid @fulltext directive',
     ['codegen', '--skip-migrations'],