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

package/src/protocols/index.ts

@@ -1,287 +0,0 @@
-import immutable from 'immutable';
-import debug from '../debug';
-import Subgraph from '../subgraph';
-import * as ArweaveManifestScaffold from './arweave/scaffold/manifest';
-import * as ArweaveMappingScaffold from './arweave/scaffold/mapping';
-import ArweaveSubgraph from './arweave/subgraph';
-import { ContractCtor } from './contract';
-import * as CosmosManifestScaffold from './cosmos/scaffold/manifest';
-import * as CosmosMappingScaffold from './cosmos/scaffold/mapping';
-import CosmosSubgraph from './cosmos/subgraph';
-import EthereumABI from './ethereum/abi';
-import EthereumTemplateCodeGen from './ethereum/codegen/template';
-import EthereumContract from './ethereum/contract';
-import * as EthereumManifestScaffold from './ethereum/scaffold/manifest';
-import * as EthereumMappingScaffold from './ethereum/scaffold/mapping';
-import EthereumSubgraph from './ethereum/subgraph';
-import EthereumTypeGenerator from './ethereum/type-generator';
-import NearContract from './near/contract';
-import * as NearManifestScaffold from './near/scaffold/manifest';
-import * as NearMappingScaffold from './near/scaffold/mapping';
-import NearSubgraph from './near/subgraph';
-import { SubgraphOptions } from './subgraph';
-import * as SubstreamsManifestScaffold from './substreams/scaffold/manifest';
-import SubstreamsSubgraph from './substreams/subgraph';
-
-const protocolDebug = debug('graph-cli:protocol');
-
-export default class Protocol {
-  static fromDataSources(dataSourcesAndTemplates: any) {
-    const firstDataSourceKind = dataSourcesAndTemplates[0].kind;
-    return new Protocol(firstDataSourceKind);
-  }
-
-  name: ProtocolName;
-
-  // TODO: should assert non null? see the constructor switch default case comment
-  config!: ProtocolConfig;
-
-  constructor(name: ProtocolName) {
-    this.name = Protocol.normalizeName(name)!;
-
-    switch (this.name) {
-      case 'arweave':
-        this.config = arweaveProtocol;
-        break;
-      case 'cosmos':
-        this.config = cosmosProtocol;
-        break;
-      case 'ethereum':
-        this.config = ethereumProtocol;
-        break;
-      case 'near':
-        this.config = nearProtocol;
-        break;
-      case 'substreams':
-        this.config = substreamsProtocol;
-        break;
-      default:
-      // Do not throw when undefined, a better error message is printed after the constructor
-      // when validating the Subgraph itself
-    }
-  }
-
-  static availableProtocols() {
-    return immutable.fromJS({
-      // `ethereum/contract` is kept for backwards compatibility.
-      // New networks (or protocol perhaps) shouldn't have the `/contract` anymore (unless a new case makes use of it).
-      arweave: ['arweave'],
-      ethereum: ['ethereum', 'ethereum/contract'],
-      near: ['near'],
-      cosmos: ['cosmos'],
-      substreams: ['substreams'],
-    }) as immutable.Collection<ProtocolName, string[]>;
-  }
-
-  static availableNetworks() {
-    let networks = immutable.fromJS({
-      arweave: ['arweave-mainnet'],
-      ethereum: [
-        '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-rinkeby',
-        'optimism',
-        'optimism-kovan',
-        'aurora',
-        'aurora-testnet',
-      ],
-      near: ['near-mainnet', 'near-testnet'],
-      cosmos: [
-        'cosmoshub-4',
-        'theta-testnet-001', // CosmosHub testnet
-        'osmosis-1',
-        'osmo-test-4', // Osmosis testnet
-        'juno-1',
-        'uni-3', // Juno testnet
-      ],
-    }) as immutable.Map<'arweave' | 'ethereum' | 'near' | 'cosmos' | 'substreams', string[]>;
-
-    const allNetworks: string[] = [];
-    networks.forEach(value => {
-      allNetworks.push(...value);
-    });
-
-    networks = networks.set('substreams', allNetworks);
-
-    return networks;
-  }
-
-  static normalizeName(name: ProtocolName) {
-    return Protocol.availableProtocols().findKey(possibleNames => {
-      return possibleNames.includes(name);
-    })!;
-  }
-
-  displayName() {
-    return this.config?.displayName;
-  }
-
-  // Receives a data source kind, and checks if it's valid
-  // for the given protocol instance (this).
-  isValidKindName(kind: string) {
-    return Protocol.availableProtocols().get(this.name, immutable.List()).includes(kind);
-  }
-
-  hasABIs() {
-    return this.config.abi != null;
-  }
-
-  hasContract() {
-    return this.config.contract != null;
-  }
-
-  hasEvents() {
-    // A problem with hasEvents usage in the codebase is that it's almost every where
-    // where used, the ABI data is actually use after the conditional, so it seems
-    // both concept are related. So internally, we map to this condition.
-    return this.hasABIs();
-  }
-
-  hasTemplates() {
-    return this.config.getTemplateCodeGen != null;
-  }
-
-  hasDataSourceMappingFile() {
-    return this.getMappingScaffold() != null;
-  }
-
-  getTypeGenerator(options: any) {
-    if (this.config == null || this.config.getTypeGenerator == null) {
-      return null;
-    }
-
-    return this.config.getTypeGenerator(options);
-  }
-
-  getTemplateCodeGen(template: any) {
-    if (!this.hasTemplates()) {
-      throw new Error(`Template data sources with kind '${this.name}' are not supported yet`);
-    }
-
-    return this.config.getTemplateCodeGen?.(template);
-  }
-
-  getABI() {
-    return this.config.abi;
-  }
-
-  getSubgraph(options: SubgraphOptions) {
-    return this.config.getSubgraph({ ...options, protocol: this });
-  }
-
-  getContract() {
-    return this.config.contract;
-  }
-
-  getManifestScaffold() {
-    return this.config.manifestScaffold;
-  }
-
-  getMappingScaffold() {
-    return this.config.mappingScaffold;
-  }
-}
-
-export type ProtocolName = 'arweave' | 'ethereum' | 'near' | 'cosmos' | 'substreams';
-
-export interface ProtocolConfig {
-  displayName: string;
-  abi?: any;
-  contract?: ContractCtor;
-  getTemplateCodeGen?: (template: any) => any;
-  getTypeGenerator?: (options: any) => any;
-  getSubgraph(options: SubgraphOptions): Subgraph;
-  manifestScaffold: any;
-  mappingScaffold: any;
-}
-
-const arweaveProtocol: ProtocolConfig = {
-  displayName: 'Arweave',
-  abi: undefined,
-  contract: undefined,
-  getTemplateCodeGen: undefined,
-  getTypeGenerator: undefined,
-  getSubgraph(options) {
-    return new ArweaveSubgraph(options);
-  },
-  manifestScaffold: ArweaveManifestScaffold,
-  mappingScaffold: ArweaveMappingScaffold,
-};
-
-const cosmosProtocol: ProtocolConfig = {
-  displayName: 'Cosmos',
-  abi: undefined,
-  contract: undefined,
-  getTemplateCodeGen: undefined,
-  getTypeGenerator: undefined,
-  getSubgraph(options) {
-    return new CosmosSubgraph(options);
-  },
-  manifestScaffold: CosmosManifestScaffold,
-  mappingScaffold: CosmosMappingScaffold,
-};
-
-const ethereumProtocol: ProtocolConfig = {
-  displayName: 'Ethereum',
-  abi: EthereumABI,
-  contract: EthereumContract,
-  getTemplateCodeGen(template) {
-    return new EthereumTemplateCodeGen(template);
-  },
-  getTypeGenerator(options) {
-    return new EthereumTypeGenerator(options);
-  },
-  getSubgraph(options) {
-    return new EthereumSubgraph(options);
-  },
-  manifestScaffold: EthereumManifestScaffold,
-  mappingScaffold: EthereumMappingScaffold,
-};
-
-const nearProtocol: ProtocolConfig = {
-  displayName: 'NEAR',
-  abi: undefined,
-  contract: NearContract,
-  getTypeGenerator: undefined,
-  getTemplateCodeGen: undefined,
-  getSubgraph(options) {
-    return new NearSubgraph(options);
-  },
-  manifestScaffold: NearManifestScaffold,
-  mappingScaffold: NearMappingScaffold,
-};
-
-const substreamsProtocol: ProtocolConfig = {
-  displayName: 'Substreams',
-  abi: undefined,
-  contract: undefined,
-  getTypeGenerator: undefined,
-  getTemplateCodeGen: undefined,
-  getSubgraph(options) {
-    return new SubstreamsSubgraph(options);
-  },
-  manifestScaffold: SubstreamsManifestScaffold,
-  mappingScaffold: undefined,
-};
-
-protocolDebug('Available networks %M', Protocol.availableNetworks());

