Merge branch 'main' into fix/init-directory-already-exists

Author: 0237h

.changeset/cold-snails-bake.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': patch
+---
+
+Using `graph add` with `localhost` network now prompts the user for input

.changeset/gold-deers-kick.md

@@ -0,0 +1,18 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+Breaking changes to the CLI to prepare for the sunset of the hosted service.
+
+- `graph auth`
+  - Removed `--product` flag
+  - Removed `--studio` flag 
+  - Removed `node` argument
+- `graph deploy`
+  - Removed `--product` flag
+  - Removed `--studio` flag
+  - Removed `--from-hosted-service` flag
+- `graph init`
+  - Removed `--product` flag
+  - Removed `--studio` flag
+  - Removed `--allow-simple-name` flag

.changeset/wild-weeks-protect.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+Add warning for available CLI updates

packages/cli/README.md

@@ -29,12 +29,16 @@ As of today, the command line interface supports the following commands:
 The Graph CLI takes a subgraph manifest (defaults to `subgraph.yaml`) with references to:
 
 - A GraphQL schema,
-- Smart contract ABIs, and
-- Mappings written in AssemblyScript.
+- Smart contract ABIs,
+- Mappings written in AssemblyScript for traditional subgraphs,
+- Substreams package and triggers for substreams-based subgraphs
 
 It compiles the mappings to WebAssembly, builds a ready-to-use version of the subgraph saved to IPFS
 or a local directory for debugging, and deploys the subgraph to a
