@graphprotocol/graph-cli 0.64.1 → 0.65.0-alpha-20240111170628-733b724

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @graphprotocol/graph-cli
 
+## 0.65.0-alpha-20240111170628-733b724
+
+### Minor Changes
+
+- [#1557](https://github.com/graphprotocol/graph-tooling/pull/1557)
+  [`d9ce44f`](https://github.com/graphprotocol/graph-tooling/commit/d9ce44f2730b56097f6accbbc4f1090327e54d89)
+  Thanks [@saihaj](https://github.com/saihaj)! - fetch supported networks from API
+
 ## 0.64.1
 
 ### Patch Changes

package/README.md

@@ -37,14 +37,26 @@ or a local directory for debugging, and deploys the subgraph to a
 
 ## Installation
 
-The Graph CLI can be installed with `npm` or `yarn`:
+We recommend install the CLI using package manager `npm` or `yarn` or `pnpm` when developing
+subgraphs locally:
 
 ```sh
 # NPM
-npm install -g @graphprotocol/graph-cli
+npm install @graphprotocol/graph-cli
 
 # Yarn
-yarn global add @graphprotocol/graph-cli
+yarn add @graphprotocol/graph-cli
+
+# pnpm
+pnpm install @graphprotocol/graph-cli
+```
+
+You can install the CLI globally using a binary. Eventually this will become the default mechanism
+for installing the CLI and building subgraphs because users do not need to install `Node.js` or any
+other external dependencies.
+
+```sh
+curl -LS https://cli.thegraph.com/install.sh | sudo sh
 ```
 
 ### On Linux

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

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 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({ product, studio, node, allowSimpleName, }: {

package/dist/command-helpers/node.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostedServiceSubgraphId = exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = 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");
-const SUBGRAPH_STUDIO_URL = 'https://api.studio.thegraph.com/deploy/';
+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);
@@ -27,7 +27,7 @@ function chooseNodeUrl({ product, studio, node, allowSimpleName, }) {
         }
         switch (product) {
             case 'subgraph-studio':
-                node = SUBGRAPH_STUDIO_URL;
+                node = exports.SUBGRAPH_STUDIO_URL;
                 break;
             case 'hosted-service':
                 node = HOSTED_SERVICE_URL;

package/dist/commands/init.js

@@ -38,15 +38,52 @@ const node_1 = require("../command-helpers/node");
 const scaffold_1 = require("../command-helpers/scaffold");
 const spinner_1 = require("../command-helpers/spinner");
 const subgraph_1 = require("../command-helpers/subgraph");
+const constants_1 = require("../constants");
 const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const schema_1 = require("../scaffold/schema");
 const validation_1 = require("../validation");
 const add_1 = __importDefault(require("./add"));
 const protocolChoices = Array.from(protocols_1.default.availableProtocols().keys());
-const availableNetworks = protocols_1.default.availableNetworks();
-const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum-gravatar';
 const initDebugger = (0, debug_1.default)('graph-cli:commands:init');
+/**
+ * a dynamic list of available networks supported by the studio
+ */
+const AVAILABLE_NETWORKS = async () => {
+    const logger = initDebugger.extend('AVAILABLE_NETWORKS');
+    try {
+        logger('fetching chain_list from studio');
+        const res = await fetch(node_1.SUBGRAPH_STUDIO_URL, {
+            method: 'POST',
+            headers: {
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                'content-type': 'application/json',
+            },
+            body: JSON.stringify({
+                jsonrpc: '2.0',
+                id: 1,
+                method: 'chain_list',
+                params: [],
+            }),
+        });
+        if (!res.ok) {
+            logger("Something went wrong while fetching 'chain_list' from studio HTTP code: %o", res.status);
+            return null;
+        }
+        const result = await res.json();
+        if (result?.result) {
+            logger('chain_list result: %o', result.result);
+            return result.result;
+        }
+        logger("Unable to get result for 'chain_list' from studio: %O", result);
+        return null;
+    }
+    catch (e) {
+        logger('error: %O', e);
+        return null;
+    }
+};
+const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum-gravatar';
 class InitCommand extends core_1.Command {
     async run() {
         const { args: { subgraphName, directory }, flags, } = await this.parse(InitCommand);
@@ -308,12 +345,8 @@ InitCommand.flags = {
     }),
     network: core_1.Flags.string({
         summary: 'Network the contract is deployed to.',
+        description: 'Check https://thegraph.com/docs/en/developing/supported-networks/ for supported networks',
         dependsOn: ['from-contract'],
-        options: [
-            ...availableNetworks.get('ethereum'),
-            ...availableNetworks.get('near'),
-            ...availableNetworks.get('cosmos'),
-        ],
     }),
 };
 exports.default = InitCommand;
@@ -468,14 +501,16 @@ async function processInitForm({ protocol: initProtocol, product: initProduct, s
                     : true,
             },
         ]);
+        const 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 });
+        }
         const { network } = await gluegun_1.prompt.ask([
             {
                 type: 'select',
                 name: 'network',
                 message: () => `${protocolInstance.displayName()} network`,
-                choices: availableNetworks
-                    .get(protocol) // Get networks related to the chosen protocol.
-                    ?.toArray() || ['mainnet'],
+                choices,
                 skip: initNetwork !== undefined,
                 result: value => {
                     if (initNetwork) {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.64.1",
+  "version": "0.65.0-alpha-20240111170628-733b724",
   "commands": {
     "add": {
       "id": "add",
@@ -632,54 +632,8 @@
           "name": "network",
           "type": "option",
           "summary": "Network the contract is deployed to.",
+          "description": "Check https://thegraph.com/docs/en/developing/supported-networks/ for supported networks",
           "multiple": false,
-          "options": [
-            "mainnet",
-            "rinkeby",
-            "goerli",
-            "poa-core",
-            "poa-sokol",
-            "gnosis",
-            "matic",
-            "mumbai",
-            "fantom",
-            "fantom-testnet",
-            "bsc",
-            "chapel",
-            "clover",
-            "avalanche",
-            "fuji",
-            "celo",
-            "celo-alfajores",
-            "fuse",
-            "moonbeam",
-            "moonriver",
-            "mbase",
-            "arbitrum-one",
-            "arbitrum-goerli",
-            "arbitrum-sepolia",
-            "optimism",
-            "optimism-goerli",
-            "aurora",
-            "aurora-testnet",
-            "base-testnet",
-            "base",
-            "zksync-era",
-            "zksync-era-testnet",
-            "sepolia",
-            "polygon-zkevm-testnet",
-            "polygon-zkevm",
-            "scroll-sepolia",
-            "scroll",
-            "near-mainnet",
-            "near-testnet",
-            "cosmoshub-4",
-            "theta-testnet-001",
-            "osmosis-1",
-            "osmo-test-4",
-            "juno-1",
-            "uni-3"
-          ],
           "dependsOn": [
             "from-contract"
           ]

package/package.json

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