@graphprotocol/graph-cli 0.37.3 → 0.37.4

package/src/command-helpers/studio.test.ts

@@ -1,84 +0,0 @@
-import { allowedStudioNetworks, validateStudioNetwork } from './studio';
-
-describe('Version Command Helpers', () => {
-  describe('validateStudioNetwork', () => {
-    describe("When it's studio", () => {
-      test("And it's Ethereum mainnet", () => {
-        expect(() =>
-          validateStudioNetwork({
-            studio: true,
-            network: 'mainnet',
-          }),
-        ).not.toThrow(
-          new Error(
-            `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-              ', ',
-            )}`,
-          ),
-        );
-      });
-
-      test("And it's Gnosis chain", () => {
-        expect(() =>
-          validateStudioNetwork({
-            studio: true,
-            network: 'gnosis',
-          }),
-        ).not.toThrow(
-          new Error(
-            `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-              ', ',
-            )}`,
-          ),
-        );
-      });
-
-      test("And it's NOT an allowed network", () => {
-        expect(() =>
-          validateStudioNetwork({
-            product: 'subgraph-studio',
-            network: 'celo',
-          }),
-        ).toThrow(
-          new Error(
-            `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-              ', ',
-            )}`,
-          ),
-        );
-      });
-    });
-
-    describe("When it's NOT studio", () => {
-      test("And it's Rinkeby", () => {
-        expect(() =>
-          validateStudioNetwork({
-            studio: false,
-            network: 'rinkeby',
-          }),
-        ).not.toThrow(
-          new Error(
-            `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-              ', ',
-            )}`,
-          ),
-        );
-      });
-
-      test("And it's NOT an allowed network", () => {
-        expect(() =>
-          validateStudioNetwork({
-            product: 'hosted-service',
-            network: 'celo',
-          }),
-        ).not.toThrow(
-          new Error(
-            `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-              ', ',
-            )}`,
-          ),
-        );
-      });
-    });
-  });
-});

package/src/command-helpers/studio.ts

@@ -1,25 +0,0 @@
-export const allowedStudioNetworks = ['mainnet', 'rinkeby', 'goerli', 'gnosis'] as const;
-
-export const validateStudioNetwork = ({
-  studio,
-  product,
-  network,
-}: {
-  studio?: string | boolean;
-  product?: string;
-  network: string;
-}) => {
-  const isStudio = studio || product === 'subgraph-studio';
-  const isAllowedNetwork = allowedStudioNetworks.includes(
-    // @ts-expect-error we're checking if the network is allowed
-    network,
-  );
-
-  if (isStudio && !isAllowedNetwork) {
-    throw new Error(
-      `The Subgraph Studio only allows subgraphs for these networks: ${allowedStudioNetworks.join(
-        ', ',
-      )}`,
-    );
-  }
-};

package/src/command-helpers/subgraph.ts

