@graphprotocol/graph-cli 0.38.0 → 0.38.1-alpha-20230207152800-4428ad7

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphprotocol/graph-cli
 
+## 0.38.1-alpha-20230207152800-4428ad7
+
+### Patch Changes
+
+- [#1055](https://github.com/graphprotocol/graph-tooling/pull/1055)
+  [`9932c57`](https://github.com/graphprotocol/graph-tooling/commit/9932c579a0a3f569fc61712ed2e3f2e1538f25ed)
+  Thanks [@enisdenjo](https://github.com/enisdenjo)! - dependencies updates:
+  - Added dependency [`@oclif/core@2.0.7` ↗︎](https://www.npmjs.com/package/@oclif/core/v/2.0.7) (to
+    `dependencies`)
+
 ## 0.38.0
 
 ### Minor Changes

package/dist/bin.js

@@ -1,6 +1,34 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-// run the CLI with the current process arguments
-const cli_1 = require("./cli");
-(0, cli_1.run)(process.argv);
+const oclif = __importStar(require("@oclif/core"));
+const flush_1 = __importDefault(require("@oclif/core/flush"));
+// @ts-expect-error Handle is a pure JS file
+const handle_1 = __importDefault(require("@oclif/core/handle"));
+oclif.run().then(flush_1.default).catch(handle_1.default);

package/dist/command-helpers/network.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateNetworksFile = exports.initNetworksConfig = exports.updateSubgraphNetwork = void 0;
 const path_1 = __importDefault(require("path"));
+const gluegun_1 = require("gluegun");
 const yaml_1 = __importDefault(require("yaml"));
 const spinner_1 = require("./spinner");
 const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, identifierName) => await (0, spinner_1.withSpinner)(`Update sources network`, `Failed to update sources network`, `Warnings while updating sources network`, async (spinner) => {
@@ -37,10 +38,12 @@ const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, i
         });
         // All data sources shoud be on the same network,
         // so we have to update the network of all templates too.
-        subgraph.templates && (subgraph.templates = subgraph.templates.map((template) => ({
-            ...template,
-            network,
-        })));
+        // eslint-disable-next-line -- prettier has problems with &&=
+        subgraph.templates &&
+            (subgraph.templates = subgraph.templates.map((template) => ({
+                ...template,
+                network,
+            })));
         const unsusedSources = networkSources.filter(x => !subgraphSources.includes(x));
         unsusedSources.forEach(source => {
             (0, spinner_1.step)(spinner, `dataSource '${source}' from '${networksFile}' not found in ${manifest}`);
@@ -76,8 +79,8 @@ function hasChanges(identifierName, network, networkConfig, dataSource) {
     const startBlockChanged = networkConfig.startBlock !== dataSource.source.startBlock;
     return networkChanged || addressChanged || startBlockChanged;
 }
-const updateNetworksFile = async (toolbox, network, dataSource, address, networksFile) => {
-    await toolbox.patching.update(networksFile, config => {
+async function updateNetworksFile(network, dataSource, address, networksFile) {
+    await gluegun_1.patching.update(networksFile, config => {
         if (Object.keys(config).includes(network)) {
             Object.assign(config[network], { [dataSource]: { address } });
         }
@@ -86,5 +89,5 @@ const updateNetworksFile = async (toolbox, network, dataSource, address, network
         }
         return config;
     });
-};
+}
 exports.updateNetworksFile = updateNetworksFile;

package/dist/command-helpers/spinner.js

@@ -23,8 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withSpinner = exports.step = void 0;
+exports.useSpinner = exports.withSpinner = exports.step = void 0;
 const toolbox = __importStar(require("gluegun"));
+const core_1 = require("@oclif/core");
 const step = (spinner, subject, text) => {
     if (text) {
         spinner.stopAndPersist({
@@ -47,6 +48,8 @@ exports.step = step;
 //   spinner stops with the warning message and returns the `result` value.
 // Otherwise the spinner prints the in-progress message with a check mark
 //   and simply returns the value returned by `f`.
+//
+// @deprecated
 const withSpinner = async (text, errorText, warningText, f) => {
     const spinner = toolbox.print.spin(text);
     try {
@@ -78,3 +81,36 @@ const withSpinner = async (text, errorText, warningText, f) => {
     }
 };
 exports.withSpinner = withSpinner;
+// Executes the function `f` while displaying a command-line spinner.
+async function useSpinner(text, errorText, warningText, f) {
+    const { action } = core_1.ux;
+    action.start(text);
+    try {
+        const result = await f(action);
+        if (result && typeof result === 'object') {
+            const hasError = 'error' in result;
+            const hasWarning = 'warning' in result;
+            const hasResult = 'result' in result;
+            if (hasError) {
+                action.stop(`✖ ${errorText}: ${result.error}`);
+                return (hasResult ? result.result : result);
+            }
+            if (hasWarning && hasResult) {
+                if (result.warning !== null) {
+                    action.stop(`⚠️ ${warningText}: ${result.warning}`);
+                }
+                action.stop('✔');
+                return result.result;
+            }
+            action.stop('✔');
+            return result;
+        }
+        action.stop('✔');
+        return result;
+    }
+    catch (e) {
+        action.stop(`✖ ${errorText}: ${e.message}`);
+        throw e;
+    }
+}
+exports.useSpinner = useSpinner;

package/dist/commands/add.js

@@ -26,61 +26,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
+const errors_1 = require("@oclif/core/lib/errors");
+const gluegun_1 = require("gluegun");
 const immutable_1 = __importDefault(require("immutable"));
 const abi_1 = require("../command-helpers/abi");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
-const gluegun_1 = require("../command-helpers/gluegun");
 const network_1 = require("../command-helpers/network");
 const scaffold_1 = require("../command-helpers/scaffold");
 const spinner_1 = require("../command-helpers/spinner");
 const protocols_1 = __importDefault(require("../protocols"));
 const abi_2 = __importDefault(require("../protocols/ethereum/abi"));
 const subgraph_1 = __importDefault(require("../subgraph"));
-const HELP = `
-${chalk_1.default.bold('graph add')} <address> [<subgraph-manifest default: "./subgraph.yaml">]
-
-${chalk_1.default.dim('Options:')}
-
-      --abi <path>              Path to the contract ABI (default: download from Etherscan)
-      --contract-name           Name of the contract (default: Contract)
-      --merge-entities          Whether to merge entities with the same name (default: false)
-      --network-file <path>     Networks config file path (default: "./networks.json")
-  -h, --help                    Show usage information
-`;
-exports.default = {
-    description: 'Adds a new datasource to a subgraph',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { print, system } = toolbox;
-        // Read CLI parameters
-        let { abi, contractName, h, help, mergeEntities, networkFile } = toolbox.parameters.options;
-        contractName || (contractName = 'Contract');
-        try {
-            (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                mergeEntities,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
-        const address = toolbox.parameters.first || toolbox.parameters.array?.[0];
-        const manifestPath = toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml';
-        // Show help text if requested
-        if (help || h) {
-            print.info(HELP);
-            return;
-        }
-        // Validate the address
-        if (!address) {
-            print.error('No contract address provided');
-            process.exitCode = 1;
-            return;
-        }
+class Add extends core_1.Command {
+    async run() {
+        const { args: { address, subgraphManifest: manifestPath }, flags: { abi, contractName, mergeEntities, networkFile: networksFile }, } = await this.parse(Add);
         const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath);
         const protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         const manifest = await subgraph_1.default.load(manifestPath, { protocol });
@@ -89,9 +49,7 @@ exports.default = {
         const entities = getEntities(manifest);
         const contractNames = getContractNames(manifest);
         if (contractNames.includes(contractName)) {
-            print.error(`Datasource or template with name ${contractName} already exists, please choose a different name`);
-            process.exitCode = 1;
-            return;
+            throw new errors_1.CLIError(`Datasource or template with name ${contractName} already exists, please choose a different name.`, { exit: 1 });
         }
         let ethabi = null;
         if (abi) {
@@ -103,7 +61,7 @@ exports.default = {
         else {
             ethabi = await (0, abi_1.loadAbiFromEtherscan)(abi_2.default, network, address);
         }
-        const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(toolbox, ethabi, entities, contractName, mergeEntities);
+        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);
@@ -124,20 +82,45 @@ exports.default = {
         result.set('dataSources', dataSources.push(dataSource));
         await subgraph_1.default.write(result, manifestPath);
         // Update networks.json
-        const networksFile = networkFile || './networks.json';
-        await (0, network_1.updateNetworksFile)(toolbox, network, contractName, address, networksFile);
+        await (0, network_1.updateNetworksFile)(network, contractName, address, networksFile);
         // Detect Yarn and/or NPM
-        const yarn = system.which('yarn');
-        const npm = system.which('npm');
+        const yarn = gluegun_1.system.which('yarn');
+        const npm = gluegun_1.system.which('npm');
         if (!yarn && !npm) {
-            print.error(`Neither Yarn nor NPM were found on your system. Please install one of them.`);
-            process.exitCode = 1;
-            return;
+            throw new errors_1.CLIError('Neither Yarn nor NPM were found on your system. Please install one of them.', { exit: 1 });
         }
-        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async () => {
-            await system.run(yarn ? 'yarn codegen' : 'npm run codegen');
-        });
-    },
+        await (0, spinner_1.useSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', () => gluegun_1.system.run(yarn ? 'yarn codegen' : 'npm run codegen'));
+    }
+}
+exports.default = Add;
+Add.description = 'Adds a new datasource to a subgraph.';
+Add.args = {
+    address: core_1.Args.string({
+        description: 'The contract address',
+        required: true,
+    }),
+    subgraphManifest: core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+Add.flags = {
+    abi: core_1.Flags.string({
+        summary: 'Path to the contract ABI.',
+        default: '*Download from Etherscan*',
+    }),
+    contractName: core_1.Flags.string({
+        summary: 'Name of the contract.',
+        default: 'Contract',
+    }),
+    mergeEntities: core_1.Flags.boolean({
+        summary: 'Whether to merge entities with the same name.',
+        default: false,
+    }),
+    // TODO: should be networksFile (with an "s")
+    networkFile: core_1.Flags.string({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };
 const getEntities = (manifest) => {
     const dataSources = manifest.result.get('dataSources', immutable_1.default.List());
@@ -152,9 +135,8 @@ const getContractNames = (manifest) => {
     const templates = manifest.result.get('templates', immutable_1.default.List());
     return dataSources.concat(templates).map((dataSource) => dataSource.get('name'));
 };
-const updateEventNamesOnCollision = (toolbox, ethabi, entities, contractName, mergeEntities) => {
+const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
     let abiData = ethabi.data;
-    const { print } = toolbox;
     const collisionEntities = [];
     let onlyCollisions = true;
     for (let i = 0; i < abiData.size; i++) {
@@ -162,10 +144,8 @@ const updateEventNamesOnCollision = (toolbox, ethabi, entities, contractName, me
         if (dataRow.get('type') === 'event') {
             if (entities.includes(dataRow.get('name'))) {
                 if (entities.includes(`${contractName}${dataRow.get('name')}`)) {
-                    print.error(`Contract name ('${contractName}')
-            + event name ('${dataRow.get('name')}') entity already exists.`);
-                    process.exitCode = 1;
-                    break;
+                    throw new errors_1.CLIError(`Contract name ('${contractName}')
+          + event name ('${dataRow.get('name')}') entity already exists.`, { exit: 1 });
                 }
                 if (mergeEntities) {
                     collisionEntities.push(dataRow.get('name'));

package/dist/commands/init.js

@@ -30,7 +30,6 @@ const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
-const graphCli = __importStar(require("../cli"));
 const abi_1 = require("../command-helpers/abi");
 const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
 const gluegun_1 = require("../command-helpers/gluegun");
@@ -44,6 +43,7 @@ const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const schema_1 = require("../scaffold/schema");
 const validation_1 = require("../validation");
+const add_1 = __importDefault(require("./add"));
 const protocolChoices = Array.from(protocols_1.default.availableProtocols().keys());
 const availableNetworks = protocols_1.default.availableNetworks();
 const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum/gravatar';
@@ -803,7 +803,7 @@ const addAnotherContract = async (toolbox, { protocolInstance, directory }) => {
                     commandLine.push('--abi', abi);
                 }
             }
-            await graphCli.run(commandLine);
+            await add_1.default.run(commandLine);
         }
         catch (e) {
             toolbox.print.error(e);

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1,144 @@
+{
+  "version": "0.38.1-alpha-20230207152800-4428ad7",
+  "commands": {
+    "add": {
+      "id": "add",
+      "description": "Adds a new datasource to a subgraph.",
+      "strict": true,
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "abi": {
+          "name": "abi",
+          "type": "option",
+          "summary": "Path to the contract ABI.",
+          "multiple": false,
+          "default": "*Download from Etherscan*"
+        },
+        "contractName": {
+          "name": "contractName",
+          "type": "option",
+          "summary": "Name of the contract.",
+          "multiple": false,
+          "default": "Contract"
+        },
+        "mergeEntities": {
+          "name": "mergeEntities",
+          "type": "boolean",
+          "summary": "Whether to merge entities with the same name.",
+          "allowNo": false
+        },
+        "networkFile": {
+          "name": "networkFile",
+          "type": "option",
+          "summary": "Networks config file path.",
+          "multiple": false,
+          "default": "networks.json"
+        }
+      },
+      "args": {
+        "address": {
+          "name": "address",
+          "description": "The contract address",
+          "required": true
+        },
+        "subgraphManifest": {
+          "name": "subgraphManifest",
+          "default": "subgraph.yaml"
+        }
+      }
+    },
+    "auth": {
+      "id": "auth",
+      "description": "Sets the deploy key to use when deploying to a Graph node",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "build": {
+      "id": "build",
+      "description": "Builds a subgraph and (optionally) uploads it to IPFS",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "codegen": {
+      "id": "codegen",
+      "description": "Generates AssemblyScript types for a subgraph",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "create": {
+      "id": "create",
+      "description": "Registers a subgraph name",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "deploy": {
+      "id": "deploy",
+      "description": "Deploys the subgraph to a Graph node",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "init": {
+      "id": "init",
+      "description": "Creates a new subgraph with basic scaffolding",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "local": {
+      "id": "local",
+      "description": "Runs local tests against a Graph Node environment (using Ganache by default)",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "remove": {
+      "id": "remove",
+      "description": "Unregisters a subgraph name",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "test": {
+      "id": "test",
+      "description": "Runs rust binary for subgraph testing",
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.38.0",
+  "version": "0.38.1-alpha-20230207152800-4428ad7",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -9,14 +9,16 @@
   "bin": {
     "graph": "dist/bin.js"
   },
-  "main": "dist/cli.js",
+  "main": "dist/index.js",
   "files": [
     "CHANGELOG.md",
     "dist",
+    "oclif.manifest.json",
     "README.md"
   ],
   "dependencies": {
     "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
+    "@oclif/core": "2.0.7",
     "assemblyscript": "0.19.23",
     "binary-install-raw": "0.0.13",
     "chalk": "3.0.0",
@@ -52,6 +54,7 @@
     "@types/which": "^2.0.1",
     "copyfiles": "^2.4.1",
     "jest": "26.0.0",
+    "oclif": "3.6.1",
     "spawn-command": "0.0.2-1",
     "strip-ansi": "6.0.0",
     "tern": "0.24.3",
@@ -60,8 +63,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "oclif": {
+    "bin": "graph",
+    "commands": "./dist/commands"
+  },
   "scripts": {
-    "build": "tsc -b tsconfig.build.json && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
+    "build": "tsc -b tsconfig.build.json && oclif manifest && copyfiles -u 1 src/**/*.graphql dist/ && chmod +x ./dist/bin.js",
     "test": "jest --verbose",
     "test:init": "jest tests/cli/init.test.ts --verbose",
     "test:validation": "jest tests/cli/validation.test.ts --verbose",

package/dist/cli.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-const path_1 = __importDefault(require("path"));
-const gluegun_1 = require("gluegun");
-const run = async (argv) => {
-    let builder = (0, gluegun_1.build)().brand('graph').src(__dirname);
-    const pluginDirs = [];
-    await Promise.all(['npm root -g', 'npm root', 'yarn global dir'].map(async (cmd) => {
-        try {
-            const dir = await gluegun_1.system.run(cmd, { trim: true });
-            pluginDirs.push(dir);
-        }
-        catch (_) {
-            // noop
-        }
-    }));
-    // Inject potential plugin directories
-    builder = pluginDirs.reduce((cli, dir) => cli.plugin(path_1.default.join(dir, '@graphprotocol', 'indexer-cli', 'dist')), builder);
-    const cli = builder.help().version().defaultCommand().create();
-    return await cli.run(argv);
-};
-exports.run = run;