package/src/protocols/ipfs/codegen/file_template.ts

@@ -1,43 +0,0 @@
-/* eslint-disable */
-
-import immutable from 'immutable';
-import * as tsCodegen from '../../../codegen/typescript';
-
-export default class IpfsFileTemplateCodeGen {
-  constructor(private template: immutable.Map<any, any>) {
-    this.template = template;
-  }
-
-  generateModuleImports() {
-    return [];
-  }
-
-  generateCreateMethod() {
-    const name = this.template.get('name');
-
-    return tsCodegen.staticMethod(
-      'create',
-      [tsCodegen.param('cid', tsCodegen.namedType('string'))],
-      tsCodegen.namedType('void'),
-      `
-      DataSourceTemplate.create('${name}', [cid])
-      `,
-    );
-  }
-
-  generateCreateWithContextMethod() {
-    const name = this.template.get('name');
-
-    return tsCodegen.staticMethod(
-      'createWithContext',
-      [
-        tsCodegen.param('cid', tsCodegen.namedType('string')),
-        tsCodegen.param('context', tsCodegen.namedType('DataSourceContext')),
-      ],
-      tsCodegen.namedType('void'),
-      `
-      DataSourceTemplate.createWithContext('${name}', [cid], context)
-      `,
-    );
-  }
-}

