@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216170945-963badb

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphprotocol/graph-cli
 
+## 0.40.1-alpha-20230216170945-963badb
+
+### Patch Changes
+
+- [#1055](https://github.com/graphprotocol/graph-tooling/pull/1055)
+  [`6d6f25b`](https://github.com/graphprotocol/graph-tooling/commit/6d6f25bca2fc6929a750af56b3c10a8cc8a72689)
+  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.40.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,17 +5,20 @@ 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) => {
+const updateSubgraphNetwork = async (manifest, network, networksFile, identifierName) => 
+// TODO: use useSpinner
+await (0, spinner_1.withSpinner)(`Update sources network`, `Failed to update sources network`, `Warnings while updating sources network`, async (spinner) => {
     (0, spinner_1.step)(spinner, `Reading networks config`);
-    const allNetworks = await toolbox.filesystem.read(networksFile, 'json');
+    const allNetworks = await gluegun_1.filesystem.read(networksFile, 'json');
     const 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 => {
+    await gluegun_1.patching.update(manifest, content => {
         const subgraph = yaml_1.default.parse(content);
         const networkSources = Object.keys(networkConfig);
         const subgraphSources = subgraph.dataSources.map((value) => value.name);
@@ -37,10 +40,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}`);
@@ -51,8 +56,10 @@ const updateSubgraphNetwork = async (toolbox, manifest, network, networksFile, i
     });
 });
 exports.updateSubgraphNetwork = updateSubgraphNetwork;
-const initNetworksConfig = async (toolbox, directory, identifierName) => await (0, spinner_1.withSpinner)(`Initialize networks config`, `Failed to initialize networks config`, `Warnings while initializing networks config`, async () => {
-    const subgraphStr = toolbox.filesystem.read(path_1.default.join(directory, 'subgraph.yaml'));
+const initNetworksConfig = async (directory, identifierName) => 
+// TODO: use useSpinner
+await (0, spinner_1.withSpinner)(`Initialize networks config`, `Failed to initialize networks config`, `Warnings while initializing networks config`, async () => {
+    const subgraphStr = gluegun_1.filesystem.read(path_1.default.join(directory, 'subgraph.yaml'));
     const subgraph = yaml_1.default.parse(subgraphStr);
     const networks = subgraph.dataSources.reduce((acc, source) => Object.assign(acc, {
         [source.network]: {
@@ -62,7 +69,7 @@ const initNetworksConfig = async (toolbox, directory, identifierName) => await (
             },
         },
     }), {});
-    toolbox.filesystem.write(`${directory}/networks.json`, networks);
+    gluegun_1.filesystem.write(`${directory}/networks.json`, networks);
     return true;
 });
 exports.initNetworksConfig = initNetworksConfig;
@@ -76,8 +83,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 +93,5 @@ const updateNetworksFile = async (toolbox, network, dataSource, address, network
         }
         return config;
     });
-};
+}
 exports.updateNetworksFile = updateNetworksFile;

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

@@ -33,7 +33,7 @@ const network_1 = require("./network");
 const SUBGRAPH_PATH_BASE = path_1.default.join(__dirname, '..', '..', '..', '..', 'examples', 'example-subgraph');
 describe('initNetworksConfig', () => {
     beforeAll(async () => {
-        await (0, network_1.initNetworksConfig)(toolbox, SUBGRAPH_PATH_BASE, 'address');
+        await (0, network_1.initNetworksConfig)(SUBGRAPH_PATH_BASE, 'address');
     });
     afterAll(async () => {
         toolbox.filesystem.remove(`${SUBGRAPH_PATH_BASE}/networks.json`);
@@ -75,7 +75,7 @@ describe('updateSubgraphNetwork', () => {
         let address = subgraphObj.dataSources[0].source.address;
         expect(network).toBe('mainnet');
         expect(address).toBe('0x22843e74c59580b3eaf6c233fa67d8b7c561a835');
-        await (0, network_1.updateSubgraphNetwork)(toolbox, manifest, 'optimism', networksFie, 'address');
+        await (0, network_1.updateSubgraphNetwork)(manifest, 'optimism', networksFie, 'address');
         subgraph = toolbox.filesystem.read(manifest);
         subgraphObj = yaml_1.default.parse(subgraph);
         network = subgraphObj.dataSources[0].network;

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 AddCommand extends core_1.Command {
+    async run() {
+        const { args: { address, subgraphManifest: manifestPath }, flags: { abi, contractName, mergeEntities, networkFile: networksFile }, } = await this.parse(AddCommand);
         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;
+            this.error(`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,47 @@ 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;
+            this.error('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 = AddCommand;
+AddCommand.description = 'Adds a new datasource to a subgraph.';
+AddCommand.args = {
+    address: core_1.Args.string({
+        description: 'The contract address',
+        required: true,
+    }),
+    subgraphManifest: core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+AddCommand.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"), or?
+    networkFile: core_1.Flags.file({
+        summary: 'Networks config file path.',
+        default: 'networks.json',
+    }),
 };
 const getEntities = (manifest) => {
     const dataSources = manifest.result.get('dataSources', immutable_1.default.List());
@@ -152,9 +137,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 +146,7 @@ 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/auth.js

@@ -1,122 +1,60 @@
 "use strict";
-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 auth_1 = require("../command-helpers/auth");
-const gluegun_1 = require("../command-helpers/gluegun");
 const node_1 = require("../command-helpers/node");
-const HELP = `
-${chalk_1.default.bold('graph auth')} [options] ${chalk_1.default.bold('<node>')} ${chalk_1.default.bold('<deploy-key>')}
-
-${chalk_1.default.dim('Options:')}
-
-      --product <subgraph-studio|hosted-service>
-                                Selects the product for which to authenticate
-      --studio                  Shortcut for --product subgraph-studio
-  -h, --help                    Show usage information
-`;
-const processForm = async (toolbox, { product, studio, node, deployKey }) => {
-    const questions = [
-        {
-            type: 'select',
-            name: 'product',
-            message: 'Product for which to initialize',
-            choices: ['subgraph-studio', 'hosted-service'],
-            skip: product === 'subgraph-studio' ||
-                product === 'hosted-service' ||
-                studio !== undefined ||
-                node !== undefined,
-        },
-        {
-            type: 'password',
-            name: 'deployKey',
-            message: 'Deploy key',
-            skip: deployKey !== undefined,
-        },
-    ];
-    try {
-        const answers = await toolbox.prompt.ask(questions);
-        return answers;
-    }
-    catch (e) {
-        return undefined;
-    }
-};
-exports.default = {
-    description: 'Sets the deploy key to use when deploying to a Graph node',
-    run: async (toolbox) => {
-        // Obtain tools
-        const { print } = toolbox;
-        // Read CLI parameters
-        const { product, studio, h, help } = toolbox.parameters.options;
-        // Show help text if requested
-        if (help || h) {
-            print.info(HELP);
-            return;
-        }
-        let firstParam, secondParam;
-        try {
-            [firstParam, secondParam] = (0, gluegun_1.fixParameters)(toolbox.parameters, {
-                h,
-                help,
-                studio,
-            });
-        }
-        catch (e) {
-            print.error(e.message);
-            process.exitCode = 1;
-            return;
-        }
+class AuthCommand extends core_1.Command {
+    async run() {
+        const { args: { node: nodeOrDeployKey, 'deploy-key': deployKeyFlag }, flags: { product, studio }, } = await this.parse(AuthCommand);
         // if user specifies --product or --studio then deployKey is the first parameter
         let node;
-        let deployKey;
+        let deployKey = deployKeyFlag;
         if (product || studio) {
             ({ node } = (0, node_1.chooseNodeUrl)({ product, studio, node }));
-            deployKey = firstParam;
+            deployKey = nodeOrDeployKey;
         }
         else {
-            node = firstParam;
-            deployKey = secondParam;
+            node = nodeOrDeployKey;
         }
-        if (!node || !deployKey) {
-            const inputs = await processForm(toolbox, {
-                product,
-                studio,
-                node,
-                deployKey,
-            });
-            if (inputs === undefined) {
-                process.exit(1);
-            }
-            if (!node) {
-                ({ node } = (0, node_1.chooseNodeUrl)({
-                    product: inputs.product,
-                    studio,
-                    node,
+        // eslint-disable-next-line -- prettier has problems with ||=
+        node =
+            node ||
+                (await core_1.ux.prompt('Which product to initialize?', {
+                    required: true,
+                }));
+        // eslint-disable-next-line -- prettier has problems with ||=
+        deployKey =
+            deployKey ||
+                (await core_1.ux.prompt('What is the deploy key?', {
+                    required: true,
+                    type: 'mask',
                 }));
-            }
-            deployKey || (deployKey = inputs.deployKey);
-        }
-        if (!deployKey) {
-            print.error(`No deploy key provided`);
-            print.info(HELP);
-            process.exitCode = 1;
-            return;
-        }
         if (deployKey.length > 200) {
-            print.error(`Deploy key must not exceed 200 characters`);
-            process.exitCode = 1;
-            return;
+            this.error('✖ Deploy key must not exceed 200 characters', { exit: 1 });
         }
+        core_1.ux.action.start(`Setting deploy key for "${node}"`);
         try {
             await (0, auth_1.saveDeployKey)(node, deployKey);
-            print.success(`Deploy key set for ${node}`);
+            core_1.ux.action.stop(`✔ Deploy key set for "${node}"`);
         }
         catch (e) {
-            print.error(e);
-            process.exitCode = 1;
+            this.error(e, { exit: 1 });
         }
-    },
+    }
+}
+exports.default = AuthCommand;
+AuthCommand.description = 'Sets the deploy key to use when deploying to a Graph node.';
+AuthCommand.args = {
+    node: core_1.Args.string(),
+    'deploy-key': core_1.Args.string(),
+};
+AuthCommand.flags = {
+    product: core_1.Flags.string({
+        summary: 'Select a product for which to authenticate.',
+        options: ['subgraph-studio', 'hosted-service'],
+    }),
+    studio: core_1.Flags.boolean({
+        summary: 'Shortcut for "--product subgraph-studio".',
+        exclusive: ['product'],
+    }),
 };