@graphprotocol/graph-cli 0.37.3 → 0.37.4-alpha-20230117095424-b5750b1

package/src/commands/auth.ts

@@ -1,138 +0,0 @@
-import chalk from 'chalk';
-import { GluegunToolbox } from 'gluegun';
-import { saveDeployKey } from '../command-helpers/auth';
-import { fixParameters } from '../command-helpers/gluegun';
-import { chooseNodeUrl } from '../command-helpers/node';
-
-const HELP = `
-${chalk.bold('graph auth')} [options] ${chalk.bold('<node>')} ${chalk.bold('<deploy-key>')}
-
-${chalk.dim('Options:')}
-
-      --product <subgraph-studio|hosted-service>
-                                Selects the product for which to authenticate
-      --studio                  Shortcut for --product subgraph-studio
-  -h, --help                    Show usage information
-`;
-
-export interface AuthOptions {
-  product?: 'subgraph-studio' | 'hosted-service';
-  studio?: boolean;
-  help?: boolean;
-  // not a cli arg
-  node?: string;
-  deployKey?: string;
-}
-
-const processForm = async (
-  toolbox: GluegunToolbox,
-  { product, studio, node, deployKey }: AuthOptions,
-) => {
-  const questions = [
-    {
-      type: 'select',
-      name: 'product',
-      message: 'Product for which to initialize',
-      choices: ['subgraph-studio', 'hosted-service'],
-      skip:
-        product === 'subgraph-studio' ||
-        product === 'hosted-service' ||
-        studio !== undefined ||
-        node !== undefined,
-    },
-    {
-      type: 'password',
-      name: 'deployKey',
-      message: 'Deploy key',
-      skip: deployKey !== undefined,
-    },
-  ];
-
-  try {
-    const answers = await toolbox.prompt.ask(questions);
-    return answers;
-  } catch (e) {
-    return undefined;
-  }
-};
-
-export default {
-  description: 'Sets the deploy key to use when deploying to a Graph node',
-  run: async (toolbox: GluegunToolbox) => {
-    // Obtain tools
-    const { print } = toolbox;
-
-    // Read CLI parameters
-    const { product, studio, h, help } = toolbox.parameters.options;
-
-    // Show help text if requested
-    if (help || h) {
-      print.info(HELP);
-      return;
-    }
-
-    let firstParam: string, secondParam: string;
-    try {
-      [firstParam, secondParam] = fixParameters(toolbox.parameters, {
-        h,
-        help,
-        studio,
-      });
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    // if user specifies --product or --studio then deployKey is the first parameter
-    let node: string | undefined;
-    let deployKey;
-    if (product || studio) {
-      ({ node } = chooseNodeUrl({ product, studio, node }));
-      deployKey = firstParam;
-    } else {
-      node = firstParam;
-      deployKey = secondParam;
-    }
-
-    if (!node || !deployKey) {
-      const inputs = await processForm(toolbox, {
-        product,
-        studio,
-        node,
-        deployKey,
-      });
-      if (inputs === undefined) {
-        process.exit(1);
-      }
-      if (!node) {
-        ({ node } = chooseNodeUrl({
-          product: inputs.product,
-          studio,
-          node,
-        }));
-      }
-      deployKey ||= inputs.deployKey;
-    }
-
-    if (!deployKey) {
-      print.error(`No deploy key provided`);
-      print.info(HELP);
-      process.exitCode = 1;
-      return;
-    }
-    if (deployKey.length > 200) {
-      print.error(`Deploy key must not exceed 200 characters`);
-      process.exitCode = 1;
-      return;
-    }
-
-    try {
-      await saveDeployKey(node!, deployKey);
-      print.success(`Deploy key set for ${node}`);
-    } catch (e) {
-      print.error(e);
-      process.exitCode = 1;
-    }
-  },
-};

package/src/commands/binary-install-raw.d.ts

@@ -1 +0,0 @@
-declare module 'binary-install-raw';

package/src/commands/build.ts

@@ -1,147 +0,0 @@
-import chalk from 'chalk';
-import { GluegunToolbox } from 'gluegun';
-import { createCompiler } from '../command-helpers/compiler';
-import * as DataSourcesExtractor from '../command-helpers/data-sources';
-import { fixParameters } from '../command-helpers/gluegun';
-import { updateSubgraphNetwork } from '../command-helpers/network';
-import debug from '../debug';
-import Protocol from '../protocols';
-
-const buildDebug = debug('graph-cli:build');
-
-const HELP = `
-${chalk.bold('graph build')} [options] ${chalk.bold('[<subgraph-manifest>]')}
-
-Options:
-
-  -h, --help                    Show usage information
-  -i, --ipfs <node>             Upload build results to an IPFS node
-  -o, --output-dir <path>       Output directory for build results (default: build/)
-  -t, --output-format <format>  Output format for mappings (wasm, wast) (default: wasm)
-      --skip-migrations         Skip subgraph migrations (default: false)
-  -w, --watch                   Regenerate types when subgraph files change (default: false)
-      --network <name>          Network configuration to use from the networks config file
-      --network-file <path>     Networks config file path (default: "./networks.json")
-`;
-
-export interface BuildOptions {
-  help?: boolean;
-  ipfs?: string;
-  outputDir?: string;
-  outputFormat?: string;
-  skipMigrations?: boolean;
-  watch?: boolean;
-  network?: string;
-  networkFile?: string;
-}
-
-export default {
-  description: 'Builds a subgraph and (optionally) uploads it to IPFS',
-  run: async (toolbox: GluegunToolbox) => {
-    // Obtain tools
-    const { filesystem, print } = toolbox;
-
-    // Parse CLI parameters
-    let {
-      i,
-      h,
-      help,
-      ipfs,
-      o,
-      outputDir,
-      outputFormat,
-      skipMigrations,
-      t,
-      w,
-      watch,
-      network,
-      networkFile,
-    } = toolbox.parameters.options;
-
-    // Support both short and long option variants
-    help ||= h;
-    ipfs ||= i;
-    outputDir ||= o;
-    outputFormat ||= t;
-    watch ||= w;
-
-    let manifest;
-    try {
-      [manifest] = fixParameters(toolbox.parameters, {
-        h,
-        help,
-        w,
-        watch,
-      });
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    // Fall back to default values for options / parameters
-    outputFormat = outputFormat && ['wasm', 'wast'].includes(outputFormat) ? outputFormat : 'wasm';
-    outputDir = outputDir && outputDir !== '' ? outputDir : filesystem.path('build');
-    manifest =
-      manifest !== undefined && manifest !== '' ? manifest : filesystem.resolve('subgraph.yaml');
-    networkFile =
-      networkFile !== undefined && networkFile !== ''
-        ? networkFile
-        : filesystem.resolve('networks.json');
-
-    // Show help text if requested
-    if (help) {
-      print.info(HELP);
-      return;
-    }
-
-    let protocol;
-    try {
-      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
-
-      protocol = Protocol.fromDataSources(dataSourcesAndTemplates);
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    buildDebug('Detected protocol "%s" (%o)', protocol.name, protocol);
-
-    if (network && filesystem.exists(networkFile) !== 'file') {
-      print.error(`Network file '${networkFile}' does not exists or is not a file!`);
-      process.exitCode = 1;
-      return;
-    }
-
-    if (network) {
-      const identifierName = protocol.getContract()!.identifierName();
-      await updateSubgraphNetwork(toolbox, manifest, network, networkFile, identifierName);
-    }
-
-    const compiler = createCompiler(manifest, {
-      ipfs,
-      outputDir,
-      outputFormat,
-      skipMigrations,
-      protocol,
-    });
-
-    // Exit with an error code if the compiler couldn't be created
-    if (!compiler) {
-      process.exitCode = 1;
-      return;
-    }
-
-    // Watch subgraph files for changes or additions, trigger
-    // compile (if watch argument specified)
-    if (watch) {
-      await compiler.watchAndCompile();
-    } else {
-      const result = await compiler.compile();
-      if (result === false) {
-        process.exitCode = 1;
-      }
-    }
-  },
-};

package/src/commands/codegen.ts

@@ -1,123 +0,0 @@
-import path from 'path';
-import chalk from 'chalk';
-import { GluegunToolbox } from 'gluegun';
-import * as DataSourcesExtractor from '../command-helpers/data-sources';
-import { fixParameters } from '../command-helpers/gluegun';
-import { assertGraphTsVersion, assertManifestApiVersion } from '../command-helpers/version';
-import debug from '../debug';
-import Protocol from '../protocols';
-import TypeGenerator from '../type-generator';
-
-const HELP = `
-${chalk.bold('graph codegen')} [options] ${chalk.bold('[<subgraph-manifest>]')}
-Options:
-  -h, --help                    Show usage information
-  -o, --output-dir <path>       Output directory for generated types (default: generated/)
-  --skip-migrations         Skip subgraph migrations (default: false)
-  -w, --watch                   Regenerate types when subgraph files change (default: false)
-  -u, --uncrashable            Generate Float Subgraph Uncrashable helper file
-  -uc, --uncrashable-config <path>  Directory for uncrashable config (default: ./uncrashable-config.yaml)
-  `;
-
-export interface CodeGenOptions {
-  help?: boolean;
-  outputDir?: string;
-  skipMigrations?: boolean;
-  watch?: boolean;
-  uncrashable?: boolean;
-  uncrashableConfig?: string;
-}
-
-const codegenDebug = debug('graph-cli:codegen');
-
-export default {
-  description: 'Generates AssemblyScript types for a subgraph',
-  run: async (toolbox: GluegunToolbox) => {
-    // Obtain tools
-    const { filesystem, print } = toolbox;
-
-    // Read CLI parameters
-    let { h, help, o, outputDir, skipMigrations, w, watch, u, uncrashable, uc, uncrashableConfig } =
-      toolbox.parameters.options;
-
-    // Support both long and short option variants
-    help ||= h;
-    outputDir ||= o;
-    watch ||= w;
-    uncrashable ||= u;
-    let uncrashable_config = uncrashableConfig || uc;
-
-    let manifest;
-    try {
-      [manifest] = fixParameters(toolbox.parameters, {
-        h,
-        help,
-        skipMigrations,
-        w,
-        watch,
-        u,
-        uncrashable,
-      });
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    codegenDebug('Initialized codegen manifest: %o', manifest);
-
-    // Fall back to default values for options / parameters
-    outputDir =
-      outputDir !== undefined && outputDir !== '' ? outputDir : filesystem.path('generated');
-    manifest =
-      manifest !== undefined && manifest !== '' ? manifest : filesystem.resolve('subgraph.yaml');
-
-    uncrashable_config =
-      uncrashable_config !== undefined && uncrashable_config !== ''
-        ? uncrashable_config
-        : filesystem.resolve('uncrashable-config.yaml');
-
-    // Show help text if requested
-    if (help) {
-      print.info(HELP);
-      return;
-    }
-
-    let protocol;
-    try {
-      // Checks to make sure codegen doesn't run against
-      // older subgraphs (both apiVersion and graph-ts version).
-      //
-      // We don't want codegen to run without these conditions
-      // because that would mean the CLI would generate code to
-      // the wrong AssemblyScript version.
-      await assertManifestApiVersion(manifest, '0.0.5');
-      await assertGraphTsVersion(path.dirname(manifest), '0.25.0');
-
-      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
-
-      protocol = Protocol.fromDataSources(dataSourcesAndTemplates);
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    const generator = new TypeGenerator({
-      subgraphManifest: manifest,
-      outputDir,
-      skipMigrations,
-      protocol,
-      uncrashable,
-      uncrashableConfig: uncrashable_config,
-    });
-
-    // Watch working directory for file updates or additions, trigger
-    // type generation (if watch argument specified)
-    if (watch) {
-      await generator.watchAndGenerateTypes();
-    } else if (!(await generator.generateTypes())) {
-      process.exitCode = 1;
-    }
-  },
-};

package/src/commands/create.ts

@@ -1,109 +0,0 @@
-import { URL } from 'url';
-import chalk from 'chalk';
-import { GluegunToolbox } from 'gluegun';
-import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth';
-import { createJsonRpcClient } from '../command-helpers/jsonrpc';
-import { validateNodeUrl } from '../command-helpers/node';
-
-const HELP = `
-${chalk.bold('graph create')} ${chalk.dim('[options]')} ${chalk.bold('<subgraph-name>')}
-
-${chalk.dim('Options:')}
-
-      --access-token <token>    Graph access token
-  -h, --help                    Show usage information
-  -g, --node <url>              Graph node to create the subgraph in
-`;
-
-export interface CreateOptions {
-  accessToken?: string;
-  help?: boolean;
-  node?: string;
-}
-
-export default {
-  description: 'Registers a subgraph name',
-  run: async (toolbox: GluegunToolbox) => {
-    // Obtain tools
-    const { print } = toolbox;
-
-    // Read CLI parameters
-    let { accessToken, g, h, help, node } = toolbox.parameters.options;
-    const subgraphName = toolbox.parameters.first;
-
-    // Support both long and short option variants
-    node ||= g;
-    help ||= h;
-
-    // Show help text if requested
-    if (help) {
-      print.info(HELP);
-      return;
-    }
-
-    // Validate the subgraph name
-    if (!subgraphName) {
-      print.error('No subgraph name provided');
-      print.info(HELP);
-      process.exitCode = 1;
-      return;
-    }
-
-    // Validate node
-    if (!node) {
-      print.error(`No Graph node provided`);
-      print.info(HELP);
-      process.exitCode = 1;
-      return;
-    }
-    try {
-      validateNodeUrl(node);
-    } catch (e) {
-      print.error(`Graph node "${node}" is invalid: ${e.message}`);
-      process.exitCode = 1;
-      return;
-    }
-
-    const requestUrl = new URL(node);
-    const client = createJsonRpcClient(requestUrl);
-
-    // Exit with an error code if the client couldn't be created
-    if (!client) {
-      process.exitCode = 1;
-      return;
-    }
-
-    // Use the access token, if one is set
-    accessToken = await identifyAccessToken(node, accessToken);
-    if (accessToken !== undefined && accessToken !== null) {
-      // @ts-expect-error options property seems to exist
-      client.options.headers = { Authorization: `Bearer ${accessToken}` };
-    }
-
-    const spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
-    client.request(
-      'subgraph_create',
-      { name: subgraphName },
-      (
-        // @ts-expect-error TODO: why are the arguments not typed?
-        requestError,
-        // @ts-expect-error TODO: why are the arguments not typed?
-        jsonRpcError,
-        // TODO: this argument is unused, but removing it fails the basic-event-handlers tests
-        // @ts-expect-error TODO: why are the arguments not typed?
-        _res,
-      ) => {
-        if (jsonRpcError) {
-          spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`);
-          process.exitCode = 1;
-        } else if (requestError) {
-          spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`);
-          process.exitCode = 1;
-        } else {
-          spinner.stop();
-          print.success(`Created subgraph: ${subgraphName}`);
-        }
-      },
-    );
-  },
-};