package/src/protocols/near/contract.ts

@@ -1,47 +0,0 @@
-import { Contract } from '../contract';
-
-const MINIMUM_ACCOUNT_ID_LENGTH = 2 as const;
-const MAXIMUM_ACCOUNT_ID_LENGTH = 64 as const;
-
-const RULES_URL = 'https://docs.near.org/docs/concepts/account#account-id-rules' as const;
-
-export default class NearContract implements Contract {
-  static identifierName() {
-    return 'account';
-  }
-
-  constructor(private account: string) {
-    this.account = account;
-  }
-
-  private validateLength(value: string) {
-    return value.length >= MINIMUM_ACCOUNT_ID_LENGTH && value.length <= MAXIMUM_ACCOUNT_ID_LENGTH;
-  }
-
-  private validateFormat(value: string) {
-    const pattern = /^(([a-z\d]+[-_])*[a-z\d]+\.)*([a-z\d]+[-_])*[a-z\d]+$/;
-
-    return pattern.test(value);
-  }
-
-  validate() {
-    if (!this.validateLength(this.account)) {
-      return {
-        valid: false,
-        error: `Account must be between '${MINIMUM_ACCOUNT_ID_LENGTH}' and '${MAXIMUM_ACCOUNT_ID_LENGTH}' characters, see ${RULES_URL}`,
-      };
-    }
-
-    if (!this.validateFormat(this.account)) {
-      return {
-        valid: false,
-        error: `Account must conform to the rules on ${RULES_URL}`,
-      };
-    }
-
-    return {
-      valid: true,
-      error: null,
-    };
-  }
-}

package/src/protocols/near/scaffold/manifest.ts

@@ -1,13 +0,0 @@
-import { strings } from 'gluegun';
-
-export const source = ({ contract }: { contract: string }) => `
-      account: '${contract}'`;
-
-export const mapping = ({ contractName }: { contractName: string }) => `
-      apiVersion: 0.0.5
-      language: wasm/assemblyscript
-      entities:
-        - ExampleEntity
-      receiptHandlers:
-        - handler: handleReceipt
-      file: ./src/${strings.kebabCase(contractName)}.ts`;

package/src/protocols/near/subgraph.ts

@@ -1,22 +0,0 @@
-import immutable from 'immutable';
-import { Subgraph, SubgraphOptions } from '../subgraph';
-
-export default class NearSubgraph implements Subgraph {
-  public manifest: SubgraphOptions['manifest'];
-  public resolveFile: SubgraphOptions['resolveFile'];
-  public protocol: SubgraphOptions['protocol'];
-
-  constructor(options: SubgraphOptions) {
-    this.manifest = options.manifest;
-    this.resolveFile = options.resolveFile;
-    this.protocol = options.protocol;
-  }
-
-  validateManifest() {
-    return immutable.List();
-  }
-
-  handlerTypes() {
-    return immutable.List(['blockHandlers', 'receiptHandlers']);
-  }
-}

package/src/protocols/subgraph.ts