@@ -1,21 +0,0 @@
-export const validateSubgraphName = (
-  name: string,
-  { allowSimpleName }: { allowSimpleName?: boolean },
-) => {
-  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.`);
-  }
-};
-
-export const getSubgraphBasename = (name: string) => {
-  const segments = name.split('/', 2);
-  return segments[segments.length - 1];
-};

package/src/command-helpers/version.test.ts

@@ -1,241 +0,0 @@
-import * as loadManifestUtil from '../migrations/util/load-manifest';
-import * as graphTsUtil from '../migrations/util/versions';
-import { assertGraphTsVersion, assertManifestApiVersion } from './version';
-
-describe('Version Command Helpers', () => {
-  describe('assertManifestApiVersion', () => {
-    const fakeManifestPath = 'fake/manifest/path';
-    const minimumApiVersion = '0.0.5';
-
-    describe('With just dataSources', () => {
-      test('When all of them are less than minimum apiVersion', async () => {
-        // @ts-expect-error TODO: dont pollute the globals
-        loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-          Promise.resolve({
-            dataSources: [
-              { mapping: { apiVersion: '0.0.1' } },
-              { mapping: { apiVersion: '0.0.2' } },
-              { mapping: { apiVersion: '0.0.3' } },
-            ],
-          }),
-        );
-
-        await expect(assertManifestApiVersion(fakeManifestPath, minimumApiVersion)).rejects.toThrow(
-          new Error(
-            `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-          ),
-        );
-      });
-      test('When one of them is less than minimum apiVersion', async () => {
-        // @ts-expect-error TODO: dont pollute the globals
-        loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-          Promise.resolve({
-            dataSources: [
-              { mapping: { apiVersion: '0.0.5' } },
-              { mapping: { apiVersion: '0.0.2' } },
-              { mapping: { apiVersion: '0.0.5' } },
-            ],
-          }),
-        );
-
-        await expect(assertManifestApiVersion(fakeManifestPath, minimumApiVersion)).rejects.toThrow(
-          new Error(
-            `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-          ),
-        );
-      });
-      test('When none of them are less than minimum apiVersion', async () => {
-        // @ts-expect-error TODO: dont pollute the globals
-        loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-          Promise.resolve({
-            dataSources: [
-              { mapping: { apiVersion: '0.0.5' } },
-              { mapping: { apiVersion: '0.0.6' } },
-              { mapping: { apiVersion: '0.0.5' } },
-            ],
-          }),
-        );
-
-        await expect(assertManifestApiVersion(fakeManifestPath, minimumApiVersion)).resolves.toBe(
-          undefined,
-        );
-      });
-    });
-    describe('With dataSources and templates', () => {
-      describe('And the dataSources have a lower apiVersion', () => {
-        test('When all of the templates are less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.3' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.1' } },
-                { mapping: { apiVersion: '0.0.2' } },
-                { mapping: { apiVersion: '0.0.3' } },
-              ],
-            }),
-          );
-
-          await expect(
-            assertManifestApiVersion(fakeManifestPath, minimumApiVersion),
-          ).rejects.toThrow(
-            new Error(
-              `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-            ),
-          );
-        });
-        test('When one of the templates is less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.3' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.2' } },
-                { mapping: { apiVersion: '0.0.5' } },
-              ],
-            }),
-          );
-
-          await expect(
-            assertManifestApiVersion(fakeManifestPath, minimumApiVersion),
-          ).rejects.toThrow(
-            new Error(
-              `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-            ),
-          );
-        });
-        test('When none of the templates are less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.3' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.6' } },
-                { mapping: { apiVersion: '0.0.5' } },
-              ],
-            }),
-          );
-
-          await expect(
-            assertManifestApiVersion(fakeManifestPath, minimumApiVersion),
-          ).rejects.toThrow(
-            new Error(
-              `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-            ),
-          );
-        });
-      });
-      describe('And the dataSources do NOT have a lower apiVersion', () => {
-        test('When all of the templates are less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.6' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.1' } },
-                { mapping: { apiVersion: '0.0.2' } },
-                { mapping: { apiVersion: '0.0.3' } },
-              ],
-            }),
-          );
-
-          await expect(
-            assertManifestApiVersion(fakeManifestPath, minimumApiVersion),
-          ).rejects.toThrow(
-            new Error(
-              `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-            ),
-          );
-        });
-        test('When one of the templates is less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.6' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.2' } },
-                { mapping: { apiVersion: '0.0.5' } },
-              ],
-            }),
-          );
-
-          await expect(
-            assertManifestApiVersion(fakeManifestPath, minimumApiVersion),
-          ).rejects.toThrow(
-            new Error(
-              `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-            ),
-          );
-        });
-        test('When none of the templates are less than minimum apiVersion', async () => {
-          // @ts-expect-error TODO: dont pollute the globals
-          loadManifestUtil.loadManifest = jest.fn().mockImplementation(() =>
-            Promise.resolve({
-              dataSources: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.6' } },
-              ],
-              templates: [
-                { mapping: { apiVersion: '0.0.5' } },
-                { mapping: { apiVersion: '0.0.6' } },
-                { mapping: { apiVersion: '0.0.5' } },
-              ],
-            }),
-          );
-
-          await expect(assertManifestApiVersion(fakeManifestPath, minimumApiVersion)).resolves.toBe(
-            undefined,
-          );
-        });
-      });
-    });
-  });
-  describe('assertGraphTsVersion', () => {
-    const fakeNodeModulesDir = 'fake/path/to/node/modules';
-    const minimumGraphTsVersion = '0.22.0';
-
-    test("When the installed graph-ts version is less than what's supported", async () => {
-      // @ts-expect-error TODO: dont pollute the globals
-      graphTsUtil.getGraphTsVersion = jest.fn().mockImplementation(() => Promise.resolve('0.19.0'));
-
-      await expect(assertGraphTsVersion(fakeNodeModulesDir, minimumGraphTsVersion)).rejects.toThrow(
-        new Error(
-          `To use this version of the graph-cli you must upgrade the graph-ts dependency to a version greater than or equal to ${minimumGraphTsVersion}
-Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://thegraph.com/docs/developer/assemblyscript-migration-guide`,
-        ),
-      );
-    });
-    test('When the installed graph-ts version is a supported one', async () => {
-      // @ts-expect-error TODO: dont pollute the globals
-      graphTsUtil.getGraphTsVersion = jest.fn().mockImplementation(() => Promise.resolve('0.22.0'));
-
-      await expect(assertGraphTsVersion(fakeNodeModulesDir, minimumGraphTsVersion)).resolves.toBe(
-        undefined,
-      );
-    });
-  });
-});

