@graphprotocol/graph-cli 0.54.0 → 0.55.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @graphprotocol/graph-cli
 
+## 0.55.0
+
+### Minor Changes
+
+- [#1419](https://github.com/graphprotocol/graph-tooling/pull/1419)
+  [`e88ff02`](https://github.com/graphprotocol/graph-tooling/commit/e88ff02cd236f6c556afd99cecb00b6cffd738ed)
+  Thanks [@saihaj](https://github.com/saihaj)! - Introduce `--from-hosted-service` flag which will
+  make it easier to deploy subgraphs from hosted service to Studio.
+
+- [#1418](https://github.com/graphprotocol/graph-tooling/pull/1418)
+  [`38c16be`](https://github.com/graphprotocol/graph-tooling/commit/38c16be4ed865bec12a4db63b219dba058f06e72)
+  Thanks [@uF4No](https://github.com/uF4No)! - feat: adds zksync era testnet
+
 ## 0.54.0
 
 ### Minor Changes

package/dist/command-helpers/abi.js

@@ -150,6 +150,8 @@ const getEtherscanLikeAPIUrl = (network) => {
             return `https://api-testnet.ftmscan.com/api`;
         case 'zksync-era':
             return `https://block-explorer-api.mainnet.zksync.io/api`;
+        case 'zksync-era-testnet':
+            return `https://block-explorer-api.testnets.zksync.dev/api`;
         case 'polygon-zkevm-testnet':
             return `https://testnet-zkevm.polygonscan.com/api`;
         case 'polygon-zkevm':
@@ -225,7 +227,9 @@ const getPublicRPCEndpoint = (network) => {
         case 'rinkeby':
             return 'https://rpc.ankr.com/eth_rinkeby';
         case 'zksync-era':
-            return 'https://zksync2-mainnet.zksync.io';
+            return 'https://mainnet.era.zksync.io';
+        case 'zksync-era-testnet':
+            return 'https://testnet.era.zksync.dev';
         case 'sepolia':
             return 'https://rpc.ankr.com/eth_sepolia';
         default:

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

@@ -11,3 +11,10 @@ export declare function chooseNodeUrl({ product, studio, node, allowSimpleName,
     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,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = void 0;
+exports.getHostedServiceSubgraphId = exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = void 0;
 const url_1 = require("url");
 const gluegun_1 = require("gluegun");
 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';
 const validateNodeUrl = (node) => new url_1.URL(node);
 exports.validateNodeUrl = validateNodeUrl;
 const normalizeNodeUrl = (node) => new url_1.URL(node).toString();
@@ -38,3 +39,35 @@ function chooseNodeUrl({ product, studio, node, allowSimpleName, }) {
     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',
+            'User-Agent': '@graphprotocol/graph-cli',
+        },
+    });
+    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/studio.d.ts

@@ -1,4 +1,4 @@
-export declare const allowedStudioNetworks: readonly ["mainnet", "rinkeby", "goerli", "gnosis", "chapel", "optimism-goerli", "clover", "fantom", "matic", "fantom-testnet", "arbitrum-goerli", "fuji", "celo-alfajores", "mumbai", "aurora-testnet", "near-testnet", "optimism", "optimism-goerli", "theta-testnet-001", "osmo-test-4", "base-testnet", "base", "celo", "arbitrum-one", "avalanche", "zksync-era", "sepolia", "polygon-zkevm-testnet", "polygon-zkevm"];
+export declare const allowedStudioNetworks: readonly ["mainnet", "rinkeby", "goerli", "gnosis", "chapel", "optimism-goerli", "clover", "fantom", "matic", "fantom-testnet", "arbitrum-goerli", "fuji", "celo-alfajores", "mumbai", "aurora-testnet", "near-testnet", "optimism", "optimism-goerli", "theta-testnet-001", "osmo-test-4", "base-testnet", "base", "celo", "arbitrum-one", "avalanche", "zksync-era", "zksync-era-testnet", "sepolia", "polygon-zkevm-testnet", "polygon-zkevm"];
 export declare const validateStudioNetwork: ({ studio, product, network, }: {
     studio?: string | boolean | undefined;
     product?: string | undefined;

package/dist/command-helpers/studio.js

@@ -28,6 +28,7 @@ exports.allowedStudioNetworks = [
     'arbitrum-one',
     'avalanche',
     'zksync-era',
+    'zksync-era-testnet',
     'sepolia',
     'polygon-zkevm-testnet',
     'polygon-zkevm',

package/dist/commands/deploy.d.ts

@@ -22,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

@@ -50,7 +50,103 @@ const headersFlag = core_1.Flags.custom({
 const productOptions = ['subgraph-studio', 'hosted-service'];
 class DeployCommand extends core_1.Command {
     async run() {
-        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, }, } = 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 = { 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) => {
+                if (jsonRpcError) {
+                    let errorMessage = `Failed to deploy to Graph node ${requestUrl}: ${jsonRpcError.message}`;
+                    // Provide helpful advice when the subgraph has not been created yet
+                    if (jsonRpcError.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 (jsonRpcError.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,
@@ -329,5 +425,8 @@ DeployCommand.flags = {
         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/protocols/index.js

@@ -121,6 +121,7 @@ class Protocol {
                 'base-testnet',
                 'base',
                 'zksync-era',
+                'zksync-era-testnet',
                 'sepolia',
                 'polygon-zkevm-testnet',
                 'polygon-zkevm',

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.54.0",
+  "version": "0.55.0",
   "commands": {
     "add": {
       "id": "add",
@@ -451,6 +451,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": {
@@ -628,6 +634,7 @@
             "base-testnet",
             "base",
             "zksync-era",
+            "zksync-era-testnet",
             "sepolia",
             "polygon-zkevm-testnet",
             "polygon-zkevm",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.54.0",
+  "version": "0.55.0",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {