@graphprotocol/graph-cli 0.45.0-alpha-20230404134925-bfd3b8e → 0.45.0-alpha-20230404223012-053932b

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.45.0-alpha-20230404134925-bfd3b8e
+## 0.45.0-alpha-20230404223012-053932b
 
 ### Minor Changes
 
@@ -9,6 +9,11 @@
   Thanks [@saihaj](https://github.com/saihaj)! - When the contract has an `id` event, the CLI
   renames the `id` entity to `{contractName}_id` and map it to `{contractName}_id` in the mapping.
 
+- [#1258](https://github.com/graphprotocol/graph-tooling/pull/1258)
+  [`053932b`](https://github.com/graphprotocol/graph-tooling/commit/053932bfad78e583867d9ef9c2f89b7cff1005e2)
+  Thanks [@saihaj](https://github.com/saihaj)! - validate existence for handlers specified in
+  manifest during build
+
 - [#1209](https://github.com/graphprotocol/graph-tooling/pull/1209)
   [`f26398e`](https://github.com/graphprotocol/graph-tooling/commit/f26398e054c556f414a1b45e92b7e4007a9b5a79)
   Thanks [@kalloc](https://github.com/kalloc)! - Support `ts` typing in tests folder
@@ -110,6 +115,12 @@
   - Updated dependency [`glob@9.3.4` ↗︎](https://www.npmjs.com/package/glob/v/9.3.4) (from `7.1.6`,
     in `dependencies`)
 
+- [#1246](https://github.com/graphprotocol/graph-tooling/pull/1246)
+  [`8e1409f`](https://github.com/graphprotocol/graph-tooling/commit/8e1409fbd04fa9e34fbc7d49160d9888ef74aebb)
+  Thanks [@dimitrovmaksim](https://github.com/dimitrovmaksim)! - Fixes `graph add` overwriting the
+  event names in `subgraph.yaml` and the ABI file when existing contracts have events with the same
+  name.
+
 - [#1207](https://github.com/graphprotocol/graph-tooling/pull/1207)
   [`ad275b3`](https://github.com/graphprotocol/graph-tooling/commit/ad275b31e635dab03cfefda00617ef9f612b01c0)
   Thanks [@saihaj](https://github.com/saihaj)! - bring back short hand for version and help

package/dist/commands/add.js

@@ -69,9 +69,9 @@ class AddCommand extends core_1.Command {
             // If we can't get the start block, we'll just leave it out of the manifest
             // TODO: Ask the user for the start block
         }
+        await (0, scaffold_1.writeABI)(ethabi, contractName);
         const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(ethabi, entities, contractName, mergeEntities);
         ethabi.data = abiData;
-        await (0, scaffold_1.writeABI)(ethabi, contractName);
         await (0, scaffold_1.writeSchema)(ethabi, protocol, result.getIn(['schema', 'file']), collisionEntities, contractName);
         await (0, scaffold_1.writeMapping)(ethabi, protocol, contractName, collisionEntities);
         await (0, scaffold_1.writeTestsFiles)(ethabi, protocol, contractName);
@@ -168,7 +168,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
                     continue;
                 }
                 else {
-                    dataRow.set('name', `${contractName}${dataRow.get('name')}`);
+                    dataRow.set('collision', true);
                 }
             }
             else {

package/dist/compiler/index.js

@@ -205,6 +205,45 @@ class Compiler {
             return subgraph;
         });
     }
+    /**
+     * Validate that the compiled WASM has all the handlers that are defined in the subgraph manifest
+     *
+     * @returns a list of handlers that are missing from the compiled WASM
+     *
+     * This is a temporary solution to validate that the compiled WASM has all the event handlers.
+     * A better way would be if we can do this even before compiling
+     * but requires a larger refactor so we are running additional validations before compilation
+     */
+    _validateHandlersInWasm({ pathToWasm, dataSource, }) {
+        const getHandlerNames = (handlerName) => dataSource
+            .getIn(['mapping', handlerName])
+            // if there is no handler, it will be undefined
+            ?.toJS()
+            ?.map((e) => e.handler) || [];
+        // Load the compiled WASM file
+        const buffer = fs_extra_1.default.readFileSync(pathToWasm);
+        const wasmMod = new WebAssembly.Module(buffer);
+        // Apologies to TS gods for `any` usage
+        // Yet another reason to refactor out immutable.js
+        const handlerNamesFromDataSources = [
+            // TODO: this is hacky, better is figuring out how to utilize the `protocol.getSubgraph().handlerTypes()`
+            ...getHandlerNames('eventHandlers'),
+            ...getHandlerNames('callHandlers'),
+            ...getHandlerNames('blockHandlers'),
+            ...getHandlerNames('transactionHandlers'),
+            ...getHandlerNames('messageHandlers'),
+            ...getHandlerNames('receiptHandlers'),
+        ];
+        // We can check the WASM module for the exported functions
+        // https://developer.mozilla.org/en-US/docs/WebAssembly/JavaScript_interface/Module/exports
+        // Using a Set to avoid duplicates and makes it easier to check if a value is present
+        const handlerNamesFromWasm = new Set(WebAssembly.Module.exports(wasmMod)
+            .filter(e => e.kind === 'function')
+            .map(e => e.name));
+        // Figure out which handlers are missing
+        const missingHandlers = handlerNamesFromDataSources.filter((handler) => !handlerNamesFromWasm.has(handler));
+        return missingHandlers;
+    }
     _compileDataSourceMapping(protocol, dataSource, mappingPath, compiledFiles, spinner) {
         if (protocol.name == 'substreams') {
             return;
@@ -241,6 +280,13 @@ class Compiler {
                 libs,
                 outputFile,
             });
+            const missingHandlers = this._validateHandlersInWasm({
+                pathToWasm: outFile,
+                dataSource,
+            });
+            if (missingHandlers.length > 0) {
+                throw Error(`\n\tMissing handlers in WASM: ${missingHandlers.join(', ')}`);
+            }
             // Remember the output file to avoid compiling the same file again
             compiledFiles.set(inputCacheKey, outFile);
             return outFile;

package/dist/protocols/ethereum/scaffold/manifest.js

@@ -22,7 +22,9 @@ const mapping = ({ abi, contractName }) => `
       language: wasm/assemblyscript
       entities:
         ${(0, schema_1.abiEvents)(abi)
-    .map(event => `- ${event.get('_alias')}`)
+    .map(event => `- ${event.get('collision')
+    ? `${contractName}${event.get('_alias')}`
+    : event.get('_alias')}`)
     .join('\n        ')}
       abis:
         - name: ${contractName}

package/dist/scaffold/schema.js

@@ -63,13 +63,13 @@ const generateEventFields = ({ index, input, protocolName, }) => input.type == '
         }),
     ];
 exports.generateEventFields = generateEventFields;
-const generateEventType = (event, protocolName, subgraphName) => {
-    return `type ${event._alias} @entity(immutable: true) {
+const generateEventType = (event, protocolName, contractName) => {
+    return `type ${event.collision ? `${contractName}${event._alias}` : event._alias} @entity(immutable: true) {
         id: Bytes!
         ${event.inputs
         .reduce((acc, input, index) => {
         if (Object.values(mapping_1.INPUT_NAMES_BLACKLIST).includes(input.name)) {
-            input.name = (0, mapping_1.renameInput)(input.name, subgraphName ?? 'contract');
+            input.name = (0, mapping_1.renameInput)(input.name, contractName ?? 'contract');
         }
         return acc.concat((0, exports.generateEventFields)({ input, index, protocolName }));
     }, [])

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.45.0-alpha-20230404134925-bfd3b8e",
+  "version": "0.45.0-alpha-20230404223012-053932b",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.45.0-alpha-20230404134925-bfd3b8e",
+  "version": "0.45.0-alpha-20230404223012-053932b",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -12,7 +12,6 @@
   "main": "dist/index.js",
   "files": [
     "CHANGELOG.md",
-    "bin",
     "dist",
     "oclif.manifest.json",
     "README.md"
@@ -74,9 +73,9 @@
     ]
   },
   "scripts": {
-    "build": "tsc -b tsconfig.build.json && oclif manifest && oclif readme && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
-    "oclif:pack": "npm pack && pnpm oclif pack tarballs --no-xz",
+    "build": "tsc -b tsconfig.build.json && oclif manifest && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
     "test": "jest --verbose",
+    "test:add": "jest tests/cli/add.test.ts --verbose",
     "test:init": "jest tests/cli/init.test.ts --verbose",
     "test:validation": "jest tests/cli/validation.test.ts --verbose",
     "type-check": "tsc --noEmit"

package/bin/graph.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\graph" %*