package/src/command-helpers/version.ts

@@ -1,53 +0,0 @@
-import semver from 'semver';
-import * as manifestUtil from '../migrations/util/load-manifest';
-import * as graphTsUtil from '../migrations/util/versions';
-
-export const assertManifestApiVersion = async (manifestPath: string, minimumApiVersion: string) => {
-  const manifest = await manifestUtil.loadManifest(manifestPath);
-
-  const lessThanMinimumVersion = (manifestApiVersion: string) =>
-    semver.lt(manifestApiVersion, minimumApiVersion);
-
-  let isLessThanMinimumVersion = false;
-
-  if (manifest) {
-    if (manifest.dataSources && Array.isArray(manifest.dataSources)) {
-      isLessThanMinimumVersion = manifest.dataSources.some(
-        (dataSource: any) =>
-          dataSource?.mapping?.apiVersion && lessThanMinimumVersion(dataSource.mapping.apiVersion),
-      );
-    }
-
-    if (manifest.templates && Array.isArray(manifest.templates)) {
-      isLessThanMinimumVersion ||= manifest.templates.some(
-        (template: any) =>
-          template?.mapping?.apiVersion && lessThanMinimumVersion(template.mapping.apiVersion),
-      );
-    }
-  }
-
-  if (isLessThanMinimumVersion) {
-    throw new Error(
-      `The current version of graph-cli can't be used with mappings on apiVersion less than '${minimumApiVersion}'`,
-    );
-  }
-};
-
-export const assertGraphTsVersion = async (sourceDir: string, minimumGraphTsVersion: string) => {
-  let graphTsVersion;
-  try {
-    graphTsVersion = await graphTsUtil.getGraphTsVersion(sourceDir);
-  } catch (_) {
-    // We only do the assertion if `graph-ts` is installed.
-  }
-
-  // Coerce needed because we may be dealing with an alpha version
-  // and in the `semver` library, this would return true when comparing
-  // the same version.
-  if (graphTsVersion && semver.lt(semver.coerce(graphTsVersion)!, minimumGraphTsVersion)) {
-    throw new Error(
-      `To use this version of the graph-cli you must upgrade the graph-ts dependency to a version greater than or equal to ${minimumGraphTsVersion}
-Also, you'll probably need to take a look at our AssemblyScript migration guide because of language breaking changes: https://thegraph.com/docs/developer/assemblyscript-migration-guide`,
-    );
-  }
-};