@@ -1,12 +0,0 @@
-import immutable from 'immutable';
-
-export interface SubgraphOptions {
-  manifest?: any;
-  resolveFile: (path: string) => string;
-  protocol?: any;
-}
-
-export interface Subgraph extends SubgraphOptions {
-  validateManifest(): immutable.List<any>;
-  handlerTypes(): immutable.List<any>;
-}

package/src/protocols/substreams/scaffold/manifest.ts

@@ -1,8 +0,0 @@
-export const source = () => `
-      package:
-        moduleName: graph_out
-        file: substreams-eth-block-meta-v0.1.0.spkg`;
-
-export const mapping = () => `
-      apiVersion: 0.0.5
-      kind: substreams/graph-entities`;

package/src/protocols/substreams/subgraph.ts

@@ -1,22 +0,0 @@
-import immutable from 'immutable';
-import { Subgraph, SubgraphOptions } from '../subgraph';
-
-export default class SubstreamsSubgraph implements Subgraph {
-  public manifest: SubgraphOptions['manifest'];
-  public resolveFile: SubgraphOptions['resolveFile'];
-  public protocol: SubgraphOptions['protocol'];
-
-  constructor(options: SubgraphOptions) {
-    this.manifest = options.manifest;
-    this.resolveFile = options.resolveFile;
-    this.protocol = options.protocol;
-  }
-
-  validateManifest() {
-    return immutable.List();
-  }
-
-  handlerTypes() {
-    return immutable.List([]);
-  }
-}

package/src/scaffold/index.ts

