@graphprotocol/graph-cli 0.36.1 → 0.37.1-alpha-20221207192322-dd39b34

package/src/protocols/index.js

@@ -6,17 +6,23 @@ const EthereumABI = require('./ethereum/abi')
 const EthereumSubgraph = require('./ethereum/subgraph')
 const NearSubgraph = require('./near/subgraph')
 const CosmosSubgraph = require('./cosmos/subgraph')
+const SubstreamsSubgraph = require('./substreams/subgraph')
 const EthereumContract = require('./ethereum/contract')
 const NearContract = require('./near/contract')
+const ArweaveManifestScaffold = require('./arweave/scaffold/manifest')
 const EthereumManifestScaffold = require('./ethereum/scaffold/manifest')
 const NearManifestScaffold = require('./near/scaffold/manifest')
 const CosmosManifestScaffold = require('./cosmos/scaffold/manifest')
+const SubstreamsManifestScaffold = require('./substreams/scaffold/manifest')
 const ArweaveMappingScaffold = require('./arweave/scaffold/mapping')
 const EthereumMappingScaffold = require('./ethereum/scaffold/mapping')
 const NearMappingScaffold = require('./near/scaffold/mapping')
 const CosmosMappingScaffold = require('./cosmos/scaffold/mapping')
+const { ThrowStatement } = require('assemblyscript')
 