package/src/commands/add.ts

@@ -1,220 +0,0 @@
-import chalk from 'chalk';
-import { GluegunToolbox } from 'gluegun';
-import immutable from 'immutable';
-import { loadAbiFromBlockScout, loadAbiFromEtherscan } from '../command-helpers/abi';
-import * as DataSourcesExtractor from '../command-helpers/data-sources';
-import { fixParameters } from '../command-helpers/gluegun';
-import { updateNetworksFile } from '../command-helpers/network';
-import {
-  generateDataSource,
-  writeABI,
-  writeMapping,
-  writeSchema,
-  writeTestsFiles,
-} from '../command-helpers/scaffold';
-import { withSpinner } from '../command-helpers/spinner';
-import Protocol from '../protocols';
-import EthereumABI from '../protocols/ethereum/abi';
-import Subgraph from '../subgraph';
-
-const HELP = `
-${chalk.bold('graph add')} <address> [<subgraph-manifest default: "./subgraph.yaml">]
-
-${chalk.dim('Options:')}
-
-      --abi <path>              Path to the contract ABI (default: download from Etherscan)
-      --contract-name           Name of the contract (default: Contract)
-      --merge-entities          Whether to merge entities with the same name (default: false)
-      --network-file <path>     Networks config file path (default: "./networks.json")
-  -h, --help                    Show usage information
-`;
-
-export interface AddOptions {
-  abi?: string;
-  contractName?: string;
-  mergeEntities?: boolean;
-  networkFile?: string;
-  help?: boolean;
-}
-
-export default {
-  description: 'Adds a new datasource to a subgraph',
-  run: async (toolbox: GluegunToolbox) => {
-    // Obtain tools
-    const { print, system } = toolbox;
-
-    // Read CLI parameters
-    let { abi, contractName, h, help, mergeEntities, networkFile } = toolbox.parameters.options;
-
-    contractName ||= 'Contract';
-
-    try {
-      fixParameters(toolbox.parameters, {
-        h,
-        help,
-        mergeEntities,
-      });
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    const address = toolbox.parameters.first || toolbox.parameters.array?.[0];
-    const manifestPath =
-      toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml';
-
-    // Show help text if requested
-    if (help || h) {
-      print.info(HELP);
-      return;
-    }
-
-    // Validate the address
-    if (!address) {
-      print.error('No contract address provided');
-      process.exitCode = 1;
-      return;
-    }
-
-    const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath);
-    const protocol = Protocol.fromDataSources(dataSourcesAndTemplates);
-    const manifest = await Subgraph.load(manifestPath, { protocol });
-    const network = manifest.result.getIn(['dataSources', 0, 'network']) as any;
-    const result = manifest.result.asMutable();
-
-    const entities = getEntities(manifest);
-    const contractNames = getContractNames(manifest);
-    if (contractNames.includes(contractName)) {
-      print.error(
-        `Datasource or template with name ${contractName} already exists, please choose a different name`,
-      );
-      process.exitCode = 1;
-      return;
-    }
-
-    let ethabi = null;
-    if (abi) {
-      ethabi = EthereumABI.load(contractName, abi);
-    } else if (network === 'poa-core') {
-      ethabi = await loadAbiFromBlockScout(EthereumABI, network, address);
-    } else {
-      ethabi = await loadAbiFromEtherscan(EthereumABI, network, address);
-    }
-
-    const { collisionEntities, onlyCollisions, abiData } = updateEventNamesOnCollision(
-      toolbox,
-      ethabi,
-      entities,
-      contractName,
-      mergeEntities,
-    );
-    ethabi.data = abiData;
-
-    await writeABI(ethabi, contractName);
-    await writeSchema(ethabi, protocol, result.getIn(['schema', 'file']) as any, collisionEntities);
-    await writeMapping(ethabi, protocol, contractName, collisionEntities);
-    await writeTestsFiles(ethabi, protocol, contractName);
-
-    const dataSources = result.get('dataSources');
-    const dataSource = await generateDataSource(protocol, contractName, network, address, ethabi);
-
-    // Handle the collisions edge case by copying another data source yaml data
-    if (mergeEntities && onlyCollisions) {
-      const firstDataSource = dataSources.get(0);
-      const source = dataSource.get('source') as any;
-      const mapping = firstDataSource.get('mapping').asMutable();
-
-      // Save the address of the new data source
-      source.abi = firstDataSource.get('source').get('abi');
-
-      dataSource.set('mapping', mapping);
-      dataSource.set('source', source);
-    }
-
-    result.set('dataSources', dataSources.push(dataSource));
-
-    await Subgraph.write(result, manifestPath);
-
-    // Update networks.json
-    const networksFile = networkFile || './networks.json';
-    await updateNetworksFile(toolbox, network, contractName, address, networksFile);
-
-    // Detect Yarn and/or NPM
-    const yarn = system.which('yarn');
-    const npm = system.which('npm');
-    if (!yarn && !npm) {
-      print.error(`Neither Yarn nor NPM were found on your system. Please install one of them.`);
-      process.exitCode = 1;
-      return;
-    }
-
-    await withSpinner(
-      'Running codegen',
-      'Failed to run codegen',
-      'Warning during codegen',
-      async () => {
-        await system.run(yarn ? 'yarn codegen' : 'npm run codegen');
-      },
-    );
-  },
-};
-
-const getEntities = (manifest: any) => {
-  const dataSources = manifest.result.get('dataSources', immutable.List());
-  const templates = manifest.result.get('templates', immutable.List());
-
-  return dataSources
-    .concat(templates)
-    .map((dataSource: any) => dataSource.getIn(['mapping', 'entities']))
-    .flatten();
-};
-
-const getContractNames = (manifest: any) => {
-  const dataSources = manifest.result.get('dataSources', immutable.List());
-  const templates = manifest.result.get('templates', immutable.List());
-
-  return dataSources.concat(templates).map((dataSource: any) => dataSource.get('name'));
-};
-
-const updateEventNamesOnCollision = (
-  toolbox: GluegunToolbox,
-  ethabi: any,
-  entities: any,
-  contractName: string,
-  mergeEntities: boolean,
-) => {
-  let abiData = ethabi.data;
-  const { print } = toolbox;
-  const collisionEntities = [];
-  let onlyCollisions = true;
-
-  for (let i = 0; i < abiData.size; i++) {
-    const dataRow = abiData.get(i).asMutable();
-
-    if (dataRow.get('type') === 'event') {
-      if (entities.includes(dataRow.get('name'))) {
-        if (entities.includes(`${contractName}${dataRow.get('name')}`)) {
-          print.error(`Contract name ('${contractName}')
-            + event name ('${dataRow.get('name')}') entity already exists.`);
-          process.exitCode = 1;
-          break;
-        }
-
-        if (mergeEntities) {
-          collisionEntities.push(dataRow.get('name'));
-          abiData = abiData.asImmutable().delete(i); // needs to be immutable when deleting, yes you read that right - https://github.com/immutable-js/immutable-js/issues/1901
-          i--; // deletion also shifts values to the left
-          continue;
-        } else {
-          dataRow.set('name', `${contractName}${dataRow.get('name')}`);
-        }
-      } else {
-        onlyCollisions = false;
-      }
-    }
-    abiData = abiData.asMutable().set(i, dataRow);
-  }
-
-  return { abiData, collisionEntities, onlyCollisions };
-};