@graphprotocol/graph-cli 0.27.0 → 0.29.0

package/src/command-helpers/network.js

@@ -0,0 +1,113 @@
+const path = require('path')
+const yaml = require('yaml')
+const { step, withSpinner } = require('../command-helpers/spinner')
+
+const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, identifierName) =>
+  await withSpinner(
+    `Update sources network`,
+    `Failed to update sources network`,
+    `Warnings while updating sources network`,
+    async spinner => {
+      let allNetworks
+
+      step(spinner, `Reading networks config`)
+      allNetworks = await toolbox.filesystem.read(networksFile, "json")
+      let networkConfig = allNetworks[network]
+
+      // Exit if the network passed with --network does not exits in networks.json
+      if(!networkConfig) {
+        throw new Error(`Network '${network}' was not found in '${networksFile}'`)
+      }
+
+      await toolbox.patching.update(manifest, content => {
+        let subgraph = yaml.parse(content)
+        let networkSources = Object.keys(networkConfig)
+        let subgraphSources = subgraph.dataSources.map(value => value.name);
+
+        // Update the dataSources network config
+        subgraph.dataSources = subgraph.dataSources.map(source => {
+            if (!networkSources.includes(source.name)) {
+              throw new Error(`'${source.name}' was not found in the '${network}' configuration, please update!`)
+            }
+
+            if (hasChanges(identifierName, network, networkConfig[source.name], source)) {
+              step(spinner, `Update '${source.name}' network configuration`)
+              source.network = network
+              source.source = source.source.abi ? { abi: source.source.abi } : {}
+              Object.assign(source.source, networkConfig[source.name])
+            } else {
+              step(spinner, `Skip '${source.name}': No changes to network configuration`)
+            }
+
+            return source
+          }
+        )
+
+        // All data sources shoud be on the same network,
+        // so we have to update the network of all templates too.
+        if(subgraph.templates) {
+          subgraph.templates = subgraph.templates.map(template => ({
+            ...template,
+            network,
+          }))
+        }
+
+        let unsusedSources = networkSources.filter(x => !subgraphSources.includes(x))
+
+        unsusedSources.forEach(source => {
+          step(spinner, `dataSource '${source}' from '${networksFile}' not found in ${manifest}`)
+        })
+
+        let yaml_doc = new yaml.Document()
+        yaml_doc.contents = subgraph
+        return yaml_doc.toString()
+      })
+  })
+
+const initNetworksConfig = async(toolbox, directory, identifierName) =>
+  await withSpinner(
+    `Initialize networks config`,
+    `Failed to initialize networks config`,
+    `Warnings while initializing networks config`,
+    async spinner => {
+      let subgraphStr = await toolbox.filesystem.read(path.join(directory, 'subgraph.yaml'))
+      let subgraph = yaml.parse(subgraphStr)
+
+      const networks = subgraph.dataSources.reduce((acc, source) =>
+        Object.assign(
+          acc,
+          {
+            [source.network]: {
+              [source.name]: {
+                [identifierName]: source.source.address,
+                startBlock: source.source.startBlock,
+              },
+            },
+          }
+        )
+      , {})
+
+      await toolbox.filesystem.write(`${directory}/networks.json`, networks)
+
+      return true
+    },
+  )
+
+// Checks if any network attribute has been changed
+function hasChanges(identifierName, network, networkConfig, dataSource) {
+  let networkChanged = dataSource.network !== network
+
+  // Return directly if the network is different
+  if (networkChanged) return networkChanged
+
+  let addressChanged = networkConfig[identifierName] !== dataSource.source[identifierName]
+
+  let startBlockChanged = networkConfig.startBlock !== dataSource.source.startBlock
+
+  return networkChanged || addressChanged || startBlockChanged
+}
+
+module.exports = {
+  updateSubgraphNetwork,
+  initNetworksConfig
+}

package/src/command-helpers/network.test.js

@@ -0,0 +1,78 @@
+const { initNetworksConfig, updateSubgraphNetwork } = require('../command-helpers/network')
+const toolbox = require('gluegun/toolbox')
+const yaml = require('yaml')
+
+describe('initNetworksConfig', () => {
+  beforeAll(async () => {
+    await initNetworksConfig(toolbox, './examples/example-subgraph', 'address')
+  })
+  afterAll(async () => {
+    await toolbox.filesystem.remove('./examples/example-subgraph/networks.json')
+  })
+
+  test('generates networks.json from subgraph.yaml', () => {
+    expect(toolbox.filesystem.exists('./examples/example-subgraph/networks.json')).toBe('file')
+  })
+
+  test('Populates the networks.json file with the data from subgraph.yaml', async () => {
+    let networksStr = await toolbox.filesystem.read('./examples/example-subgraph/networks.json')
+    let networks = JSON.parse(networksStr)
+
+    let expected = {
+      mainnet: {
+        ExampleSubgraph: { address: '0x22843e74c59580b3eaf6c233fa67d8b7c561a835' }
+      }
+    }
+
+    expect(networks).toStrictEqual(expected)
+  })
+})
+
+describe('updateSubgraphNetwork', () => {
+  beforeAll(async () => {
+    let content = {
+      optimism: {
+        ExampleSubgraph: { address: '0x12345...' }
+      }
+    }
+
+    await toolbox.filesystem.write('./examples/example-subgraph/networks.json', content)
+    await toolbox.filesystem.copy('./examples/example-subgraph/subgraph.yaml', './examples/example-subgraph/subgraph_copy.yaml')
+  })
+
+  afterAll(async () => {
+    await toolbox.filesystem.remove('./examples/example-subgraph/networks.json')
+    await toolbox.filesystem.remove('./examples/example-subgraph/subgraph_copy.yaml')
+  })
+
+  test('Updates subgraph.yaml', async () => {
+    let manifest = './examples/example-subgraph/subgraph_copy.yaml'
+    let networksFie = './examples/example-subgraph/networks.json'
+    let subgraph = await toolbox.filesystem.read(manifest)
+    let subgraphObj = yaml.parse(subgraph)
+
+    let network = subgraphObj.dataSources[0].network
+    let address = subgraphObj.dataSources[0].source.address
+
+    expect(network).toBe('mainnet')
+    expect(address).toBe('0x22843e74c59580b3eaf6c233fa67d8b7c561a835')
+
+    await updateSubgraphNetwork(
+      toolbox,
+      manifest,
+      'optimism',
+      networksFie,
+      'address'
+    )
+
+    subgraph = await toolbox.filesystem.read(manifest)
+    subgraphObj = yaml.parse(subgraph)
+
+    network = subgraphObj.dataSources[0].network
+    address = subgraphObj.dataSources[0].source.address
+
+    expect(network).toBe('optimism')
+    expect(address).toBe('0x12345...')
+  })
+
+})