-[Graph Node](https://github.com/graphprotocol/graph-node).
+[Graph Node](https://github.com/graphprotocol/graph-node) instance or
+[Subgraph Studio](https://thegraph.com/studio/). Additionally it allows you to publish your subgraph
+to the decentralized network directly, making it available for indexing via
+[Graph Explorer](https://thegraph.com/explorer)
 
 ## Installation
 
@@ -73,11 +77,15 @@ Use one of the following commands depending on your distribution:
 
 The Graph CLI can be used with a local or self-hosted
 [Graph Node](https://github.com/graphprotocol/graph-node) or with the
-[Hosted Service](https://thegraph.com/explorer/). To help you get going, there are
-[quick start guides](https://thegraph.com/docs/en/developer/quick-start/) available for both.
+[Subgraph Studio](https://thegraph.com/studio/). To help you get going, there are
+[quick start guides](https://thegraph.com/docs/en/quick-start/) available for both.
+
+Additionally, you can use Graph CLI to
+[publish](https://thegraph.com/docs/en/quick-start/#publishing-from-the-cli) your subgraph to the
+decentralized network directly.
 
 If you are ready to dive into the details of building a subgraph from scratch, there is a
-[detailed walkthrough](https://thegraph.com/docs/en/developer/create-subgraph-hosted/) for that as
+[detailed walkthrough](https://thegraph.com/docs/en/developing/creating-a-subgraph/) for that as
 well, along with API documentation for the
 [AssemblyScript API](https://thegraph.com/docs/en/developer/assemblyscript-api/).
 

packages/cli/package.json

@@ -32,6 +32,7 @@
     "@oclif/core": "2.8.6",
     "@oclif/plugin-autocomplete": "^2.3.6",
     "@oclif/plugin-not-found": "^2.4.0",
+    "@oclif/plugin-warn-if-update-available": "^3.1.20",
     "@whatwg-node/fetch": "^0.8.4",
     "assemblyscript": "0.19.23",
     "binary-install-raw": "0.0.13",
@@ -85,7 +86,12 @@
     ],
     "plugins": [
       "@oclif/plugin-not-found",
-      "@oclif/plugin-autocomplete"
-    ]
+      "@oclif/plugin-autocomplete",
+      "@oclif/plugin-warn-if-update-available"
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 1,
+      "message": "<%= config.name %> update available from <%= chalk.yellowBright(config.version) %> to <%= chalk.greenBright(latest) %>."
+    }
   }
 }

packages/cli/src/command-helpers/node.ts

@@ -1,92 +1,22 @@
 import { URL } from 'url';
 import { print } from 'gluegun';
-import { GRAPH_CLI_SHARED_HEADERS } from '../constants';
 
 export const SUBGRAPH_STUDIO_URL = 'https://api.studio.thegraph.com/deploy/';
-const HOSTED_SERVICE_URL = 'https://api.thegraph.com/deploy/';
-const HOSTED_SERVICE_INDEX_NODE_URL = 'https://api.thegraph.com/index-node/graphql';
 
 export const validateNodeUrl = (node: string) => new URL(node);
 
 export const normalizeNodeUrl = (node: string) => new URL(node).toString();
 
-export function chooseNodeUrl({
-  product,
-  studio,
-  node,
-  allowSimpleName,
-}: {
-  product: string | undefined;
-  studio: boolean | undefined;
-  node?: string;
-  allowSimpleName?: boolean;
-}) {
+export function chooseNodeUrl({ node }: { node?: string }) {
   if (node) {
     try {
       validateNodeUrl(node);
+      return { node };
     } catch (e) {
       print.error(`Graph node "${node}" is invalid: ${e.message}`);
       process.exit(1);
     }
-  } else {
-    if (studio) {
-      product = 'subgraph-studio';
-    }
-    switch (product) {
-      case 'subgraph-studio':
-        node = SUBGRAPH_STUDIO_URL;
-        break;
-      case 'hosted-service':
-        node = HOSTED_SERVICE_URL;
-        break;
-    }
-  }
-  if (node?.match(/studio/) || product === 'subgraph-studio') {
-    allowSimpleName = true;
-  }
-  return { node, allowSimpleName };
-}
-
-export async function getHostedServiceSubgraphId({
-  subgraphName,
-}: {
-  subgraphName: string;
-}): Promise<{
-  subgraph: string;
-  synced: boolean;
-  health: 'healthy' | 'unhealthy' | 'failed';
-}> {
-  const response = await fetch(HOSTED_SERVICE_INDEX_NODE_URL, {
-    method: 'POST',
-    body: JSON.stringify({
-      query: /* GraphQL */ `
-        query GraphCli_getSubgraphId($subgraphName: String!) {
-          indexingStatusForCurrentVersion(subgraphName: $subgraphName) {
-            subgraph
-            synced
-            health
-          }
-        }
-      `,
-      variables: {
-        subgraphName,
-      },
-    }),
-    headers: {
-      'content-type': 'application/json',
-      ...GRAPH_CLI_SHARED_HEADERS,
-    },
-  });
-
-  const { data, errors } = await response.json();
-
-  if (errors) {
-    throw new Error(errors[0].message);
-  }
-
-  if (!data.indexingStatusForCurrentVersion) {
-    throw new Error(`Subgraph "${subgraphName}" not found on the hosted service`);
   }
 
-  return data.indexingStatusForCurrentVersion;
+  return { node: SUBGRAPH_STUDIO_URL };
 }

packages/cli/src/command-helpers/subgraph.ts

@@ -1,20 +1,3 @@
-export const validateSubgraphName = (
-  name: string,
-  { allowSimpleName }: { allowSimpleName?: boolean },
-) => {
-  if (allowSimpleName) {
-    return name;
-  }
-  if (name.split('/').length !== 2) {
-    throw new Error(`Subgraph name "${name}" needs to have the format "<PREFIX>/${name}".
-
-When using the Hosted Service at https://thegraph.com, <PREFIX> is the
-name of your GitHub user or organization.
-
-You can bypass this check with --allow-simple-name.`);
-  }
-};
-
 export const getSubgraphBasename = (name: string) => {
   const segments = name.split('/', 2);
   return segments[segments.length - 1];

packages/cli/src/commands/add.ts

@@ -77,6 +77,9 @@ export default class AddCommand extends Command {
     const manifest = await Subgraph.load(manifestPath, { protocol });
     const network = manifest.result.getIn(['dataSources', 0, 'network']) as any;
     const result = manifest.result.asMutable();
+    const isLocalHost = network === 'localhost'; // This flag prevent Etherscan lookups in case the network selected is `localhost`
+
+    if (isLocalHost) this.warn('`localhost` network detected, prompting user for inputs');
 
     let startBlock = startBlockFlag;
     let contractName = contractNameFlag;
@@ -96,10 +99,44 @@ export default class AddCommand extends Command {
     } else if (network === 'poa-core') {
       ethabi = await loadAbiFromBlockScout(EthereumABI, network, address);
     } else {
-      ethabi = await loadAbiFromEtherscan(EthereumABI, network, address);
+      try {
+        if (isLocalHost) throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
+
+        ethabi = await loadAbiFromEtherscan(EthereumABI, network, address);
+      } catch (error) {
+        // we cannot ask user to do prompt in test environment
+        if (process.env.NODE_ENV !== 'test') {
+          const { abi: abiFromFile } = await prompt.ask<{ abi: EthereumABI }>([
+            {
+              type: 'input',
+              name: 'abi',
+              message: 'ABI file (path)',
+              initial: ethabi,
+              validate: async (value: string) => {
+                try {
+                  EthereumABI.load(contractName, value);
+                  return true;
+                } catch (e) {
+                  this.error(e.message);
+                }
+              },
+              result: async (value: string) => {
+                try {
+                  return EthereumABI.load(contractName, value);
+                } catch (e) {
+                  return e.message;
+                }
+              },
+            },
+          ]);
+          ethabi = abiFromFile;
+        }
+      }
     }
 
     try {
+      if (isLocalHost) throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
+
       startBlock ||= Number(await loadStartBlockForContract(network, address)).toString();
     } catch (error) {
       // we cannot ask user to do prompt in test environment
@@ -122,6 +159,8 @@ export default class AddCommand extends Command {
     }
 
     try {
+      if (isLocalHost) throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
+
       contractName = await loadContractNameForAddress(network, address);
     } catch (error) {
       // not asking user to do prompt in test environment

packages/cli/src/commands/auth.ts

@@ -7,55 +7,21 @@ export default class AuthCommand extends Command {
   static description = 'Sets the deploy key to use when deploying to a Graph node.';
 
   static args = {
-    node: Args.string(),
     'deploy-key': Args.string(),
   };
 
   static flags = {
     help: Flags.help({
       char: 'h',
     }),
-
-    product: Flags.string({
-      summary: 'Select a product for which to authenticate.',
-      options: ['subgraph-studio', 'hosted-service'],
-      deprecated: {
-        message:
-          'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
-      },
-    }),
-    studio: Flags.boolean({
-      summary: 'Shortcut for "--product subgraph-studio".',
-      exclusive: ['product'],
-      deprecated: {
-        message:
-          'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
-      },
-    }),
   };
 
   async run() {
-    const {
-      args: { node: nodeOrDeployKey, 'deploy-key': deployKeyFlag },
-      flags: { product, studio },
+    let {
+      args: { 'deploy-key': deployKey },
     } = await this.parse(AuthCommand);
 
-    // if user specifies --product or --studio then deployKey is the first parameter
-    let node: string | undefined;
-    let deployKey = deployKeyFlag;
-    if (product || studio) {
-      ({ node } = chooseNodeUrl({ product, studio, node }));
-      deployKey = nodeOrDeployKey;
-    } else {
-      node = nodeOrDeployKey;
-    }
-
-    // eslint-disable-next-line -- prettier has problems with ||=
-    node =
-      node ||
-      (await ux.prompt('Which product to initialize?', {
-        required: true,
-      }));
+    const { node } = chooseNodeUrl({});
 
     // eslint-disable-next-line -- prettier has problems with ||=
     deployKey =
@@ -68,10 +34,6 @@ export default class AuthCommand extends Command {
       this.error('✖ Deploy key must not exceed 200 characters', { exit: 1 });
     }
 
-    if (product === 'hosted-service' || node?.match(/api.thegraph.com/)) {
-      this.error('✖ The hosted service is deprecated', { exit: 1 });
-    }
-
     try {
       await saveDeployKey(node!, deployKey);
       print.success(`Deploy key set for ${node}`);