@graphprotocol/graph-cli 0.58.0 → 0.58.1-alpha-20230920164910-66cee74

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @graphprotocol/graph-cli
 
+## 0.58.1-alpha-20230920164910-66cee74
+
+### Patch Changes
+
+- [#1461](https://github.com/graphprotocol/graph-tooling/pull/1461)
+  [`a95cc2e`](https://github.com/graphprotocol/graph-tooling/commit/a95cc2e7adb2216c004311d2f5996840a746f905)
+  Thanks [@saihaj](https://github.com/saihaj)! - include user agent for CLI fetch calls
+
+- [#1461](https://github.com/graphprotocol/graph-tooling/pull/1461)
+  [`66cee74`](https://github.com/graphprotocol/graph-tooling/commit/66cee7421debef12b41744a270e586786daa4286)
+  Thanks [@saihaj](https://github.com/saihaj)! - send graph cli version as user agent for all third
+  party API calls
+
+- [#1461](https://github.com/graphprotocol/graph-tooling/pull/1461)
+  [`66cee74`](https://github.com/graphprotocol/graph-tooling/commit/66cee7421debef12b41744a270e586786daa4286)
+  Thanks [@saihaj](https://github.com/saihaj)! - send graph cli version as user agent for all ipfs
+  requests
+
 ## 0.58.0
 
 ### Minor Changes

package/dist/package.json

@@ -0,0 +1,92 @@
+{
+    "name": "@graphprotocol/graph-cli",
+    "version": "0.58.1-alpha-20230920164910-66cee74",
+    "description": "CLI for building for and deploying to The Graph",
+    "license": "(Apache-2.0 OR MIT)",
+    "engines": {
+        "node": ">=14"
+    },
+    "bin": {
+        "graph": "bin/run"
+    },
+    "main": "dist/index.js",
+    "files": [
+        "CHANGELOG.md",
+        "bin",
+        "dist",
+        "oclif.manifest.json",
+        "README.md",
+        "!dist/*.tar.gz"
+    ],
+    "scripts": {
+        "build": "tsc -b tsconfig.build.json && oclif manifest && oclif readme && copyfiles -u 1 src/**/*.graphql dist/",
+        "oclif:pack": "npm pack && pnpm oclif pack tarballs --no-xz && node scripts/rename-tarballs.mjs",
+        "test": "jest --verbose",
+        "test:add": "jest tests/cli/add.test.ts --verbose",
+        "test:init": "jest tests/cli/init.test.ts --verbose",
+        "test:validation": "jest tests/cli/validation.test.ts --verbose",
+        "type-check": "tsc --noEmit"
+    },
+    "dependencies": {
+        "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
+        "@oclif/core": "2.8.6",
+        "@oclif/plugin-autocomplete": "^2.3.6",
+        "@oclif/plugin-not-found": "^2.4.0",
+        "@whatwg-node/fetch": "^0.8.4",
+        "assemblyscript": "0.19.23",
+        "binary-install-raw": "0.0.13",
+        "chalk": "3.0.0",
+        "chokidar": "3.5.3",
+        "debug": "4.3.4",
+        "docker-compose": "0.23.19",
+        "dockerode": "2.5.8",
+        "fs-extra": "9.1.0",
+        "glob": "9.3.5",
+        "gluegun": "5.1.2",
+        "graphql": "15.5.0",
+        "immutable": "4.2.1",
+        "ipfs-http-client": "55.0.0",
+        "jayson": "4.0.0",
+        "js-yaml": "3.14.1",
+        "prettier": "1.19.1",
+        "request": "2.88.2",
+        "semver": "7.4.0",
+        "sync-request": "6.1.0",
+        "tmp-promise": "3.0.3",
+        "web3-eth-abi": "1.7.0",
+        "which": "2.0.2",
+        "yaml": "1.10.2"
+    },
+    "devDependencies": {
+        "@types/debug": "^4.1.7",
+        "@types/fs-extra": "^9.0.13",
+        "@types/jest": "^29.0.0",
+        "@types/js-yaml": "^3.12.7",
+        "@types/semver": "^7.3.13",
+        "@types/which": "^2.0.1",
+        "copyfiles": "^2.4.1",
+        "jest": "29.5.0",
+        "oclif": "3.8.1",
+        "spawn-command": "0.0.2-1",
+        "strip-ansi": "6.0.1",
+        "tern": "0.24.3",
+        "typescript": "^5.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "oclif": {
+        "bin": "graph",
+        "commands": "./dist/commands",
+        "additionalHelpFlags": [
+            "-h"
+        ],
+        "additionalVersionFlags": [
+            "-v"
+        ],
+        "plugins": [
+            "@oclif/plugin-not-found",
+            "@oclif/plugin-autocomplete"
+        ]
+    }
+}

package/dist/{command-helpers → src/command-helpers}/abi.js

@@ -5,11 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadAbiFromBlockScout = exports.getStartBlockForContract = exports.fetchTransactionByHashFromRPC = exports.fetchContractCreationHashWithRetry = exports.fetchDeployContractTransactionFromEtherscan = exports.loadStartBlockForContract = exports.loadAbiFromEtherscan = void 0;
 const immutable_1 = __importDefault(require("immutable"));
-const fetch_1 = require("@whatwg-node/fetch");
+const constants_1 = require("../constants");
+const fetch_1 = __importDefault(require("../fetch"));
 const spinner_1 = require("./spinner");
 const loadAbiFromEtherscan = async (ABICtor, network, address) => await (0, spinner_1.withSpinner)(`Fetching ABI from Etherscan`, `Failed to fetch ABI from Etherscan`, `Warnings while fetching ABI from Etherscan`, async () => {
     const scanApiUrl = getEtherscanLikeAPIUrl(network);
-    const result = await (0, fetch_1.fetch)(`${scanApiUrl}?module=contract&action=getabi&address=${address}`);
+    const result = await (0, fetch_1.default)(`${scanApiUrl}?module=contract&action=getabi&address=${address}`);
     const json = await result.json();
     // Etherscan returns a JSON object that has a `status`, a `message` and
     // a `result` field. The `status` is '0' in case of errors and '1' in
@@ -37,7 +38,7 @@ const fetchContractCreationHashWithRetry = async (url, retryCount) => {
     let json;
     for (let i = 0; i < retryCount; i++) {
         try {
-            const result = await (0, fetch_1.fetch)(url);
+            const result = await (0, fetch_1.default)(url);
             json = await result.json();
             if (json.status !== '0') {
                 return json;
@@ -57,10 +58,11 @@ const fetchTransactionByHashFromRPC = async (network, transactionHash) => {
         const RPCURL = getPublicRPCEndpoint(network);
         if (!RPCURL)
             throw new Error(`Unable to fetch RPC URL for ${network}`);
-        const result = await (0, fetch_1.fetch)(String(RPCURL), {
+        const result = await (0, fetch_1.default)(String(RPCURL), {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
             },
             body: JSON.stringify({
                 jsonrpc: '2.0',
@@ -89,7 +91,7 @@ const getStartBlockForContract = async (network, address) => {
 };
 exports.getStartBlockForContract = getStartBlockForContract;
 const loadAbiFromBlockScout = async (ABICtor, network, address) => await (0, spinner_1.withSpinner)(`Fetching ABI from BlockScout`, `Failed to fetch ABI from BlockScout`, `Warnings while fetching ABI from BlockScout`, async () => {
-    const result = await (0, fetch_1.fetch)(`https://blockscout.com/${network.replace('-', '/')}/api?module=contract&action=getabi&address=${address}`);
+    const result = await (0, fetch_1.default)(`https://blockscout.com/${network.replace('-', '/')}/api?module=contract&action=getabi&address=${address}`);
     const json = await result.json();
     // BlockScout returns a JSON object that has a `status`, a `message` and
     // a `result` field. The `status` is '0' in case of errors and '1' in

package/dist/{command-helpers → src/command-helpers}/compiler.js

@@ -31,6 +31,7 @@ const url_1 = require("url");
 const toolbox = __importStar(require("gluegun"));
 const ipfs_http_client_1 = require("ipfs-http-client");
 const compiler_1 = __importDefault(require("../compiler"));
+const constants_1 = require("../constants");
 /**
  * Appends /api/v0 to the end of a The Graph IPFS URL
  */
@@ -61,7 +62,13 @@ The IPFS URL must be of the following format: http(s)://host[:port]/[path]`);
     }
     // Connect to the IPFS node (if a node address was provided)
     const ipfsClient = ipfs
-        ? (0, ipfs_http_client_1.create)({ url: appendApiVersionForGraph(ipfs.toString()), headers })
+        ? (0, ipfs_http_client_1.create)({
+            url: appendApiVersionForGraph(ipfs.toString()),
+            headers: {
+                ...headers,
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+            },
+        })
         : undefined;
     return new compiler_1.default({
         ipfs: ipfsClient,

package/dist/{command-helpers → src/command-helpers}/node.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHostedServiceSubgraphId = exports.chooseNodeUrl = exports.normalizeNodeUrl = exports.validateNodeUrl = 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/';
 const HOSTED_SERVICE_URL = 'https://api.thegraph.com/deploy/';
 const HOSTED_SERVICE_INDEX_NODE_URL = 'https://api.thegraph.com/index-node/graphql';
@@ -58,7 +59,7 @@ async function getHostedServiceSubgraphId({ subgraphName, }) {
         }),
         headers: {
             'content-type': 'application/json',
-            'User-Agent': '@graphprotocol/graph-cli',
+            ...constants_1.GRAPH_CLI_SHARED_HEADERS,
         },
     });
     const { data, errors } = await response.json();

package/dist/{commands → src/commands}/create.js

@@ -6,6 +6,7 @@ const core_1 = require("@oclif/core");
 const auth_1 = require("../command-helpers/auth");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const node_1 = require("../command-helpers/node");
+const constants_1 = require("../constants");
 class CreateCommand extends core_1.Command {
     async run() {
         const { args: { 'subgraph-name': subgraphName }, flags: { 'access-token': accessTokenFlag, node }, } = await this.parse(CreateCommand);
@@ -26,7 +27,10 @@ class CreateCommand extends core_1.Command {
         const accessToken = await (0, auth_1.identifyDeployKey)(node, accessTokenFlag);
         if (accessToken !== undefined && accessToken !== null) {
             // @ts-expect-error options property seems to exist
-            client.options.headers = { Authorization: `Bearer ${accessToken}` };
+            client.options.headers = {
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                Authorization: `Bearer ${accessToken}`,
+            };
         }
         const spinner = gluegun_1.print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
         client.request('subgraph_create', { name: subgraphName }, (

package/dist/{commands → src/commands}/deploy.js

@@ -40,6 +40,7 @@ const network_1 = require("../command-helpers/network");
 const node_1 = require("../command-helpers/node");
 const studio_1 = require("../command-helpers/studio");
 const version_1 = require("../command-helpers/version");
+const constants_1 = require("../constants");
 const protocols_1 = __importDefault(require("../protocols"));
 const headersFlag = core_1.Flags.custom({
     summary: 'Add custom headers that will be used by the IPFS HTTP client.',
@@ -86,7 +87,10 @@ class DeployCommand extends core_1.Command {
                 this.error('No deploy key available');
             }
             // @ts-expect-error options property seems to exist
-            client.options.headers = { Authorization: 'Bearer ' + deployKey };
+            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,
             });
@@ -194,7 +198,10 @@ class DeployCommand extends core_1.Command {
         deployKey = await (0, auth_1.identifyDeployKey)(node, deployKey);
         if (deployKey !== undefined && deployKey !== null) {
             // @ts-expect-error options property seems to exist
-            client.options.headers = { Authorization: 'Bearer ' + deployKey };
+            client.options.headers = {
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                Authorization: 'Bearer ' + deployKey,
+            };
         }
         // Ask for label if not on hosted service
         let versionLabel = versionLabelFlag;
@@ -271,7 +278,10 @@ class DeployCommand extends core_1.Command {
             // Connect to the IPFS node (if a node address was provided)
             const ipfsClient = (0, ipfs_http_client_1.create)({
                 url: (0, compiler_1.appendApiVersionForGraph)(ipfs.toString()),
-                headers,
+                headers: {
+                    ...headers,
+                    ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                },
             });
             // Fetch the manifest from IPFS
             const manifestBuffer = ipfsClient.cat(ipfsHash);

package/dist/{commands → src/commands}/remove.js

@@ -6,6 +6,7 @@ const core_1 = require("@oclif/core");
 const auth_1 = require("../command-helpers/auth");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const node_1 = require("../command-helpers/node");
+const constants_1 = require("../constants");
 class RemoveCommand extends core_1.Command {
     async run() {
         const { args: { 'subgraph-name': subgraphName }, flags: { 'access-token': accessTokenFlag, node }, } = await this.parse(RemoveCommand);
@@ -26,7 +27,10 @@ class RemoveCommand extends core_1.Command {
         const accessToken = await (0, auth_1.identifyDeployKey)(node, accessTokenFlag);
         if (accessToken !== undefined && accessToken !== null) {
             // @ts-expect-error options property seems to exist
-            client.options.headers = { Authorization: `Bearer ${accessToken}` };
+            client.options.headers = {
+                ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+                Authorization: `Bearer ${accessToken}`,
+            };
         }
         const spinner = gluegun_1.print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
         client.request('subgraph_remove', { name: subgraphName }, (

package/dist/{commands → src/commands}/test.js

@@ -11,7 +11,8 @@ const gluegun_1 = require("gluegun");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const semver_1 = __importDefault(require("semver"));
 const core_1 = require("@oclif/core");
-const fetch_1 = require("@whatwg-node/fetch");
+const constants_1 = require("../constants");
+const fetch_1 = __importDefault(require("../fetch"));
 class TestCommand extends core_1.Command {
     async run() {
         const { args: { datasource }, flags: { coverage, docker, force, logs, recompile, version }, } = await this.parse(TestCommand);
@@ -48,9 +49,9 @@ class TestCommand extends core_1.Command {
         // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
         if (opts.force || (!opts.version && !opts.latestVersion)) {
             this.log('Fetching latest version tag...');
-            const result = await (0, fetch_1.fetch)('https://api.github.com/repos/LimeChain/matchstick/releases/latest', {
+            const result = await (0, fetch_1.default)('https://api.github.com/repos/LimeChain/matchstick/releases/latest', {
                 headers: {
-                    'User-Agent': '@graphprotocol/graph-cli',
+                    ...constants_1.GRAPH_CLI_SHARED_HEADERS,
                 },
             });
             const json = await result.json();
@@ -270,7 +271,7 @@ async function dockerfile(dockerfilePath, versionOpt, latestVersion) {
     const spinner = gluegun_1.print.spin('Generating Dockerfile...');
     try {
         // Fetch the Dockerfile template content from the demo-subgraph repo
-        const content = await (0, fetch_1.fetch)('https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile').then(response => {
+        const content = await (0, fetch_1.default)('https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile').then(response => {
             if (response.ok) {
                 return response.text();
             }

package/dist/src/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const GRAPH_CLI_SHARED_HEADERS: {
+    'User-Agent': `@graphprotocol/graph-cli@${string}`;
+};

package/dist/src/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GRAPH_CLI_SHARED_HEADERS = void 0;
+const package_json_1 = require("../package.json");
+exports.GRAPH_CLI_SHARED_HEADERS = {
+    'User-Agent': `@graphprotocol/graph-cli@${package_json_1.version}`,
+};

package/dist/src/fetch.d.ts

@@ -0,0 +1,2 @@
+import { fetch } from '@whatwg-node/fetch';
+export default function fetchWrapper(input: Parameters<typeof fetch>[0], init?: Parameters<typeof fetch>[1]): Promise<Response>;

package/dist/src/fetch.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line no-restricted-imports
+const fetch_1 = require("@whatwg-node/fetch");
+const constants_1 = require("./constants");
+function fetchWrapper(input, init) {
+    return (0, fetch_1.fetch)(input, {
+        ...init,
+        headers: {
+            ...init?.headers,
+            ...constants_1.GRAPH_CLI_SHARED_HEADERS,
+        },
+    });
+}
+exports.default = fetchWrapper;