package/src/commands/build.js

@@ -2,6 +2,7 @@ const chalk = require('chalk')
 
 const { createCompiler } = require('../command-helpers/compiler')
 const { fixParameters } = require('../command-helpers/gluegun')
+const { updateSubgraphNetwork } = require('../command-helpers/network')
 const DataSourcesExtractor = require('../command-helpers/data-sources')
 const Protocol = require('../protocols')
 
@@ -16,13 +17,15 @@ Options:
   -t, --output-format <format>  Output format for mappings (wasm, wast) (default: wasm)
       --skip-migrations         Skip subgraph migrations (default: false)
   -w, --watch                   Regenerate types when subgraph files change (default: false)
+      --network <name>          Network to use from networks.json
+      --network-file <path>    Networks file (default: "./networks.json")
 `
 
 module.exports = {
   description: 'Builds a subgraph and (optionally) uploads it to IPFS',
   run: async toolbox => {
     // Obtain tools
-    let { filesystem, print, system } = toolbox
+    let { filesystem, patching, print, system } = toolbox
 
     // Parse CLI parameters
     let {
@@ -37,6 +40,8 @@ module.exports = {
       t,
       w,
       watch,
+      network,
+      networkFile
     } = toolbox.parameters.options
 
     // Support both short and long option variants
@@ -68,6 +73,10 @@ module.exports = {
       manifest !== undefined && manifest !== ''
         ? manifest
         : filesystem.resolve('subgraph.yaml')
+    networkFile =
+      networkFile !== undefined && networkFile !== ''
+        ? networkFile
+        : filesystem.resolve("networks.json")
 
     // Show help text if requested
     if (help) {
@@ -86,6 +95,17 @@ module.exports = {
       return
     }
 
+    if (network && filesystem.exists(networkFile) !== "file") {
+      print.error(`Network file '${networkFile}' does not exists or is not a file!`)
+      process.exitCode = 1
+      return
+    }
+
+    if (network) {
+      let identifierName = protocol.getContract().identifierName()
+      await updateSubgraphNetwork(toolbox, manifest, network, networkFile, identifierName)
+    }
+
     let compiler = createCompiler(manifest, {
       ipfs,
       outputDir,

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

@@ -4,6 +4,7 @@ const immutable = require('immutable')
 const os = require('os')
 const path = require('path')
 const toolbox = require('gluegun/toolbox')
+const yaml = require('yaml')
 
 const {
   getSubgraphBasename,
@@ -11,6 +12,7 @@ const {
 } = require('../command-helpers/subgraph')
 const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
+const { initNetworksConfig } = require('../command-helpers/network')
 const { withSpinner, step } = require('../command-helpers/spinner')
 const { fixParameters } = require('../command-helpers/gluegun')
 const { chooseNodeUrl } = require('../command-helpers/node')
@@ -132,7 +134,7 @@ const processInitForm = async (
           return `${e.message}
 
   Examples:
-  
+
     $ graph init ${os.userInfo().username}/${name}
     $ graph init ${name} --allow-simple-name`
         }
@@ -285,9 +287,10 @@ 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`;
   }
-} 
+}
 
 const loadAbiFromEtherscan = async (ABI, network, address) =>
   await withSpinner(
@@ -355,7 +358,7 @@ module.exports = {
 
     node = node || g
     ;({ node, allowSimpleName } = chooseNodeUrl({ product, studio, node, allowSimpleName }))
-    
+
     if (fromContract && fromExample) {
       print.error(`Only one of --from-example and --from-contract can be used at a time.`)
       process.exitCode = 1
@@ -685,6 +688,12 @@ const initSubgraphFromExample = async (
     return
   }
 
+  let networkConf = await initNetworksConfig(toolbox, directory, "address")
+  if (networkConf !== true) {
+    process.exitCode = 1
+    return
+  }
+
   // Update package.json to match the subgraph name
   let prepared = await withSpinner(
     `Update subgraph name and commands in package.json`,
@@ -826,6 +835,13 @@ const initSubgraphFromContract = async (
     return
   }
 
+  let identifierName = protocolInstance.getContract().identifierName()
+  let networkConf = await initNetworksConfig(toolbox, directory, identifierName)
+  if (networkConf !== true) {
+    process.exitCode = 1
+    return
+  }
+
   // Initialize a fresh Git repository
   let repo = await initRepository(toolbox, directory)
   if (repo !== true) {

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()