@@ -1,172 +0,0 @@
-import { strings } from 'gluegun';
-import prettier from 'prettier';
-import { getSubgraphBasename } from '../command-helpers/subgraph';
-import Protocol from '../protocols';
-import ABI from '../protocols/ethereum/abi';
-import { generateEventIndexingHandlers } from './mapping';
-import { abiEvents, generateEventType, generateExampleEntityType } from './schema';
-import { generateTestsFiles } from './tests';
-
-const GRAPH_CLI_VERSION = process.env.GRAPH_CLI_TESTS
-  ? // JSON.stringify should remove this key, we will install the local
-    // graph-cli for the tests using `npm link` instead of fetching from npm.
-    undefined
-  : // For scaffolding real subgraphs
-    String(module.exports.version);
-
-export interface ScaffoldOptions {
-  protocol: Protocol;
-  abi?: ABI;
-  indexEvents?: boolean;
-  contract?: string;
-  network: string;
-  contractName: string;
-  subgraphName?: string;
-  node?: string;
-}
-
-export default class Scaffold {
-  protocol: Protocol;
-  abi?: ABI;
-  indexEvents?: boolean;
-  contract?: string;
-  network: string;
-  contractName: string;
-  subgraphName?: string;
-  node?: string;
-
-  constructor(options: ScaffoldOptions) {
-    this.protocol = options.protocol;
-    this.abi = options.abi;
-    this.indexEvents = options.indexEvents;
-    this.contract = options.contract;
-    this.network = options.network;
-    this.contractName = options.contractName;
-    this.subgraphName = options.subgraphName;
-    this.node = options.node;
-  }
-
-  generatePackageJson() {
-    return prettier.format(
-      JSON.stringify({
-        name: getSubgraphBasename(String(this.subgraphName)),
-        license: 'UNLICENSED',
-        scripts: {
-          codegen: 'graph codegen',
-          build: 'graph build',
-          deploy: `graph deploy ` + `--node ${this.node} ` + this.subgraphName,
-          'create-local': `graph create --node http://localhost:8020/ ${this.subgraphName}`,
-          'remove-local': `graph remove --node http://localhost:8020/ ${this.subgraphName}`,
-          'deploy-local':
-            `graph deploy ` +
-            `--node http://localhost:8020/ ` +
-            `--ipfs http://localhost:5001 ` +
-            this.subgraphName,
-          test: 'graph test',
-        },
-        dependencies: {
-          '@graphprotocol/graph-cli': GRAPH_CLI_VERSION,
-          '@graphprotocol/graph-ts': `0.29.1`,
-        },
-        devDependencies: this.protocol.hasEvents() ? { 'matchstick-as': `0.5.0` } : undefined,
-      }),
-      { parser: 'json' },
-    );
-  }
-
-  generateManifest() {
-    const protocolManifest = this.protocol.getManifestScaffold();
-
-    return prettier.format(
-      `
-specVersion: 0.0.5
-schema:
-  file: ./schema.graphql
-dataSources:
-  - kind: ${this.protocol.name}
-    name: ${this.contractName}
-    network: ${this.network}
-    source: ${protocolManifest.source(this)}
-    mapping: ${protocolManifest.mapping(this)}
-`,
-      { parser: 'yaml' },
-    );
-  }
-
-  generateSchema() {
-    const hasEvents = this.protocol.hasEvents();
-    const events = hasEvents ? abiEvents(this.abi!).toJS() : [];
-
-    return prettier.format(
-      hasEvents && this.indexEvents
-        ? events.map((event: any) => generateEventType(event, this.protocol.name)).join('\n\n')
-        : generateExampleEntityType(this.protocol, events),
-      {
-        parser: 'graphql',
-      },
-    );
-  }
-
-  generateTsConfig() {
-    return prettier.format(
-      JSON.stringify({
-        extends: '@graphprotocol/graph-ts/types/tsconfig.base.json',
-        include: ['src'],
-      }),
-      { parser: 'json' },
-    );
-  }
-
-  generateMappings() {
-    return this.protocol.getMappingScaffold()
-      ? { [`${strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() }
-      : undefined;
-  }
-
-  generateMapping() {
-    const hasEvents = this.protocol.hasEvents();
-    const events = hasEvents ? abiEvents(this.abi!).toJS() : [];
-    const protocolMapping = this.protocol.getMappingScaffold();
-
-    return prettier.format(
-      hasEvents && this.indexEvents
-        ? generateEventIndexingHandlers(events, this.contractName)
-        : protocolMapping.generatePlaceholderHandlers({
-            ...this,
-            events,
-          }),
-      { parser: 'typescript', semi: false },
-    );
-  }
-
-  generateABIs() {
-    return this.protocol.hasABIs()
-      ? {
-          [`${this.contractName}.json`]: prettier.format(JSON.stringify(this.abi?.data), {
-            parser: 'json',
-          }),
-        }
-      : undefined;
-  }
-
-  generateTests() {
-    const hasEvents = this.protocol.hasEvents();
-    const events = hasEvents ? abiEvents(this.abi!).toJS() : [];
-
-    return events.length > 0
-      ? generateTestsFiles(this.contractName, events, this.indexEvents)
-      : undefined;
-  }
-
-  generate() {
-    return {
-      'package.json': this.generatePackageJson(),
-      'subgraph.yaml': this.generateManifest(),
-      'schema.graphql': this.generateSchema(),
-      'tsconfig.json': this.generateTsConfig(),
-      src: this.generateMappings(),
-      abis: this.generateABIs(),
-      tests: this.generateTests(),
-    };
-  }
-}

package/src/scaffold/mapping.ts

@@ -1,44 +0,0 @@
-import * as util from '../codegen/util';
-
-export const generateFieldAssignment = (path: string[]) =>
-  `entity.${path.join('_')} = event.params.${path.join('.')}`;
-
-export const generateFieldAssignments = ({ index, input }: { index: number; input: any }) =>
-  input.type === 'tuple'
-    ? util
-        .unrollTuple({ value: input, index, path: [input.name || `param${index}`] })
-        .map(({ path }: any) => generateFieldAssignment(path))
-    : generateFieldAssignment([input.name || `param${index}`]);
-
-export const generateEventFieldAssignments = (event: any) =>
-  event.inputs.reduce(
-    (acc: any[], input: any, index: number) =>
-      acc.concat(generateFieldAssignments({ input, index })),
-    [],
-  );
-
-export const generateEventIndexingHandlers = (events: any[], contractName: string) =>
-  `
-  import { ${events.map(
-    event => `${event._alias} as ${event._alias}Event`,
-  )}} from '../generated/${contractName}/${contractName}'
-  import { ${events.map(event => event._alias)} } from '../generated/schema'
-
-  ${events
-    .map(
-      event =>
-        `
-  export function handle${event._alias}(event: ${event._alias}Event): void {
-    let entity = new ${event._alias}(event.transaction.hash.concatI32(event.logIndex.toI32()))
-    ${generateEventFieldAssignments(event).join('\n')}
-
-    entity.blockNumber = event.block.number
-    entity.blockTimestamp = event.block.timestamp
-    entity.transactionHash = event.transaction.hash
-
-    entity.save()
-  }
-    `,
-    )
-    .join('\n')}
-`;