-module.exports = class Protocol {
+let protocolDebug = require('../debug')('graph-cli:protocol')
+
+class Protocol {
   static fromDataSources(dataSourcesAndTemplates) {
     const firstDataSourceKind = dataSourcesAndTemplates[0].kind
     return new Protocol(firstDataSourceKind)
@@ -24,6 +30,27 @@ module.exports = class Protocol {
 
   constructor(name) {
     this.name = Protocol.normalizeName(name)
+
+    switch (this.name) {
+      case 'arweave':
+        this.config = arweaveProtocol
+        break
+      case 'cosmos':
+        this.config = cosmosProtocol
+        break
+      case 'ethereum':
+        this.config = ethereumProtocol
+        break
+      case 'near':
+        this.config = nearProtocol
+        break
+      case 'substreams':
+        this.config = substreamsProtocol
+        break
+      default:
+      // Do not throw when undefined, a better error message is printed after the constructor
+      // when validating the Subgraph itself
+    }
   }
 
   static availableProtocols() {
@@ -33,12 +60,13 @@ module.exports = class Protocol {
       arweave: ['arweave'],
       ethereum: ['ethereum', 'ethereum/contract'],
       near: ['near'],
-      cosmos: ['cosmos']
+      cosmos: ['cosmos'],
+      substreams: ['substreams'],
     })
   }
 
   static availableNetworks() {
-    return immutable.fromJS({
+    let networks = immutable.fromJS({
       arweave: ['arweave-mainnet'],
       ethereum: [
         'mainnet',
@@ -74,30 +102,30 @@ module.exports = class Protocol {
         'cosmoshub-4',
         'theta-testnet-001', // CosmosHub testnet
         'osmosis-1',
-        'osmo-test-4',       // Osmosis testnet
-        'juno-1', 
-        'uni-3'              // Juno testnet
+        'osmo-test-4', // Osmosis testnet
+        'juno-1',
+        'uni-3', // Juno testnet
       ],
     })
+
+    let allNetworks = []
+    networks.forEach(value => {
+      allNetworks.push(...value)
+    })
+
+    networks = networks.set('substreams', immutable.fromJS(allNetworks))
+
+    return networks
   }
 
   static normalizeName(name) {
-    return Protocol.availableProtocols().findKey(possibleNames =>
-      possibleNames.includes(name),
-    )
+    return Protocol.availableProtocols().findKey(possibleNames => {
+      return possibleNames.includes(name)
+    })
   }
 
   displayName() {
-    switch (this.name) {
-      case 'arweave':
-        return 'Arweave'
-      case 'ethereum':
-        return 'Ethereum'
-      case 'near':
-        return 'NEAR'
-      case 'cosmos':
-        return 'Cosmos'
-    }
+    return this.config.displayName
   }
 
   // Receives a data source kind, and checks if it's valid
@@ -109,68 +137,34 @@ module.exports = class Protocol {
   }
 
   hasABIs() {
-    switch (this.name) {
-      case 'arweave':
-        return false
-      case 'ethereum':
-        return true
-      case 'near':
-        return false
-      case 'cosmos':
-        return false
-    }
+    return this.config.abi != null
   }
 
   hasContract() {
-    switch (this.name) {
-      case 'arweave':
-        return false
-      case 'ethereum':
-        return true
-      case 'near':
-        return true
-      case 'cosmos':
-        return false
-    }
+    return this.config.contract != null
   }
 
   hasEvents() {
-    switch (this.name) {
-      case 'arweave':
-        return false
-      case 'ethereum':
-        return true
-      case 'near':
-        return false
-      case 'cosmos':
-        return false
-    }
+    // A problem with hasEvents usage in the codebase is that it's almost every where
+    // where used, the ABI data is actually use after the conditional, so it seems
+    // both concept are related. So internally, we map to this condition.
+    return this.hasABIs()
   }
 
   hasTemplates() {
-    switch (this.name) {
-      case 'arweave':
-        return false
-      case 'ethereum':
-        return true
-      case 'near':
-        return false
-      case 'cosmos':
-        return false
-    }
+    return this.config.getTemplateCodeGen != null
+  }
+
+  hasDataSourceMappingFile() {
+    return this.config.getMappingScaffold != null
   }
 
   getTypeGenerator(options) {
-    switch (this.name) {
-      case 'arweave':
-        return null
-      case 'ethereum':
-        return new EthereumTypeGenerator(options)
-      case 'near':
-        return null
-      case 'cosmos':
-        return null
+    if (this.config == null || this.config.getTypeGenerator == null) {
+      return null
     }
+
+    return this.config.getTypeGenerator(options)
   }
 
   getTemplateCodeGen(template) {
@@ -180,80 +174,98 @@ module.exports = class Protocol {
       )
     }
 
-    switch (this.name) {
-      case 'ethereum':
-        return new EthereumTemplateCodeGen(template)
-      default:
-        throw new Error(`Template data sources with kind '${this.name}' is unknown`)
-    }
+    return this.config.getTemplateCodeGen(template)
   }
 
   getABI() {
-    switch (this.name) {
-      case 'arweave':
-        return null
-      case 'ethereum':
-        return EthereumABI
-      case 'near':
-        return null
-      case 'cosmos':
-        return null
-    }
+    return this.config.abi
   }
 
   getSubgraph(options = {}) {
-    const optionsWithProtocol = { ...options, protocol: this }
-
-    switch (this.name) {
-      case 'arweave':
-        return new ArweaveSubgraph(optionsWithProtocol)
-      case 'ethereum':
-        return new EthereumSubgraph(optionsWithProtocol)
-      case 'near':
-        return new NearSubgraph(optionsWithProtocol)
-      case 'cosmos':
-        return new CosmosSubgraph(optionsWithProtocol)
-      default:
-        throw new Error(`Data sources with kind '${this.name}' are not supported yet`)
-    }
+    return this.config.getSubgraph({ ...options, protocol: this })
   }
 
   getContract() {
-    switch (this.name) {
-      case 'arweave':
-        return null
-      case 'ethereum':
-        return EthereumContract
-      case 'near':
-        return NearContract
-      case 'cosmos':
-        return null
-    }
+    return this.config.contract
   }
 
   getManifestScaffold() {
-    switch (this.name) {
-      case 'arweave':
-        return ArweaveMappingScaffold
-      case 'ethereum':
-        return EthereumManifestScaffold
-      case 'near':
-        return NearManifestScaffold
-      case 'cosmos':
-        return CosmosManifestScaffold
-    }
+    return this.config.manifestScaffold
   }
 
   getMappingScaffold() {
-    switch (this.name) {
-      case 'arweave':
-        return ArweaveMappingScaffold
-      case 'ethereum':
-        return EthereumMappingScaffold
-      case 'near':
-        return NearMappingScaffold
-      case 'cosmos':
-        return CosmosMappingScaffold
-    }
+    return this.config.mappingScaffold
   }
 }
+
+const arweaveProtocol = {
+  displayName: 'Arweave',
+  abi: undefined,
+  contract: undefined,
+  getTemplateCodeGen: undefined,
+  getTypeGenerator: undefined,
+  getSubgraph(options) {
+    return new ArweaveSubgraph(options)
+  },
+  manifestScaffold: ArweaveManifestScaffold,
+  mappingScaffold: ArweaveMappingScaffold,
+}
+
+const cosmosProtocol = {
+  displayName: 'Cosmos',
+  abi: undefined,
+  contract: undefined,
+  getTemplateCodeGen: undefined,
+  getTypeGenerator: undefined,
+  getSubgraph(options) {
+    return new CosmosSubgraph(options)
+  },
+  manifestScaffold: CosmosManifestScaffold,
+  mappingScaffold: CosmosMappingScaffold,
+}
+
+const ethereumProtocol = {
+  displayName: 'Ethereum',
+  abi: EthereumABI,
+  contract: EthereumContract,
+  getTemplateCodeGen(template) {
+    return new EthereumTemplateCodeGen(template)
+  },
+  getTypeGenerator(options) {
+    return new EthereumTypeGenerator(options)
+  },
+  getSubgraph(options) {
+    return new EthereumSubgraph(options)
+  },
+  manifestScaffold: EthereumManifestScaffold,
+  mappingScaffold: EthereumMappingScaffold,
+}
+
+const nearProtocol = {
+  displayName: 'NEAR',
+  abi: undefined,
+  contract: NearContract,
+  getTypeGenerator: undefined,
+  getTemplateCodeGen: undefined,
+  getSubgraph(options) {
+    return new NearSubgraph(options)
+  },
+  manifestScaffold: NearManifestScaffold,
+  mappingScaffold: NearMappingScaffold,
+}
+
+const substreamsProtocol = {
+  displayName: 'Substreams',
+  abi: undefined,
+  contract: undefined,
+  getTypeGenerator: undefined,
+  getTemplateCodeGen: undefined,
+  getSubgraph(options) {
+    return new SubstreamsSubgraph(options)
+  },
+  manifestScaffold: SubstreamsManifestScaffold,
+  mappingScaffold: undefined,
+}
+
+protocolDebug('Available networks %M', Protocol.availableNetworks())
+module.exports = Protocol

package/src/protocols/substreams/manifest.graphql

@@ -0,0 +1,45 @@
+# 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!]!
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  source: SubstreamsSource!
+  mapping: SubstreamMapping!
+}
+
+type SubstreamsSource {
+  package: SubstreamsPackage!
+}
+
+type SubstreamsPackage {
+  moduleName: String!
+  file: String!
+}
+
+type SubstreamMapping {
+  apiVersion: String!
+  kind: String!
+}

package/src/protocols/substreams/scaffold/manifest.js

@@ -0,0 +1,13 @@
+const source = () => `
+      package:
+        moduleName: graph_out
+        file: substreams-eth-block-meta-v0.1.0.spkg`
+
+const mapping = () => `
+      apiVersion: 0.0.5
+      kind: substreams/graph-entities`
+
+module.exports = {
+  source,
+  mapping,
+}

package/src/protocols/substreams/subgraph.js

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

package/src/scaffold/index.js

@@ -99,10 +99,15 @@ dataSources:
     )
   }
 
+  generateMappings() {
+    return this.protocol.getMappingScaffold()
+      ? { [`${strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() }
+      : undefined
+  }
+
   generateMapping() {
     const hasEvents = this.protocol.hasEvents()
     const events = hasEvents ? abiEvents(this.abi).toJS() : []
-
     const protocolMapping = this.protocol.getMappingScaffold()
 
     return prettier.format(
@@ -141,7 +146,7 @@ dataSources:
       'subgraph.yaml': this.generateManifest(),
       'schema.graphql': this.generateSchema(),
       'tsconfig.json': this.generateTsConfig(),
-      src: { [`${strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() },
+      src: this.generateMappings(),
       abis: this.generateABIs(),
       tests: this.generateTests(),
     }

package/src/subgraph.js

@@ -6,6 +6,8 @@ let { strOptions } = require('yaml/types')
 let graphql = require('graphql/language')
 let validation = require('./validation')
 
+let subgraphDebug = require('./debug')('graph-cli:subgraph')
+
 const throwCombinedError = (filename, errors) => {
   throw new Error(
     errors.reduce(
@@ -39,6 +41,7 @@ const buildCombinedWarning = (filename, warnings) =>
 
 module.exports = class Subgraph {
   static async validate(data, protocol, { resolveFile }) {
+    subgraphDebug(`Validating Subgraph with protocol "%s"`, protocol)
     if (protocol.name == null) {
       return immutable.fromJS([
         {
@@ -134,11 +137,19 @@ Please update it to tell users more about your subgraph.`,
       .filter(dataSource => protocol.isValidKindName(dataSource.get('kind')))
       .reduce((errors, dataSource, dataSourceIndex) => {
         let path = ['dataSources', dataSourceIndex, 'mapping']
-
         let mapping = dataSource.get('mapping')
-
         const handlerTypes = protocolSubgraph.handlerTypes()
 
+        subgraphDebug(
+          'Validating dataSource "%s" handlers with %d handlers types defined for protocol',
+          dataSource.get('name'),
+          handlerTypes.size,
+        )
+
+        if (handlerTypes.size == 0) {
+          return errors
+        }
+
         const areAllHandlersEmpty = handlerTypes
           .map(handlerType => mapping.get(handlerType, immutable.List()))
           .every(handlers => handlers.isEmpty())
@@ -159,7 +170,7 @@ At least one such handler must be defined.`,
   }
 
   static validateContractValues(manifest, protocol) {
-    if (!protocol.hasContract()){
+    if (!protocol.hasContract()) {
       return immutable.List()
     }
 

package/tests/cli/validation/call-handler-with-tuple/generated/schema.ts

@@ -0,0 +1,44 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import {
+  TypedMap,
+  Entity,
+  Value,
+  ValueKind,
+  store,
+  Bytes,
+  BigInt,
+  BigDecimal
+} from "@graphprotocol/graph-ts";
+
+export class MyEntity extends Entity {
+  constructor(id: string) {
+    super();
+    this.set("id", Value.fromString(id));
+  }
+
+  save(): void {
+    let id = this.get("id");
+    assert(id != null, "Cannot save MyEntity entity without an ID");
+    if (id) {
+      assert(
+        id.kind == ValueKind.STRING,
+        `Entities of type MyEntity must have an ID of type String but the id '${id.displayData()}' is of type ${id.displayKind()}`
+      );
+      store.set("MyEntity", id.toString(), this);
+    }
+  }
+
+  static load(id: string): MyEntity | null {
+    return changetype<MyEntity | null>(store.get("MyEntity", id));
+  }
+
+  get id(): string {
+    let value = this.get("id");
+    return value!.toString();
+  }
+
+  set id(value: string) {
+    this.set("id", Value.fromString(value));
+  }
+}

package/tests/cli/validation/example-values-found/generated/ExampleSubgraph/ExampleContract.ts

@@ -0,0 +1,35 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import {
+  ethereum,
+  JSONValue,
+  TypedMap,
+  Entity,
+  Bytes,
+  Address,
+  BigInt
+} from "@graphprotocol/graph-ts";
+
+export class ExampleEvent extends ethereum.Event {
+  get params(): ExampleEvent__Params {
+    return new ExampleEvent__Params(this);
+  }
+}
+
+export class ExampleEvent__Params {
+  _event: ExampleEvent;
+
+  constructor(event: ExampleEvent) {
+    this._event = event;
+  }
+
+  get param0(): string {
+    return this._event.parameters[0].value.toString();
+  }
+}
+
+export class ExampleContract extends ethereum.SmartContract {
+  static bind(address: Address): ExampleContract {
+    return new ExampleContract("ExampleContract", address);
+  }
+}

package/tests/cli/validation/example-values-found/generated/schema.ts

@@ -0,0 +1,44 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import {
+  TypedMap,
+  Entity,
+  Value,
+  ValueKind,
+  store,
+  Bytes,
+  BigInt,
+  BigDecimal
+} from "@graphprotocol/graph-ts";
+
+export class MyEntity extends Entity {
+  constructor(id: string) {
+    super();
+    this.set("id", Value.fromString(id));
+  }
+
+  save(): void {
+    let id = this.get("id");
+    assert(id != null, "Cannot save MyEntity entity without an ID");
+    if (id) {
+      assert(
+        id.kind == ValueKind.STRING,
+        `Entities of type MyEntity must have an ID of type String but the id '${id.displayData()}' is of type ${id.displayKind()}`
+      );
+      store.set("MyEntity", id.toString(), this);
+    }
+  }
+
+  static load(id: string): MyEntity | null {
+    return changetype<MyEntity | null>(store.get("MyEntity", id));
+  }
+
+  get id(): string {
+    let value = this.get("id");
+    return value!.toString();
+  }
+
+  set id(value: string) {
+    this.set("id", Value.fromString(value));
+  }
+}

package/tests/cli/validation/source-without-address-is-valid/generated/ExampleSubgraph/ExampleContract.ts

@@ -0,0 +1,35 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import {
+  ethereum,
+  JSONValue,
+  TypedMap,
+  Entity,
+  Bytes,
+  Address,
+  BigInt
+} from "@graphprotocol/graph-ts";
+
+export class ExampleEvent extends ethereum.Event {
+  get params(): ExampleEvent__Params {
+    return new ExampleEvent__Params(this);
+  }
+}
+
+export class ExampleEvent__Params {
+  _event: ExampleEvent;
+
+  constructor(event: ExampleEvent) {
+    this._event = event;
+  }
+
+  get param0(): string {
+    return this._event.parameters[0].value.toString();
+  }
+}
+
+export class ExampleContract extends ethereum.SmartContract {
+  static bind(address: Address): ExampleContract {
+    return new ExampleContract("ExampleContract", address);
+  }
+}

package/.eslintrc

@@ -1,10 +0,0 @@
-{
-  "parserOptions": {
-    "ecmaVersion": 2017,
-    "ecmaFeatures": {
-    }
-  },
-  "env": {
-    "node": true
-  }
-}

package/.prettierrc.json

@@ -1,6 +0,0 @@
-{
-  "semi": false,
-  "trailingComma": "all",
-  "printWidth": 90,
-  "singleQuote": true
-}