@graphprotocol/graph-cli 0.88.0-alpha-20241031144836-2d9c5cd → 0.88.0-alpha-20241031145713-add2ae3

package/CHANGELOG.md

@@ -1,26 +1,19 @@
 # @graphprotocol/graph-cli
 
-## 0.88.0-alpha-20241031144836-2d9c5cd
+## 0.88.0-alpha-20241031145713-add2ae3
 
 ### Minor Changes
 
-- [#1680](https://github.com/graphprotocol/graph-tooling/pull/1680)
-  [`69147a6`](https://github.com/graphprotocol/graph-tooling/commit/69147a64b35622d423936145fc0b2465a2afab17)
-  Thanks [@saihaj](https://github.com/saihaj)! - 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
+- [#1749](https://github.com/graphprotocol/graph-tooling/pull/1749)
+  [`bf43cbf`](https://github.com/graphprotocol/graph-tooling/commit/bf43cbf8283c53f0005d7cb9dfa681c92f3a6a91)
+  Thanks [@0237h](https://github.com/0237h)! - Add warning for available CLI updates
+
+### Patch Changes
+
+- [#1751](https://github.com/graphprotocol/graph-tooling/pull/1751)
+  [`0ba99dc`](https://github.com/graphprotocol/graph-tooling/commit/0ba99dcd6783fb20779d4f5a6791fc155969939e)
+  Thanks [@0237h](https://github.com/0237h)! - Using `graph add` with `localhost` network now
+  prompts the user for input
 
 ## 0.87.0
 

package/README.md

@@ -29,16 +29,12 @@ 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,
-- Mappings written in AssemblyScript for traditional subgraphs,
-- Substreams package and triggers for substreams-based subgraphs
+- Smart contract ABIs, and
+- Mappings written in AssemblyScript.
 
 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) 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)
+[Graph Node](https://github.com/graphprotocol/graph-node).
 
 ## Installation
 
@@ -77,15 +73,11 @@ 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
-[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.
+[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.
 
 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/developing/creating-a-subgraph/) for that as
+[detailed walkthrough](https://thegraph.com/docs/en/developer/create-subgraph-hosted/) for that as
 well, along with API documentation for the
 [AssemblyScript API](https://thegraph.com/docs/en/developer/assemblyscript-api/).
 

package/dist/command-helpers/node.d.ts

@@ -3,8 +3,19 @@ import { URL } from 'url';
 export declare const SUBGRAPH_STUDIO_URL = "https://api.studio.thegraph.com/deploy/";
 export declare const validateNodeUrl: (node: string) => URL;
 export declare const normalizeNodeUrl: (node: string) => string;
-export declare function chooseNodeUrl({ node }: {
+export declare function chooseNodeUrl({ product, studio, node, allowSimpleName, }: {
+    product: string | undefined;
+    studio: boolean | undefined;
     node?: string;
+    allowSimpleName?: boolean;
 }): {
-    node: string;
+    node: string | undefined;
+    allowSimpleName: boolean | undefined;
 };
+export declare function getHostedServiceSubgraphId({ subgraphName, }: {
+    subgraphName: string;
+}): Promise<{
+    subgraph: string;
+    synced: boolean;
+    health: 'healthy' | 'unhealthy' | 'failed';
+}>;

package/dist/command-helpers/node.js

@@ -1,24 +1,74 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = exports.SUBGRAPH_STUDIO_URL = void 0;
+exports.getHostedServiceSubgraphId = exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = exports.SUBGRAPH_STUDIO_URL = void 0;
 const url_1 = require("url");
 const gluegun_1 = require("gluegun");
+const constants_1 = require("../constants");
 exports.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';
 const validateNodeUrl = (node) => new url_1.URL(node);
 exports.validateNodeUrl = validateNodeUrl;
 const normalizeNodeUrl = (node) => new url_1.URL(node).toString();
 exports.normalizeNodeUrl = normalizeNodeUrl;
-function chooseNodeUrl({ node }) {
+function chooseNodeUrl({ product, studio, node, allowSimpleName, }) {
     if (node) {
         try {
             (0, exports.validateNodeUrl)(node);
-            return { node };
         }
         catch (e) {
             gluegun_1.print.error(`Graph node "${node}" is invalid: ${e.message}`);
             process.exit(1);
         }
     }
-    return { node: exports.SUBGRAPH_STUDIO_URL };
+    else {
+        if (studio) {
+            product = 'subgraph-studio';
+        }
+        switch (product) {
+            case 'subgraph-studio':
+                node = exports.SUBGRAPH_STUDIO_URL;
+                break;
+            case 'hosted-service':
+                node = HOSTED_SERVICE_URL;
+                break;
+        }
+    }
+    if (node?.match(/studio/) || product === 'subgraph-studio') {
+        allowSimpleName = true;
+    }
+    return { node, allowSimpleName };
 }
 exports.chooseNodeUrl = chooseNodeUrl;
+async function getHostedServiceSubgraphId({ subgraphName, }) {
+    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',
+            ...constants_1.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;
+}
+exports.getHostedServiceSubgraphId = getHostedServiceSubgraphId;

package/dist/command-helpers/subgraph.d.ts

@@ -1 +1,4 @@
+export declare const validateSubgraphName: (name: string, { allowSimpleName }: {
+    allowSimpleName?: boolean | undefined;
+}) => string | undefined;
 export declare const getSubgraphBasename: (name: string) => string;

package/dist/command-helpers/subgraph.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSubgraphBasename = void 0;
+exports.getSubgraphBasename = exports.validateSubgraphName = void 0;
+const validateSubgraphName = (name, { allowSimpleName }) => {
+    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.`);
+    }
+};
+exports.validateSubgraphName = validateSubgraphName;
 const getSubgraphBasename = (name) => {
     const segments = name.split('/', 2);
     return segments[segments.length - 1];

package/dist/commands/add.js

@@ -46,6 +46,9 @@ class AddCommand extends core_1.Command {
         const manifest = await subgraph_1.default.load(manifestPath, { protocol });
         const network = manifest.result.getIn(['dataSources', 0, 'network']);
         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;
         const entities = getEntities(manifest);
@@ -61,9 +64,46 @@ class AddCommand extends core_1.Command {
             ethabi = await (0, abi_1.loadAbiFromBlockScout)(abi_2.default, network, address);
         }
         else {
-            ethabi = await (0, abi_1.loadAbiFromEtherscan)(abi_2.default, network, address);
+            try {
+                if (isLocalHost)
+                    throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
+                ethabi = await (0, abi_1.loadAbiFromEtherscan)(abi_2.default, network, address);
+            }
+            catch (error) {
+                // we cannot ask user to do prompt in test environment
+                if (process.env.NODE_ENV !== 'test') {
+                    const { abi: abiFromFile } = await gluegun_1.prompt.ask([
+                        {
+                            type: 'input',
+                            name: 'abi',
+                            message: 'ABI file (path)',
+                            initial: ethabi,
+                            validate: async (value) => {
+                                try {
+                                    abi_2.default.load(contractName, value);
+                                    return true;
+                                }
+                                catch (e) {
+                                    this.error(e.message);
+                                }
+                            },
+                            result: async (value) => {
+                                try {
+                                    return abi_2.default.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 || (startBlock = Number(await (0, abi_1.loadStartBlockForContract)(network, address)).toString());
         }
         catch (error) {
@@ -86,6 +126,8 @@ class AddCommand extends core_1.Command {
             }
         }
         try {
+            if (isLocalHost)
+                throw Error; // Triggers user prompting without waiting for Etherscan lookup to fail
             contractName = await (0, abi_1.loadContractNameForAddress)(network, address);
         }
         catch (error) {

package/dist/commands/auth.d.ts

@@ -2,10 +2,13 @@ import { Command } from '@oclif/core';
 export default class AuthCommand extends Command {
     static description: string;
     static args: {
+        node: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
         'deploy-key': import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
     };
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        product: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        studio: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/commands/auth.js

@@ -6,8 +6,23 @@ const auth_1 = require("../command-helpers/auth");
 const node_1 = require("../command-helpers/node");
 class AuthCommand extends core_1.Command {
     async run() {
-        let { args: { 'deploy-key': deployKey }, } = await this.parse(AuthCommand);
-        const { node } = (0, node_1.chooseNodeUrl)({});
+        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 = deployKeyFlag;
+        if (product || studio) {
+            ({ node } = (0, node_1.chooseNodeUrl)({ product, studio, node }));
+            deployKey = nodeOrDeployKey;
+        }
+        else {
+            node = nodeOrDeployKey;
+        }
+        // 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 ||
@@ -18,6 +33,9 @@ class AuthCommand extends core_1.Command {
         if (deployKey.length > 200) {
             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 (0, auth_1.saveDeployKey)(node, deployKey);
             gluegun_1.print.success(`Deploy key set for ${node}`);
@@ -29,11 +47,26 @@ class AuthCommand extends core_1.Command {
 }
 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 = {
     help: core_1.Flags.help({
         char: 'h',
     }),
+    product: core_1.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: core_1.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/',
+        },
+    }),
 };
 exports.default = AuthCommand;

package/dist/commands/deploy.d.ts

@@ -7,6 +7,8 @@ export default class DeployCommand extends Command {
     };
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        product: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        studio: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         node: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'deploy-key': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'access-token': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
@@ -20,6 +22,7 @@ export default class DeployCommand extends Command {
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         network: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'network-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'from-hosted-service': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     run(): Promise<void>;
 }

package/dist/commands/deploy.js

@@ -48,21 +48,149 @@ const headersFlag = core_1.Flags.custom({
     parse: val => JSON.parse(val),
     default: {},
 });
+const productOptions = ['subgraph-studio', 'hosted-service'];
 const deployDebugger = (0, debug_1.default)('graph-cli:deploy');
 class DeployCommand extends core_1.Command {
     async run() {
-        const { args: { 'subgraph-name': subgraphNameArg, 'subgraph-manifest': manifest }, flags: { 'deploy-key': deployKeyFlag, 'access-token': accessToken, 'version-label': versionLabelFlag, ipfs, headers, node: nodeFlag, 'output-dir': outputDir, 'skip-migrations': skipMigrations, watch, 'debug-fork': debugFork, network, 'network-file': networkFile, 'ipfs-hash': ipfsHash, }, } = await this.parse(DeployCommand);
+        const { args: { 'subgraph-name': subgraphNameArg, 'subgraph-manifest': manifest }, flags: { product: productFlag, studio, 'deploy-key': deployKeyFlag, 'access-token': accessToken, 'version-label': versionLabelFlag, ipfs, headers, node: nodeFlag, 'output-dir': outputDir, 'skip-migrations': skipMigrations, watch, 'debug-fork': debugFork, network, 'network-file': networkFile, 'ipfs-hash': ipfsHash, 'from-hosted-service': hostedServiceSubgraphName, }, } = await this.parse(DeployCommand);
+        if (hostedServiceSubgraphName) {
+            const { health, subgraph: subgraphIpfsHash } = await (0, node_1.getHostedServiceSubgraphId)({
+                subgraphName: hostedServiceSubgraphName,
+            });
+            const safeToDeployFailedSubgraph = health === 'failed'
+                ? await core_1.ux.confirm('This subgraph has failed indexing on hosted service. Do you wish to continue the deploy?')
+                : true;
+            if (!safeToDeployFailedSubgraph)
+                return;
+            const safeToDeployUnhealthySubgraph = health === 'unhealthy'
+                ? await core_1.ux.confirm('This subgraph is not healthy on hosted service. Do you wish to continue the deploy?')
+                : true;
+            if (!safeToDeployUnhealthySubgraph)
+                return;
+            const { node } = (0, node_1.chooseNodeUrl)({ studio: true, product: undefined });
+            // shouldn't happen, but we need to satisfy the compiler
+            if (!node) {
+                this.error('No node URL available');
+            }
+            const requestUrl = new url_1.URL(node);
+            const client = (0, jsonrpc_1.createJsonRpcClient)(requestUrl);
+            // Exit with an error code if the client couldn't be created
+            if (!client) {
+                this.error('Failed to create RPC client');
+            }
+            // Use the deploy key, if one is set
+            let deployKey = deployKeyFlag;
+            if (!deployKey && accessToken) {
+                deployKey = accessToken; // backwards compatibility
+            }
+            deployKey = await (0, auth_1.identifyDeployKey)(node, deployKey);
+            if (!deployKey) {
+                this.error('No deploy key available');
+            }
+            // @ts-expect-error options property seems to exist
+            client.options.headers = {
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                Authorization: 'Bearer ' + deployKey,
+            };
+            const subgraphName = await core_1.ux.prompt('What is the name of the subgraph you want to deploy?', {
+                required: true,
+            });
+            // Ask for label if not on hosted service
+            const versionLabel = versionLabelFlag ||
+                (await core_1.ux.prompt('Which version label to use? (e.g. "v0.0.1")', {
+                    required: true,
+                }));
+            const spinner = gluegun_1.print.spin(`Deploying to Graph node ${requestUrl}`);
+            client.request('subgraph_deploy', {
+                name: subgraphName,
+                ipfs_hash: subgraphIpfsHash,
+                version_label: versionLabel,
+                debug_fork: debugFork,
+            }, async (
+            // @ts-expect-error TODO: why are the arguments not typed?
+            requestError, 
+            // @ts-expect-error TODO: why are the arguments not typed?
+            jsonRpcError, 
+            // @ts-expect-error TODO: why are the arguments not typed?
+            res) => {
+                deployDebugger('requestError: %O', requestError);
+                deployDebugger('jsonRpcError: %O', jsonRpcError);
+                if (jsonRpcError) {
+                    const message = jsonRpcError?.message || jsonRpcError?.code?.toString();
+                    deployDebugger('message: %O', message);
+                    let errorMessage = `Failed to deploy to Graph node ${requestUrl}: ${message}`;
+                    // Provide helpful advice when the subgraph has not been created yet
+                    if (message?.match(/subgraph name not found/)) {
+                        errorMessage += `
+        Make sure to create the subgraph first by running the following command:
+        $ graph create --node ${node} ${subgraphName}`;
+                    }
+                    if (message?.match(/auth failure/)) {
+                        errorMessage += '\nYou may need to authenticate first.';
+                    }
+                    spinner.fail(errorMessage);
+                    process.exit(1);
+                }
+                else if (requestError) {
+                    spinner.fail(`HTTP error deploying the subgraph ${requestError.code}`);
+                    process.exit(1);
+                }
+                else {
+                    spinner.stop();
+                    const base = requestUrl.protocol + '//' + requestUrl.hostname;
+                    let playground = res.playground;
+                    let queries = res.queries;
+                    // Add a base URL if graph-node did not return the full URL
+                    if (playground.charAt(0) === ':') {
+                        playground = base + playground;
+                    }
+                    if (queries.charAt(0) === ':') {
+                        queries = base + queries;
+                    }
+                    gluegun_1.print.success(`Deployed to ${playground}`);
+                    gluegun_1.print.info('\nSubgraph endpoints:');
+                    gluegun_1.print.info(`Queries (HTTP):     ${queries}`);
+                    gluegun_1.print.info(``);
+                    process.exit(0);
+                }
+            });
+            return;
+        }
         const subgraphName = subgraphNameArg ||
             (await core_1.ux.prompt('What is the subgraph name?', {
                 required: true,
             }));
+        // We are given a node URL, so we prioritize that over the product flag
+        const product = nodeFlag
+            ? productFlag
+            : studio
+                ? 'subgraph-studio'
+                : productFlag ||
+                    (await gluegun_1.prompt
+                        .ask([
+                        {
+                            name: 'product',
+                            message: 'Which product to deploy for?',
+                            required: true,
+                            type: 'select',
+                            choices: productOptions,
+                        },
+                    ])
+                        .then(({ product }) => product));
+        if (product === 'hosted-service') {
+            this.error('✖ The hosted service is deprecated', { exit: 1 });
+        }
         const { node } = (0, node_1.chooseNodeUrl)({
+            product,
+            studio,
             node: nodeFlag,
         });
         if (!node) {
             // shouldn't happen, but we do the check to satisfy TS
             this.error('No Graph node provided');
         }
+        const isStudio = node.match(/studio/);
+        const isHostedService = node.match(/thegraph.com/) && !isStudio;
         const requestUrl = new url_1.URL(node);
         const client = (0, jsonrpc_1.createJsonRpcClient)(requestUrl);
         // Exit with an error code if the client couldn't be created
@@ -85,9 +213,11 @@ class DeployCommand extends core_1.Command {
         }
         // Ask for label if not on hosted service
         let versionLabel = versionLabelFlag;
-        versionLabel || (versionLabel = await core_1.ux.prompt('Which version label to use? (e.g. "v0.0.1")', {
-            required: true,
-        }));
+        if (!versionLabel && !isHostedService) {
+            versionLabel = await core_1.ux.prompt('Which version label to use? (e.g. "v0.0.1")', {
+                required: true,
+            });
+        }
         const deploySubgraph = async (ipfsHash) => {
             const spinner = gluegun_1.print.spin(`Deploying to Graph node ${requestUrl}`);
             client.request('subgraph_deploy', {
@@ -108,6 +238,18 @@ class DeployCommand extends core_1.Command {
                     const message = jsonRpcError?.message || jsonRpcError?.code?.toString();
                     deployDebugger('message: %O', message);
                     let errorMessage = `Failed to deploy to Graph node ${requestUrl}: ${message}`;
+                    // Provide helpful advice when the subgraph has not been created yet
+                    if (message?.match(/subgraph name not found/)) {
+                        if (isHostedService) {
+                            errorMessage +=
+                                '\nYou may need to create it at https://thegraph.com/explorer/dashboard.';
+                        }
+                        else {
+                            errorMessage += `
+      Make sure to create the subgraph first by running the following command:
+      $ graph create --node ${node} ${subgraphName}`;
+                        }
+                    }
                     if (message?.match(/auth failure/)) {
                         errorMessage += '\nYou may need to authenticate first.';
                     }
@@ -130,7 +272,12 @@ class DeployCommand extends core_1.Command {
                     if (queries.charAt(0) === ':') {
                         queries = base + queries;
                     }
-                    gluegun_1.print.success(`Deployed to ${playground}`);
+                    if (isHostedService) {
+                        gluegun_1.print.success(`Deployed to https://thegraph.com/explorer/subgraph/${subgraphName}`);
+                    }
+                    else {
+                        gluegun_1.print.success(`Deployed to ${playground}`);
+                    }
                     gluegun_1.print.info('\nSubgraph endpoints:');
                     gluegun_1.print.info(`Queries (HTTP):     ${queries}`);
                     gluegun_1.print.info(``);
@@ -224,6 +371,14 @@ DeployCommand.flags = {
     help: core_1.Flags.help({
         char: 'h',
     }),
+    product: core_1.Flags.string({
+        summary: 'Select a product for which to authenticate.',
+        options: productOptions,
+    }),
+    studio: core_1.Flags.boolean({
+        summary: 'Shortcut for "--product subgraph-studio".',
+        exclusive: ['product'],
+    }),
     node: core_1.Flags.string({
         summary: 'Graph node for which to initialize.',
         char: 'g',
@@ -271,9 +426,13 @@ DeployCommand.flags = {
     network: core_1.Flags.string({
         summary: 'Network configuration to use from the networks config file.',
     }),
+    // TODO: should be networksFile (with an "s"), or?
     'network-file': core_1.Flags.file({
         summary: 'Networks config file path.',
         default: 'networks.json',
     }),
+    'from-hosted-service': core_1.Flags.string({
+        summary: 'Hosted service Subgraph Name to deploy to studio.',
+    }),
 };
 exports.default = DeployCommand;

package/dist/commands/init.d.ts

@@ -8,7 +8,10 @@ export default class InitCommand extends Command {
     static flags: {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         protocol: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        product: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        studio: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         node: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'allow-simple-name': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'from-contract': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'from-example': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'contract-name': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;

package/dist/commands/init.js

@@ -88,10 +88,17 @@ const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum-gravatar';
 class InitCommand extends core_1.Command {
     async run() {
         const { args: { subgraphName, directory }, flags, } = await this.parse(InitCommand);
-        const { protocol, node: nodeFlag, 'from-contract': fromContract, 'contract-name': contractName, 'from-example': fromExample, 'index-events': indexEvents, 'skip-install': skipInstall, 'skip-git': skipGit, network, abi: abiPath, 'start-block': startBlock, spkg: spkgPath, } = flags;
+        const { protocol, product, studio, node: nodeFlag, 'allow-simple-name': allowSimpleNameFlag, 'from-contract': fromContract, 'contract-name': contractName, 'from-example': fromExample, 'index-events': indexEvents, 'skip-install': skipInstall, 'skip-git': skipGit, network, abi: abiPath, 'start-block': startBlock, spkg: spkgPath, } = flags;
         initDebugger('Flags: %O', flags);
-        let { node } = (0, node_1.chooseNodeUrl)({
+        if (product === 'hosted-service') {
+            this.error('✖ The hosted service is deprecated', { exit: 1 });
+        }
+        let { node, allowSimpleName } = (0, node_1.chooseNodeUrl)({
+            product,
+            // if we are loading example, we want to ensure we are using studio
+            studio: studio || fromExample !== undefined,
             node: nodeFlag,
+            allowSimpleName: allowSimpleNameFlag,
         });
         if (fromContract && fromExample) {
             this.error('Only one of "--from-example" and "--from-contract" can be used at a time.', {
@@ -124,6 +131,7 @@ class InitCommand extends core_1.Command {
         if (fromExample && subgraphName && directory) {
             await initSubgraphFromExample.bind(this)({
                 fromExample,
+                allowSimpleName,
                 directory,
                 subgraphName,
                 skipInstall,
@@ -169,6 +177,7 @@ class InitCommand extends core_1.Command {
             await initSubgraphFromContract.bind(this)({
                 protocolInstance,
                 abi,
+                allowSimpleName,
                 directory,
                 contract: fromContract,
                 indexEvents,
@@ -186,6 +195,7 @@ class InitCommand extends core_1.Command {
         }
         if (fromExample) {
             const answers = await processFromExampleInitForm.bind(this)({
+                allowSimpleName,
                 subgraphName,
                 directory,
             });
@@ -194,6 +204,7 @@ class InitCommand extends core_1.Command {
                 return;
             }
             await initSubgraphFromExample.bind(this)({
+                allowSimpleName,
                 fromExample,
                 subgraphName: answers.subgraphName,
                 directory: answers.directory,
@@ -205,8 +216,12 @@ class InitCommand extends core_1.Command {
             // Otherwise, take the user through the interactive form
             const answers = await processInitForm.bind(this)({
                 protocol: protocol,
+                product,
+                studio,
+                node,
                 abi,
                 abiPath,
+                allowSimpleName,
                 directory,
                 contract: fromContract,
                 indexEvents,
@@ -221,11 +236,15 @@ class InitCommand extends core_1.Command {
                 this.exit(1);
                 return;
             }
-            ({ node } = (0, node_1.chooseNodeUrl)({
+            ({ node, allowSimpleName } = (0, node_1.chooseNodeUrl)({
+                product: answers.product,
+                studio: answers.studio,
                 node,
+                allowSimpleName,
             }));
             await initSubgraphFromContract.bind(this)({
                 protocolInstance: answers.protocolInstance,
+                allowSimpleName,
                 subgraphName: answers.subgraphName,
                 directory: answers.directory,
                 abi: answers.abi,
@@ -256,10 +275,31 @@ InitCommand.flags = {
     protocol: core_1.Flags.string({
         options: protocolChoices,
     }),
+    product: core_1.Flags.string({
+        summary: 'Selects the product for which to initialize.',
+        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: core_1.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/',
+        },
+    }),
     node: core_1.Flags.string({
         summary: 'Graph node for which to initialize.',
         char: 'g',
     }),
+    'allow-simple-name': core_1.Flags.boolean({
+        description: 'Use a subgraph name without a prefix.',
+        default: false,
+        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/',
+        },
+    }),
     'from-contract': core_1.Flags.string({
         description: 'Creates a scaffold based on an existing contract.',
         exclusive: ['from-example'],
@@ -314,14 +354,31 @@ InitCommand.flags = {
     }),
 };
 exports.default = InitCommand;
-async function processFromExampleInitForm({ directory: initDirectory, subgraphName: initSubgraphName, }) {
+async function processFromExampleInitForm({ directory: initDirectory, subgraphName: initSubgraphName, allowSimpleName: initAllowSimpleName, }) {
     try {
         const { subgraphName } = await gluegun_1.prompt.ask([
             {
                 type: 'input',
                 name: 'subgraphName',
+                // TODO: is defaulting to studio ok?
                 message: () => 'Subgraph slug',
                 initial: initSubgraphName,
+                validate: name => {
+                    try {
+                        (0, subgraph_1.validateSubgraphName)(name, {
+                            allowSimpleName: initAllowSimpleName,
+                        });
+                        return true;
+                    }
+                    catch (e) {
+                        return `${e.message}
+
+    Examples:
+
+      $ graph init ${os_1.default.userInfo().username}/${name}
+      $ graph init ${name} --allow-simple-name`;
+                    }
+                },
             },
         ]);
         const { directory } = await gluegun_1.prompt.ask([
@@ -363,7 +420,7 @@ async function retryWithPrompt(func) {
     }
     return undefined;
 }
-async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath: initAbiPath, directory: initDirectory, contract: initContract, indexEvents: initIndexEvents, fromExample: initFromExample, network: initNetwork, subgraphName: initSubgraphName, contractName: initContractName, startBlock: initStartBlock, spkgPath: initSpkgPath, }) {
+async function processInitForm({ protocol: initProtocol, product: initProduct, studio: initStudio, node: initNode, abi: initAbi, abiPath: initAbiPath, directory: initDirectory, contract: initContract, indexEvents: initIndexEvents, fromExample: initFromExample, network: initNetwork, subgraphName: initSubgraphName, contractName: initContractName, startBlock: initStartBlock, allowSimpleName: initAllowSimpleName, spkgPath: initSpkgPath, }) {
     let abiFromEtherscan = undefined;
     try {
         const { protocol } = await gluegun_1.prompt.ask({
@@ -384,12 +441,60 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
         const protocolInstance = new protocols_1.default(protocol);
         const isSubstreams = protocol === 'substreams';
         initDebugger.extend('processInitForm')('isSubstreams: %O', isSubstreams);
+        const { product } = await gluegun_1.prompt.ask([
+            {
+                type: 'select',
+                name: 'product',
+                message: 'Product for which to initialize',
+                choices: ['subgraph-studio', 'hosted-service'],
+                skip: protocol === 'arweave' ||
+                    protocol === 'cosmos' ||
+                    protocol === 'near' ||
+                    initProduct === 'subgraph-studio' ||
+                    initProduct === 'hosted-service' ||
+                    initStudio !== undefined ||
+                    initNode !== undefined,
+                result: value => {
+                    if (initProduct)
+                        return initProduct;
+                    if (initStudio)
+                        return 'subgraph-studio';
+                    // For now we only support NEAR subgraphs in the Hosted Service
+                    if (protocol === 'near') {
+                        return 'hosted-service';
+                    }
+                    if (value == 'subgraph-studio') {
+                        initAllowSimpleName = true;
+                    }
+                    return value;
+                },
+            },
+        ]);
+        if (product == 'hosted-service') {
+            this.error('✖ The hosted service is deprecated', { exit: 1 });
+        }
         const { subgraphName } = await gluegun_1.prompt.ask([
             {
                 type: 'input',
                 name: 'subgraphName',
-                message: 'Subgraph slug',
+                message: () => (product == 'subgraph-studio' ? 'Subgraph slug' : 'Subgraph name'),
                 initial: initSubgraphName,
+                validate: name => {
+                    try {
+                        (0, subgraph_1.validateSubgraphName)(name, {
+                            allowSimpleName: initAllowSimpleName,
+                        });
+                        return true;
+                    }
+                    catch (e) {
+                        return `${e.message}
+
+    Examples:
+
+      $ graph init ${os_1.default.userInfo().username}/${name}
+      $ graph init ${name} --allow-simple-name`;
+                    }
+                },
             },
         ]);
         const { directory } = await gluegun_1.prompt.ask([
@@ -403,7 +508,7 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
                     : true,
             },
         ]);
-        let choices = (await AVAILABLE_NETWORKS())?.['studio'];
+        let choices = (await AVAILABLE_NETWORKS())?.[product === 'subgraph-studio' ? 'studio' : 'hostedService'];
         if (!choices) {
             this.error('Unable to fetch available networks from API. Please report this issue. As a workaround you can pass `--network` flag from the available networks: https://thegraph.com/docs/en/developing/supported-networks', { exit: 1 });
         }
@@ -591,8 +696,10 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
             protocolInstance,
             subgraphName,
             directory,
+            studio: product === 'subgraph-studio',
             startBlock,
             fromExample: !!initFromExample,
+            product,
             network,
             contractName,
             contract,
@@ -619,6 +726,21 @@ const loadAbiFromFile = (ABI, filename) => {
         return ABI.load('Contract', filename);
     }
 };
+function revalidateSubgraphName(subgraphName, { allowSimpleName }) {
+    // Fail if the subgraph name is invalid
+    try {
+        (0, subgraph_1.validateSubgraphName)(subgraphName, { allowSimpleName });
+        return true;
+    }
+    catch (e) {
+        this.error(`${e.message}
+
+  Examples:
+
+    $ graph init ${os_1.default.userInfo().username}/${subgraphName}
+    $ graph init ${subgraphName} --allow-simple-name`);
+    }
+}
 // Inspired from: https://github.com/graphprotocol/graph-tooling/issues/1450#issuecomment-1713992618
 async function isInRepo() {
     try {
@@ -684,7 +806,12 @@ Subgraph ${subgraphName} created in ${relativeDir}
 
 Make sure to visit the documentation on https://thegraph.com/docs/ for further information.`);
 }
-async function initSubgraphFromExample({ fromExample, subgraphName, directory, skipInstall, skipGit, }, { commands, }) {
+async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphName, directory, skipInstall, skipGit, }, { commands, }) {
+    // Fail if the subgraph name is invalid
+    if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
+        process.exitCode = 1;
+        return;
+    }
     // Fail if the output directory already exists
     if (gluegun_1.filesystem.exists(directory)) {
         this.error(`Directory or file "${directory}" already exists`, { exit: 1 });
@@ -777,8 +904,13 @@ async function initSubgraphFromExample({ fromExample, subgraphName, directory, s
     }
     printNextSteps.bind(this)({ subgraphName, directory }, { commands });
 }
-async function initSubgraphFromContract({ protocolInstance, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, startBlock, spkgPath, skipInstall, skipGit, }, { commands, addContract, }) {
+async function initSubgraphFromContract({ protocolInstance, allowSimpleName, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, startBlock, spkgPath, skipInstall, skipGit, }, { commands, addContract, }) {
     const isSubstreams = protocolInstance.name === 'substreams';
+    // Fail if the subgraph name is invalid
+    if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
+        this.exit(1);
+        return;
+    }
     // Fail if the output directory already exists
     if (gluegun_1.filesystem.exists(directory)) {
         this.error(`Directory or file "${directory}" already exists`, { exit: 1 });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.88.0-alpha-20241031144836-2d9c5cd",
+  "version": "0.88.0-alpha-20241031145713-add2ae3",
   "commands": {
     "add": {
       "id": "add",
@@ -77,9 +77,37 @@
           "char": "h",
           "description": "Show CLI help.",
           "allowNo": false
+        },
+        "product": {
+          "name": "product",
+          "type": "option",
+          "summary": "Select a product for which to authenticate.",
+          "multiple": false,
+          "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": {
+          "name": "studio",
+          "type": "boolean",
+          "summary": "Shortcut for \"--product subgraph-studio\".",
+          "allowNo": false,
+          "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/"
+          }
         }
       },
       "args": {
+        "node": {
+          "name": "node"
+        },
         "deploy-key": {
           "name": "deploy-key"
         }
@@ -317,6 +345,25 @@
           "description": "Show CLI help.",
           "allowNo": false
         },
+        "product": {
+          "name": "product",
+          "type": "option",
+          "summary": "Select a product for which to authenticate.",
+          "multiple": false,
+          "options": [
+            "subgraph-studio",
+            "hosted-service"
+          ]
+        },
+        "studio": {
+          "name": "studio",
+          "type": "boolean",
+          "summary": "Shortcut for \"--product subgraph-studio\".",
+          "allowNo": false,
+          "exclusive": [
+            "product"
+          ]
+        },
         "node": {
           "name": "node",
           "type": "option",
@@ -416,6 +463,12 @@
           "summary": "Networks config file path.",
           "multiple": false,
           "default": "networks.json"
+        },
+        "from-hosted-service": {
+          "name": "from-hosted-service",
+          "type": "option",
+          "summary": "Hosted service Subgraph Name to deploy to studio.",
+          "multiple": false
         }
       },
       "args": {
@@ -456,6 +509,31 @@
             "substreams"
           ]
         },
+        "product": {
+          "name": "product",
+          "type": "option",
+          "summary": "Selects the product for which to initialize.",
+          "multiple": false,
+          "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": {
+          "name": "studio",
+          "type": "boolean",
+          "summary": "Shortcut for \"--product subgraph-studio\".",
+          "allowNo": false,
+          "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/"
+          }
+        },
         "node": {
           "name": "node",
           "type": "option",
@@ -463,6 +541,15 @@
           "summary": "Graph node for which to initialize.",
           "multiple": false
         },
+        "allow-simple-name": {
+          "name": "allow-simple-name",
+          "type": "boolean",
+          "description": "Use a subgraph name without a prefix.",
+          "allowNo": false,
+          "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/"
+          }
+        },
         "from-contract": {
           "name": "from-contract",
           "type": "option",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.88.0-alpha-20241031144836-2d9c5cd",
+  "version": "0.88.0-alpha-20241031145713-add2ae3",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -23,6 +23,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",
@@ -76,8 +77,13 @@
     ],
     "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) %>."
+    }
   },
   "scripts": {
     "build": "tsc -b tsconfig.build.json && oclif manifest && oclif readme && copyfiles -u 1 src/**/*.graphql dist/",