@graphprotocol/graph-cli 0.72.2 → 0.73.0-alpha-20240523161731-2bda657

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @graphprotocol/graph-cli
 
+## 0.73.0-alpha-20240523161731-2bda657
+
+### Minor Changes
+
+- [#1670](https://github.com/graphprotocol/graph-tooling/pull/1670)
+  [`2bda657`](https://github.com/graphprotocol/graph-tooling/commit/2bda65741d2403dedb743bb34b7d678cdd85a405)
+  Thanks [@saihaj](https://github.com/saihaj)! - Introduce `graph publish` command.
+
+  Now you can publish your subgraphs directly from the CLI. This command will build your subgraph,
+  deploy, prompt you to add metadata and then sign the transaction to publish it to the Graph
+  Network.
+
+  1. Build the subgraph and publish it to the network.
+
+  ```sh
+  graph publish
+  ```
+
+  2. Provide a IPFS Hash for the subgraph and publish it to the network.
+
+  ```sh
+  graph publish --ipfs <ipfs-hash>
+  ```
+
 ## 0.72.2
 
 ### Patch Changes

package/dist/commands/publish.d.ts

@@ -0,0 +1,19 @@
+import { Command } from '@oclif/core';
+export default class PublishCommand extends Command {
+    static description: string;
+    static args: {
+        'subgraph-manifest': import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        ipfs: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'ipfs-hash': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    /**
+     * Prompt the user to open up the browser to continue publishing the subgraph
+     */
+    publishWithBrowser({ ipfsHash }: {
+        ipfsHash: string;
+    }): Promise<void>;
+    run(): Promise<void>;
+}

package/dist/commands/publish.js

@@ -0,0 +1,107 @@
+"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 });
+const chalk_1 = __importDefault(require("chalk"));
+const gluegun_1 = require("gluegun");
+const open_1 = __importDefault(require("open"));
+const core_1 = require("@oclif/core");
+const compiler_1 = require("../command-helpers/compiler");
+const DataSourcesExtractor = __importStar(require("../command-helpers/data-sources"));
+const ipfs_1 = require("../command-helpers/ipfs");
+const protocols_1 = __importDefault(require("../protocols"));
+class PublishCommand extends core_1.Command {
+    /**
+     * Prompt the user to open up the browser to continue publishing the subgraph
+     */
+    async publishWithBrowser({ ipfsHash }) {
+        const answer = await core_1.ux.prompt(`Press ${chalk_1.default.green('y')} (or any key) to open up the browser to continue publishing or ${chalk_1.default.yellow('q')} to exit`);
+        if (answer.toLowerCase() === 'q') {
+            this.exit(0);
+        }
+        const URL = `https://cli.thegraph.com/deploy?id=${ipfsHash}`;
+        gluegun_1.print.success(`Finalize the publish of the subgraph from the Graph CLI publish page. Opening up the browser to continue publishing at ${URL}`);
+        await (0, open_1.default)(URL);
+        return;
+    }
+    async run() {
+        const { args: { 'subgraph-manifest': manifest }, flags: { 'ipfs-hash': ipfsHash, ipfs, }, } = await this.parse(PublishCommand);
+        if (ipfsHash) {
+            await this.publishWithBrowser({ ipfsHash });
+            return;
+        }
+        let protocol;
+        try {
+            const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
+            protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
+        }
+        catch (e) {
+            this.error(e, { exit: 1 });
+        }
+        const compiler = (0, compiler_1.createCompiler)(manifest, {
+            ipfs,
+            outputDir: 'build/',
+            outputFormat: 'wasm',
+            skipMigrations: false,
+            protocol,
+        });
+        // Exit with an error code if the compiler couldn't be created
+        if (!compiler) {
+            this.exit(1);
+            return;
+        }
+        const result = await compiler.compile({ validate: true });
+        if (result === undefined || result === false) {
+            // Compilation failed, not deploying.
+            process.exitCode = 1;
+            return;
+        }
+        await this.publishWithBrowser({ ipfsHash: result });
+        return;
+    }
+}
+PublishCommand.description = 'Publish to the Graph Network';
+PublishCommand.args = {
+    'subgraph-manifest': core_1.Args.string({
+        default: 'subgraph.yaml',
+    }),
+};
+PublishCommand.flags = {
+    help: core_1.Flags.help({
+        char: 'h',
+    }),
+    ipfs: core_1.Flags.string({
+        summary: 'Upload build results to an IPFS node.',
+        char: 'i',
+        default: ipfs_1.DEFAULT_IPFS_URL,
+    }),
+    'ipfs-hash': core_1.Flags.string({
+        summary: 'IPFS hash of the subgraph manifest to deploy.',
+        required: false,
+    }),
+};
+exports.default = PublishCommand;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.72.2",
+  "version": "0.73.0-alpha-20240523161731-2bda657",
   "commands": {
     "add": {
       "id": "add",
@@ -746,6 +746,45 @@
         }
       }
     },
+    "publish": {
+      "id": "publish",
+      "description": "Publish to the Graph Network",
+      "strict": true,
+      "pluginName": "@graphprotocol/graph-cli",
+      "pluginAlias": "@graphprotocol/graph-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "ipfs": {
+          "name": "ipfs",
+          "type": "option",
+          "char": "i",
+          "summary": "Upload build results to an IPFS node.",
+          "multiple": false,
+          "default": "https://api.thegraph.com/ipfs/api/v0"
+        },
+        "ipfs-hash": {
+          "name": "ipfs-hash",
+          "type": "option",
+          "summary": "IPFS hash of the subgraph manifest to deploy.",
+          "required": false,
+          "multiple": false
+        }
+      },
+      "args": {
+        "subgraph-manifest": {
+          "name": "subgraph-manifest",
+          "default": "subgraph.yaml"
+        }
+      }
+    },
     "remove": {
       "id": "remove",
       "description": "Unregisters a subgraph name",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.72.2",
+  "version": "0.73.0-alpha-20240523161731-2bda657",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -39,6 +39,7 @@
     "ipfs-http-client": "55.0.0",
     "jayson": "4.0.0",
     "js-yaml": "3.14.1",
+    "open": "8.4.2",
     "prettier": "3.0.3",
     "semver": "7.4.0",
     "sync-request": "6.1.0",