@graphprotocol/graph-cli 0.37.2 → 0.37.3-alpha-20230110163550-d64bef6

package/src/protocols/ethereum/subgraph.js

@@ -1,8 +1,8 @@
-const immutable = require('immutable')
-const ABI = require('./abi')
-const DataSourcesExtractor = require('../../command-helpers/data-sources')
+import immutable from 'immutable'
+import ABI from './abi'
+import * as DataSourcesExtractor from '../../command-helpers/data-sources'
 
-module.exports = class EthereumSubgraph {
+export default class EthereumSubgraph {
   constructor(options = {}) {
     this.manifest = options.manifest
     this.resolveFile = options.resolveFile
@@ -16,7 +16,10 @@ module.exports = class EthereumSubgraph {
   }
 
   validateAbis() {
-    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol)
+    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(
+      this.manifest,
+      this.protocol,
+    )
 
     return dataSourcesAndTemplates.reduce(
       (errors, dataSourceOrTemplate) =>
@@ -71,17 +74,19 @@ ${abiNames
   }
 
   validateEvents() {
-    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(this.manifest, this.protocol)
+    const dataSourcesAndTemplates = DataSourcesExtractor.fromManifest(
+      this.manifest,
+      this.protocol,
+    )
 
-    return dataSourcesAndTemplates
-      .reduce((errors, dataSourceOrTemplate) => {
-        return errors.concat(
-          this.validateDataSourceEvents(
-            dataSourceOrTemplate.get('dataSource'),
-            dataSourceOrTemplate.get('path'),
-          ),
-        )
-      }, immutable.List())
+    return dataSourcesAndTemplates.reduce((errors, dataSourceOrTemplate) => {
+      return errors.concat(
+        this.validateDataSourceEvents(
+          dataSourceOrTemplate.get('dataSource'),
+          dataSourceOrTemplate.get('path'),
+        ),
+      )
+    }, immutable.List())
   }
 
   validateDataSourceEvents(dataSource, path) {
@@ -182,10 +187,6 @@ ${abiFunctions
   }
 
   handlerTypes() {
-    return immutable.List([
-      'blockHandlers',
-      'callHandlers',
-      'eventHandlers',
-    ])
+    return immutable.List(['blockHandlers', 'callHandlers', 'eventHandlers'])
   }
 }

package/src/protocols/ethereum/type-generator.js

@@ -1,13 +1,13 @@
-const fs = require('fs-extra')
-const path = require('path')
-const immutable = require('immutable')
-const prettier = require('prettier')
-const ABI = require('./abi')
-const { step, withSpinner } = require('../../command-helpers/spinner')
-const { GENERATED_FILE_NOTE } = require('../../codegen/typescript')
-const { displayPath } = require('../../command-helpers/fs')
+import fs from 'fs-extra'
+import path from 'path'
+import immutable from 'immutable'
+import prettier from 'prettier'
+import ABI from './abi'
+import { step, withSpinner } from '../../command-helpers/spinner'
+import { GENERATED_FILE_NOTE } from '../../codegen/typescript'
+import { displayPath } from '../../command-helpers/fs'
 
-module.exports = class EthereumTypeGenerator {
+export default class EthereumTypeGenerator {
   constructor(options = {}) {
     this.sourceDir = options.sourceDir
     this.outputDir = options.outputDir
@@ -24,20 +24,20 @@ module.exports = class EthereumTypeGenerator {
             .get('dataSources')
             .reduce(
               (abis, dataSource) =>
-              dataSource
-              .getIn(['mapping', 'abis'])
-              .reduce(
-                (abis, abi) =>
-                abis.push(
-                  this._loadABI(
-                    dataSource,
-                    abi.get('name'),
-                    abi.get('file'),
-                    spinner,
+                dataSource
+                  .getIn(['mapping', 'abis'])
+                  .reduce(
+                    (abis, abi) =>
+                      abis.push(
+                        this._loadABI(
+                          dataSource,
+                          abi.get('name'),
+                          abi.get('file'),
+                          spinner,
+                        ),
+                      ),
+                    abis,
                   ),
-                ),
-                abis,
-              ),
               immutable.List(),
             )
         } catch (e) {
@@ -89,11 +89,7 @@ module.exports = class EthereumTypeGenerator {
     try {
       if (this.sourceDir) {
         let absolutePath = path.resolve(this.sourceDir, maybeRelativePath)
-        step(
-          spinner,
-          `Load data source template ABI from`,
-          displayPath(absolutePath),
-        )
+        step(spinner, `Load data source template ABI from`, displayPath(absolutePath))
         return { template, abi: ABI.load(name, absolutePath) }
       } else {
         return { template, abi: ABI.load(name, maybeRelativePath) }
@@ -170,9 +166,7 @@ module.exports = class EthereumTypeGenerator {
       step(
         spinner,
         `Generate types for data source template ABI:`,
-        `${abi.template.get('name')} > ${abi.abi.name} (${displayPath(
-          abi.abi.file,
-        )})`,
+        `${abi.template.get('name')} > ${abi.abi.name} (${displayPath(abi.abi.file)})`,
       )
 
       let codeGenerator = abi.abi.codeGenerator()

package/src/protocols/{index.js → index.ts}

@@ -1,35 +1,42 @@
-const immutable = require('immutable')
-const ArweaveSubgraph = require('./arweave/subgraph')
-const EthereumTypeGenerator = require('./ethereum/type-generator')
-const EthereumTemplateCodeGen = require('./ethereum/codegen/template')
-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')
-
-let protocolDebug = require('../debug')('graph-cli:protocol')
-
-class Protocol {
-  static fromDataSources(dataSourcesAndTemplates) {
+import immutable from 'immutable'
+import ArweaveSubgraph from './arweave/subgraph'
+import EthereumTypeGenerator from './ethereum/type-generator'
+import EthereumTemplateCodeGen from './ethereum/codegen/template'
+import EthereumABI from './ethereum/abi'
+import EthereumSubgraph from './ethereum/subgraph'
+import NearSubgraph from './near/subgraph'
+import CosmosSubgraph from './cosmos/subgraph'
+import SubstreamsSubgraph from './substreams/subgraph'
+import EthereumContract from './ethereum/contract'
+import NearContract from './near/contract'
+import * as ArweaveManifestScaffold from './arweave/scaffold/manifest'
+import * as EthereumManifestScaffold from './ethereum/scaffold/manifest'
+import * as NearManifestScaffold from './near/scaffold/manifest'
+import * as CosmosManifestScaffold from './cosmos/scaffold/manifest'
+import * as SubstreamsManifestScaffold from './substreams/scaffold/manifest'
+import * as ArweaveMappingScaffold from './arweave/scaffold/mapping'
+import * as EthereumMappingScaffold from './ethereum/scaffold/mapping'
+import * as NearMappingScaffold from './near/scaffold/mapping'
+import * as CosmosMappingScaffold from './cosmos/scaffold/mapping'
+import debug from '../debug'
+import Subgraph from '../subgraph'
+import { SubgraphOptions } from './subgraph'
+
+let protocolDebug = debug('graph-cli:protocol')
+
+export default class Protocol {
+  static fromDataSources(dataSourcesAndTemplates: any) {
     const firstDataSourceKind = dataSourcesAndTemplates[0].kind
     return new Protocol(firstDataSourceKind)
   }
 
-  constructor(name) {
-    this.name = Protocol.normalizeName(name)
+  name: ProtocolName
+
+  // TODO: should assert non null? see the constructor switch default case comment
+  config!: ProtocolConfig
+
+  constructor(name: ProtocolName) {
+    this.name = Protocol.normalizeName(name)!
 
     switch (this.name) {
       case 'arweave':
@@ -62,7 +69,7 @@ class Protocol {
       near: ['near'],
       cosmos: ['cosmos'],
       substreams: ['substreams'],
-    })
+    }) as immutable.Collection<ProtocolName, string[]>
   }
 
   static availableNetworks() {
@@ -106,31 +113,31 @@ class Protocol {
         'juno-1',
         'uni-3', // Juno testnet
       ],
-    })
+    }) as immutable.Map<string, string[]>
 
-    let allNetworks = []
+    let allNetworks: string[] = []
     networks.forEach(value => {
       allNetworks.push(...value)
     })
 
-    networks = networks.set('substreams', immutable.fromJS(allNetworks))
+    networks = networks.set('substreams', allNetworks)
 
     return networks
   }
 
-  static normalizeName(name) {
+  static normalizeName(name: ProtocolName) {
     return Protocol.availableProtocols().findKey(possibleNames => {
       return possibleNames.includes(name)
-    })
+    })!
   }
 
   displayName() {
-    return this.config.displayName
+    return this.config?.displayName
   }
 
   // Receives a data source kind, and checks if it's valid
   // for the given protocol instance (this).
-  isValidKindName(kind) {
+  isValidKindName(kind: string) {
     return Protocol.availableProtocols()
       .get(this.name, immutable.List())
       .includes(kind)
@@ -156,10 +163,10 @@ class Protocol {
   }
 
   hasDataSourceMappingFile() {
-    return this.config.getMappingScaffold != null
+    return this.getMappingScaffold() != null
   }
 
-  getTypeGenerator(options) {
+  getTypeGenerator(options: any) {
     if (this.config == null || this.config.getTypeGenerator == null) {
       return null
     }
@@ -167,14 +174,14 @@ class Protocol {
     return this.config.getTypeGenerator(options)
   }
 
-  getTemplateCodeGen(template) {
+  getTemplateCodeGen(template: any) {
     if (!this.hasTemplates()) {
       throw new Error(
         `Template data sources with kind '${this.name}' are not supported yet`,
       )
     }
 
-    return this.config.getTemplateCodeGen(template)
+    return this.config.getTemplateCodeGen?.(template)
   }
 
   getABI() {
@@ -198,7 +205,20 @@ class Protocol {
   }
 }
 
-const arweaveProtocol = {
+type ProtocolName = 'arweave' | 'ethereum' | 'near' | 'cosmos' | 'substreams'
+
+interface ProtocolConfig {
+  displayName: string
+  abi?: any
+  contract?: any
+  getTemplateCodeGen?: (template: any) => any
+  getTypeGenerator?: (options: any) => any
+  getSubgraph(options: SubgraphOptions): Subgraph
+  manifestScaffold: any
+  mappingScaffold: any
+}
+
+const arweaveProtocol: ProtocolConfig = {
   displayName: 'Arweave',
   abi: undefined,
   contract: undefined,
@@ -211,7 +231,7 @@ const arweaveProtocol = {
   mappingScaffold: ArweaveMappingScaffold,
 }
 
-const cosmosProtocol = {
+const cosmosProtocol: ProtocolConfig = {
   displayName: 'Cosmos',
   abi: undefined,
   contract: undefined,
@@ -224,7 +244,7 @@ const cosmosProtocol = {
   mappingScaffold: CosmosMappingScaffold,
 }
 
-const ethereumProtocol = {
+const ethereumProtocol: ProtocolConfig = {
   displayName: 'Ethereum',
   abi: EthereumABI,
   contract: EthereumContract,
@@ -241,7 +261,7 @@ const ethereumProtocol = {
   mappingScaffold: EthereumMappingScaffold,
 }
 
-const nearProtocol = {
+const nearProtocol: ProtocolConfig = {
   displayName: 'NEAR',
   abi: undefined,
   contract: NearContract,
@@ -254,7 +274,7 @@ const nearProtocol = {
   mappingScaffold: NearMappingScaffold,
 }
 
-const substreamsProtocol = {
+const substreamsProtocol: ProtocolConfig = {
   displayName: 'Substreams',
   abi: undefined,
   contract: undefined,
@@ -268,4 +288,3 @@ const substreamsProtocol = {
 }
 
 protocolDebug('Available networks %M', Protocol.availableNetworks())
-module.exports = Protocol

package/src/protocols/ipfs/codegen/file_template.js

@@ -1,6 +1,6 @@
-const tsCodegen = require('../../../codegen/typescript')
+import * as tsCodegen from '../../../codegen/typescript'
 
-module.exports = class IpfsFileTemplateCodeGen {
+export default class IpfsFileTemplateCodeGen {
   constructor(template) {
     this.template = template
   }

package/src/protocols/near/{contract.js → contract.ts}

@@ -1,37 +1,41 @@
-const MINIMUM_ACCOUNT_ID_LENGTH = 2
-const MAXIMUM_ACCOUNT_ID_LENGTH = 64
+const MINIMUM_ACCOUNT_ID_LENGTH = 2 as const
+const MAXIMUM_ACCOUNT_ID_LENGTH = 64 as const
 
-const RULES_URL = 'https://docs.near.org/docs/concepts/account#account-id-rules'
+const RULES_URL = 'https://docs.near.org/docs/concepts/account#account-id-rules' as const
+
+export default class NearContract {
+  private account: string
 
-module.exports = class NearContract {
   static identifierName() {
     return 'account'
   }
 
-  constructor(account) {
+  constructor(account: string) {
     this.account = account
   }
 
-  _validateLength() {
-    return this.account.length >= MINIMUM_ACCOUNT_ID_LENGTH &&
-      this.account.length <= MAXIMUM_ACCOUNT_ID_LENGTH
+  private validateLength(value: string) {
+    return (
+      value.length >= MINIMUM_ACCOUNT_ID_LENGTH &&
+      value.length <= MAXIMUM_ACCOUNT_ID_LENGTH
+    )
   }
 
-  _validateFormat() {
+  private validateFormat(value: string) {
     const pattern = /^(([a-z\d]+[\-_])*[a-z\d]+\.)*([a-z\d]+[\-_])*[a-z\d]+$/
 
-    return pattern.test(this.account)
+    return pattern.test(value)
   }
 
   validate() {
-    if (!this._validateLength(this.account)) {
+    if (!this.validateLength(this.account)) {
       return {
         valid: false,
         error: `Account must be between '${MINIMUM_ACCOUNT_ID_LENGTH}' and '${MAXIMUM_ACCOUNT_ID_LENGTH}' characters, see ${RULES_URL}`,
       }
     }
 
-    if (!this._validateFormat()) {
+    if (!this.validateFormat(this.account)) {
       return {
         valid: false,
         error: `Account must conform to the rules on ${RULES_URL}`,

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

@@ -1,4 +1,4 @@
-const { strings } = require('gluegun')
+import { strings } from 'gluegun'
 
 const source = ({ contract }) => `
       account: '${contract}'`
@@ -12,7 +12,4 @@ const mapping = ({ contractName }) => `
         - handler: handleReceipt
       file: ./src/${strings.kebabCase(contractName)}.ts`
 
-module.exports = {
-  source,
-  mapping,
-}
+export { source, mapping }

package/src/protocols/near/scaffold/mapping.js

@@ -34,6 +34,4 @@ const generatePlaceholderHandlers = () =>
   }
 `
 
-module.exports = {
-  generatePlaceholderHandlers,
-}
+export { generatePlaceholderHandlers }

package/src/protocols/near/subgraph.js

@@ -1,6 +1,6 @@
-const immutable = require('immutable')
+import immutable from 'immutable'
 
-module.exports = class NearSubgraph {
+export default class NearSubgraph {
   constructor(options = {}) {
     this.manifest = options.manifest
     this.resolveFile = options.resolveFile
@@ -12,9 +12,6 @@ module.exports = class NearSubgraph {
   }
 
   handlerTypes() {
-    return immutable.List([
-      'blockHandlers',
-      'receiptHandlers',
-    ])
+    return immutable.List(['blockHandlers', 'receiptHandlers'])
   }
 }

package/src/protocols/subgraph.ts

@@ -0,0 +1,12 @@
+import immutable from 'immutable'
+
+export interface SubgraphOptions {
+  manifest?: any
+  resolveFile?: (path: string) => string
+  protocol?: any
+}
+
+export interface Subgraph extends SubgraphOptions {
+  validateManifest(): immutable.List<any>
+  handlerTypes(): immutable.List<any>
+}

package/src/protocols/substreams/scaffold/{manifest.js → manifest.ts}

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

package/src/protocols/substreams/subgraph.ts

@@ -0,0 +1,22 @@
+import immutable from 'immutable'
+import { Subgraph, SubgraphOptions } from '../subgraph'
+
+export default class SubstreamsSubgraph implements Subgraph {
+  manifest: SubgraphOptions['manifest']
+  resolveFile: SubgraphOptions['resolveFile']
+  protocol: SubgraphOptions['protocol']
+
+  constructor(options: SubgraphOptions = {}) {
+    this.manifest = options.manifest
+    this.resolveFile = options.resolveFile
+    this.protocol = options.protocol
+  }
+
+  validateManifest() {
+    return immutable.List()
+  }
+
+  handlerTypes() {
+    return immutable.List([])
+  }
+}

package/src/scaffold/cosmos.test.js

@@ -1,6 +1,6 @@
-const immutable = require('immutable')
-const Scaffold = require('./')
-const Protocol = require('../protocols')
+import immutable from 'immutable'
+import Scaffold from './'
+import Protocol from '../protocols'
 
 const protocol = new Protocol('cosmos')
 

package/src/scaffold/ethereum.test.js

@@ -1,7 +1,7 @@
-const ABI = require('../protocols/ethereum/abi')
-const immutable = require('immutable')
-const Scaffold = require('./')
-const Protocol = require('../protocols')
+import ABI from '../protocols/ethereum/abi'
+import immutable from 'immutable'
+import Scaffold from './'
+import Protocol from '../protocols'
 
 const TEST_EVENT = {
   name: 'ExampleEvent',

package/src/scaffold/index.js

@@ -1,6 +1,6 @@
-const prettier = require('prettier')
+import prettier from 'prettier'
 const pkginfo = require('pkginfo')(module)
-const { strings } = require('gluegun')
+import { strings } from 'gluegun'
 
 const GRAPH_CLI_VERSION = process.env.GRAPH_CLI_TESTS
   ? // JSON.stringify should remove this key, we will install the local
@@ -9,12 +9,12 @@ const GRAPH_CLI_VERSION = process.env.GRAPH_CLI_TESTS
   : // For scaffolding real subgraphs
     `${module.exports.version}`
 
-const { abiEvents, generateEventType, generateExampleEntityType } = require('./schema')
-const { generateEventIndexingHandlers } = require('./mapping')
-const { generateTestsFiles } = require('./tests')
-const { getSubgraphBasename } = require('../command-helpers/subgraph')
+import { abiEvents, generateEventType, generateExampleEntityType } from './schema'
+import { generateEventIndexingHandlers } from './mapping'
+import { generateTestsFiles } from './tests'
+import { getSubgraphBasename } from '../command-helpers/subgraph'
 
-module.exports = class Scaffold {
+export default class Scaffold {
   constructor(options = {}) {
     this.protocol = options.protocol
     this.abi = options.abi

package/src/scaffold/mapping.js

@@ -1,6 +1,6 @@
-const path = require('path')
+import path from 'path'
 
-const util = require('../codegen/util')
+import * as util from '../codegen/util'
 
 const generateFieldAssignment = path =>
   `entity.${path.join('_')} = event.params.${path.join('.')}`
@@ -46,7 +46,7 @@ const generateEventIndexingHandlers = (events, contractName) =>
     .join('\n')}
 `
 
-module.exports = {
+export {
   generateFieldAssignment,
   generateFieldAssignments,
   generateEventFieldAssignments,

package/src/scaffold/near.test.js

@@ -1,6 +1,6 @@
-const immutable = require('immutable')
-const Scaffold = require('./')
-const Protocol = require('../protocols')
+import immutable from 'immutable'
+import Scaffold from './'
+import Protocol from '../protocols'
 
 const protocol = new Protocol('near')
 

package/src/scaffold/schema.js

@@ -1,5 +1,5 @@
-const { ascTypeForProtocol, valueTypeForAsc } = require('../codegen/types')
-const util = require('../codegen/util')
+import { ascTypeForProtocol, valueTypeForAsc } from '../codegen/types'
+import * as util from '../codegen/util'
 
 const abiEvents = abi =>
   util.disambiguateNames({
@@ -41,7 +41,7 @@ const generateEventType = (event, protocolName) => `type ${
             acc.concat(generateEventFields({ input, index, protocolName })),
           [],
         )
-        .join('\n')}  
+        .join('\n')}
       blockNumber: BigInt!
       blockTimestamp: BigInt!
       transactionHash: Bytes!
@@ -70,7 +70,7 @@ const generateExampleEntityType = (protocol, events) => {
   }
 }
 
-module.exports = {
+export {
   abiEvents,
   protocolTypeToGraphQL,
   generateField,