feat: publish to graph network (#1670)

* feat: publish to graph network

* chore(dependencies): updated changesets for modified dependencies

* allow passing url

* fix copy

* update readme

* fix lint

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: saihaj

.changeset/@graphprotocol_graph-cli-1670-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphprotocol/graph-cli": patch
+---
+dependencies updates:
+  - Added dependency [`open@8.4.2` ↗︎](https://www.npmjs.com/package/open/v/8.4.2) (to `dependencies`)

.changeset/bright-readers-remember.md

@@ -0,0 +1,25 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+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>
+```
+
+3. You can use a custom webapp url for deploying.
+
+```sh
+graph publish --webapp-url <webapp-url>
+```

packages/cli/README.md

@@ -22,6 +22,7 @@ As of today, the command line interface supports the following commands:
   binary in order to test a subgraph.
 - `graph add` - Adds a new datasource to the yaml file and writes the necessary changes to other
   files - schema.graphql, abi and mapping.
+- `graph publish` - Publishes the subgraph to the Graph Network.
 
 ## How It Works
 

packages/cli/package.json

@@ -48,6 +48,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",

packages/cli/src/commands/publish.ts

@@ -0,0 +1,106 @@
+import chalk from 'chalk';
+import { print } from 'gluegun';
+import open from 'open';
+import { Args, Command, Flags, ux } from '@oclif/core';
+import { createCompiler } from '../command-helpers/compiler';
+import * as DataSourcesExtractor from '../command-helpers/data-sources';
+import { DEFAULT_IPFS_URL } from '../command-helpers/ipfs';
+import Protocol from '../protocols';
+
+export default class PublishCommand extends Command {
+  static description = 'Publish to the Graph Network';
+
+  static args = {
+    'subgraph-manifest': Args.string({
+      default: 'subgraph.yaml',
+    }),
+  };
+
+  static flags = {
+    help: Flags.help({
+      char: 'h',
+    }),
+    ipfs: Flags.string({
+      summary: 'Upload build results to an IPFS node.',
+      char: 'i',
+      default: DEFAULT_IPFS_URL,
+    }),
+    'ipfs-hash': Flags.string({
+      summary: 'IPFS hash of the subgraph manifest to deploy.',
+      required: false,
+    }),
+    'webapp-url': Flags.string({
+      summary: 'URL of the web UI you want to use to deploy.',
+      required: false,
+      default: 'https://cli.thegraph.com/publish',
+    }),
+  };
+
+  /**
+   * Prompt the user to open up the browser to continue publishing the subgraph
+   */
+  async publishWithBrowser({ ipfsHash, webapp }: { ipfsHash: string; webapp: string }) {
+    const answer = await ux.prompt(
+      `Press ${chalk.green(
+        'y',
+      )} (or any key) to open up the browser to continue publishing or ${chalk.yellow(
+        'q',
+      )} to exit`,
+    );
+
+    if (answer.toLowerCase() === 'q') {
+      this.exit(0);
+    }
+
+    const URL = `${webapp}?id=${ipfsHash}`;
+
+    print.success(
+      `Finalize the publish of the subgraph from the Graph CLI publish page. Opening up the browser to continue publishing at ${URL}`,
+    );
+    await open(URL);
+    return;
+  }
+
+  async run() {
+    const {
+      args: { 'subgraph-manifest': manifest },
+      flags: { 'ipfs-hash': ipfsHash, 'webapp-url': webUiUrl, ipfs },
+    } = await this.parse(PublishCommand);
+
+    if (ipfsHash) {
+      await this.publishWithBrowser({ ipfsHash, webapp: webUiUrl });
+      return;
+    }
+
+    let protocol;
+    try {
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
+      protocol = Protocol.fromDataSources(dataSourcesAndTemplates);
+    } catch (e) {
+      this.error(e, { exit: 1 });
+    }
+
+    const compiler = 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, webapp: webUiUrl });
+    return;
+  }
+}