@graphprotocol/graph-cli 0.89.0 → 0.90.0-alpha-20241126184316-dc0c108

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @graphprotocol/graph-cli
 
+## 0.90.0-alpha-20241126184316-dc0c108
+
+### Minor Changes
+
+- [`098b433`](https://github.com/graphprotocol/graph-tooling/commit/098b433815390e5aff2e0e52f22ab0ee44b9c206)
+  Thanks [@DenisCarriere](https://github.com/DenisCarriere)! - Update deprecated endpoints and
+  support API key for updating published subgraphs
+
+### Patch Changes
+
+- [#1767](https://github.com/graphprotocol/graph-tooling/pull/1767)
+  [`6f2cb45`](https://github.com/graphprotocol/graph-tooling/commit/6f2cb45e5a07d8de2946a485763feb0b1bcfd4f0)
+  Thanks [@0237h](https://github.com/0237h)! - Fix CLI validation for `startBlock` and
+  `contractName` fetched from external APIs
+
 ## 0.89.0
 
 ### Minor Changes

package/dist/command-helpers/abi.js

@@ -272,6 +272,12 @@ const getEtherscanLikeAPIUrl = (network) => {
             return 'https://unichain-sepolia.blockscout.com/api';
         case 'lens-testnet':
             return 'https://block-explorer-api.testnet.lens.dev/api';
+        case 'abstract-testnet':
+            return 'https://block-explorer-api.testnet.abs.xyz/api';
+        case 'corn':
+            return 'https://maizenet-explorer.usecorn.com/api';
+        case 'corn-testnet':
+            return 'https://testnet-explorer.usecorn.com/api';
         default:
             return `https://api-${network}.etherscan.io/api`;
     }
@@ -430,6 +436,12 @@ const getPublicRPCEndpoint = (network) => {
             return 'https://sepolia.unichain.org';
         case 'lens-testnet':
             return 'https://api.staging.lens.zksync.dev';
+        case 'abstract-testnet':
+            return 'https://api.testnet.abs.xyz';
+        case 'corn':
+            return 'https://maizenet-rpc.usecorn.com';
+        case 'corn-testnet':
+            return 'https://testnet-rpc.usecorn.com';
         default:
             throw new Error(`Unknown network: ${network}`);
     }

package/dist/commands/init.js

@@ -362,6 +362,8 @@ async function retryWithPrompt(func) {
 }
 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, }) {
     let abiFromEtherscan = undefined;
+    let startBlockFromEtherscan = undefined;
+    let contractNameFromEtherscan = undefined;
     try {
         const { protocol } = await gluegun_1.prompt.ask({
             type: 'select',
@@ -461,7 +463,7 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
                         // Load startBlock for this contract
                         const startBlock = await retryWithPrompt(() => (0, abi_1.loadStartBlockForContract)(network, value));
                         if (startBlock) {
-                            initStartBlock = Number(startBlock).toString();
+                            startBlockFromEtherscan = Number(startBlock).toString();
                         }
                     }
                     // If contract name is not set, try to load it.
@@ -469,7 +471,7 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
                         // Load contract name for this contract
                         const contractName = await retryWithPrompt(() => (0, abi_1.loadContractNameForAddress)(network, value));
                         if (contractName) {
-                            initContractName = contractName;
+                            contractNameFromEtherscan = contractName;
                         }
                     }
                     return value;
@@ -532,14 +534,9 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
                 type: 'input',
                 name: 'startBlock',
                 message: 'Start Block',
-                initial: initStartBlock || '0',
+                initial: initStartBlock || startBlockFromEtherscan || '0',
                 skip: () => initFromExample !== undefined || isSubstreams,
                 validate: value => parseInt(value) >= 0,
-                result(value) {
-                    if (initStartBlock)
-                        return initStartBlock;
-                    return value;
-                },
             },
         ]);
         const { contractName } = await gluegun_1.prompt.ask([
@@ -547,14 +544,9 @@ async function processInitForm({ protocol: initProtocol, abi: initAbi, abiPath:
                 type: 'input',
                 name: 'contractName',
                 message: 'Contract Name',
-                initial: initContractName || 'Contract' || isSubstreams,
+                initial: initContractName || contractNameFromEtherscan || 'Contract' || isSubstreams,
                 skip: () => initFromExample !== undefined || !protocolInstance.hasContract(),
                 validate: value => value && value.length > 0,
-                result(value) {
-                    if (initContractName)
-                        return initContractName;
-                    return value;
-                },
             },
         ]);
         const { indexEvents } = await gluegun_1.prompt.ask([

package/dist/commands/publish.d.ts

@@ -11,15 +11,17 @@ export default class PublishCommand extends Command {
         ipfs: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'ipfs-hash': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'webapp-url': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'api-key': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     /**
      * Prompt the user to open up the browser to continue publishing the subgraph
      */
-    publishWithBrowser({ ipfsHash, webapp, subgraphId, protocolNetwork, }: {
+    publishWithBrowser({ ipfsHash, webapp, subgraphId, protocolNetwork, apiKey, }: {
         ipfsHash: string;
         webapp: string;
         subgraphId: string | undefined;
         protocolNetwork: string | undefined;
+        apiKey: string | undefined;
     }): Promise<void>;
     run(): Promise<void>;
 }

package/dist/commands/publish.js

@@ -40,7 +40,7 @@ class PublishCommand extends core_1.Command {
     /**
      * Prompt the user to open up the browser to continue publishing the subgraph
      */
-    async publishWithBrowser({ ipfsHash, webapp, subgraphId, protocolNetwork, }) {
+    async publishWithBrowser({ ipfsHash, webapp, subgraphId, protocolNetwork, apiKey, }) {
         const answer = await core_1.ux.prompt(`Press ${chalk_1.default.green('y')} (or any key) to open up the browser to continue publishing or ${chalk_1.default.yellow('q')} to exit`);
         if (answer.toLowerCase() === 'q') {
             this.exit(0);
@@ -54,6 +54,9 @@ class PublishCommand extends core_1.Command {
         if (protocolNetwork) {
             searchParams.set('network', protocolNetwork);
         }
+        if (apiKey) {
+            searchParams.set('apiKey', apiKey);
+        }
         url.search = searchParams.toString();
         const openUrl = url.toString();
         gluegun_1.print.success(`Finalize the publish of the subgraph from the Graph CLI publish page. Opening up the browser to continue publishing at ${openUrl}`);
@@ -61,9 +64,18 @@ class PublishCommand extends core_1.Command {
         return;
     }
     async run() {
-        const { args: { 'subgraph-manifest': manifest }, flags: { 'ipfs-hash': ipfsHash, 'webapp-url': webUiUrl, ipfs, 'subgraph-id': subgraphId, 'protocol-network': protocolNetwork, }, } = await this.parse(PublishCommand);
+        const { args: { 'subgraph-manifest': manifest }, flags: { 'ipfs-hash': ipfsHash, 'webapp-url': webUiUrl, ipfs, 'subgraph-id': subgraphId, 'protocol-network': protocolNetwork, 'api-key': apiKey, }, } = await this.parse(PublishCommand);
+        if (subgraphId && !apiKey) {
+            core_1.ux.error('API key is required to publish to an existing subgraph (`--api-key`).\nSee https://thegraph.com/docs/en/deploying/subgraph-studio-faqs/#2-how-do-i-create-an-api-key', { exit: 1 });
+        }
         if (ipfsHash) {
-            await this.publishWithBrowser({ ipfsHash, webapp: webUiUrl, subgraphId, protocolNetwork });
+            await this.publishWithBrowser({
+                ipfsHash,
+                webapp: webUiUrl,
+                subgraphId,
+                protocolNetwork,
+                apiKey,
+            });
             return;
         }
         let protocol;
@@ -97,6 +109,7 @@ class PublishCommand extends core_1.Command {
             webapp: webUiUrl,
             subgraphId,
             protocolNetwork,
+            apiKey,
         });
         return;
     }
@@ -135,5 +148,9 @@ PublishCommand.flags = {
         required: false,
         default: 'https://cli.thegraph.com/publish',
     }),
+    'api-key': core_1.Flags.string({
+        summary: 'The API key to use for the Subgraph queries.',
+        required: false,
+    }),
 };
 exports.default = PublishCommand;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.89.0",
+  "version": "0.90.0-alpha-20241126184316-dc0c108",
   "commands": {
     "add": {
       "id": "add",
@@ -716,6 +716,13 @@
           "required": false,
           "multiple": false,
           "default": "https://cli.thegraph.com/publish"
+        },
+        "api-key": {
+          "name": "api-key",
+          "type": "option",
+          "summary": "The API key to use for the Subgraph queries.",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {

package/package.json

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