@graphprotocol/graph-cli 0.49.0-alpha-20230504191821-affcb14 → 0.49.0-alpha-20230505103249-d3fbf0b

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.49.0-alpha-20230504191821-affcb14
+## 0.49.0-alpha-20230505103249-d3fbf0b
 
 ### Minor Changes
 
@@ -9,54 +9,11 @@
   Thanks [@saihaj](https://github.com/saihaj)! - do not generate types, instead show a message to
   user to use substreams CLI for codegen.
 
-- [#1335](https://github.com/graphprotocol/graph-tooling/pull/1335)
-  [`6bd042b`](https://github.com/graphprotocol/graph-tooling/commit/6bd042bb5dd8facff02450c874e8811aebc83fcc)
-  Thanks [@saihaj](https://github.com/saihaj)! - For substreams generate the directory tree as
-  follows
-
-  ```
-  .
-  ├── package.json
-  ├── schema.graphql
-  └── subgraph.yaml
-  ```
-
-  In the `package.json` we only depend on the CLI since that is what developer will use to deploy
-  the subgraph. The `schema.graphql` is the schema of the subgraph and the `subgraph.yaml` is the
-  manifest file for the subgraph.
-
-- [#1335](https://github.com/graphprotocol/graph-tooling/pull/1335)
-  [`affcb14`](https://github.com/graphprotocol/graph-tooling/commit/affcb1492f29affdb2426e57a154f132362f24ef)
-  Thanks [@saihaj](https://github.com/saihaj)! - respect --abi flag instead of loading from
-  etherscan
-
-- [#1335](https://github.com/graphprotocol/graph-tooling/pull/1335)
-  [`f90dd75`](https://github.com/graphprotocol/graph-tooling/commit/f90dd757a558f4e66cc46780f13612309f45646a)
-  Thanks [@saihaj](https://github.com/saihaj)! - remove index events as entities for substreams
-
 - [#1306](https://github.com/graphprotocol/graph-tooling/pull/1306)
   [`f5e4b58`](https://github.com/graphprotocol/graph-tooling/commit/f5e4b58989edc5f3bb8211f1b912449e77832de8)
   Thanks [@saihaj](https://github.com/saihaj)! - Add loadInBlock function for entities as part of
   codegen
 
-- [#1335](https://github.com/graphprotocol/graph-tooling/pull/1335)
-  [`f90dd75`](https://github.com/graphprotocol/graph-tooling/commit/f90dd757a558f4e66cc46780f13612309f45646a)
-  Thanks [@saihaj](https://github.com/saihaj)! - remove start block selection for substreams
-
-### Patch Changes
-
-- [#1335](https://github.com/graphprotocol/graph-tooling/pull/1335)
-  [`aac26c9`](https://github.com/graphprotocol/graph-tooling/commit/aac26c97b5427156f8d61311924bac215155b4cb)
-  Thanks [@saihaj](https://github.com/saihaj)! - dependencies updates:
-
-  - Updated dependency [`gluegun@5.1.2` ↗︎](https://www.npmjs.com/package/gluegun/v/5.1.2) (from
-    `https://github.com/edgeandnode/gluegun#v4.3.1-pin-colors-dep`, in `dependencies`)
-
-- [#1331](https://github.com/graphprotocol/graph-tooling/pull/1331)
-  [`b2c8dec`](https://github.com/graphprotocol/graph-tooling/commit/b2c8decb7806d25df6ca4e07f6dfdf7941516435)
-  Thanks [@saihaj](https://github.com/saihaj)! - only allow mainnet for substreams in network
-  selection for init
-
 ## 0.48.0
 
 ### Minor Changes

package/dist/codegen/schema.d.ts

@@ -21,13 +21,20 @@ export default class SchemaCodeGenerator {
     constructor(schema: Schema);
     generateModuleImports(): tsCodegen.ModuleImports[];
     generateTypes(): Array<tsCodegen.Class>;
+    generateDerivedLoaders(): any[];
     _isEntityTypeDefinition(def: DefinitionNode): def is ObjectTypeDefinitionNode;
+    _isDerivedField(field: any): boolean;
     _isInterfaceDefinition(def: DefinitionNode): def is InterfaceTypeDefinitionNode;
     _generateEntityType(def: ObjectTypeDefinitionNode): tsCodegen.Class;
+    _generateDerivedLoader(typeName: string): any;
+    _getTypeNameForField(gqlType: TypeNode): string;
     _generateConstructor(_entityName: string, fields: readonly FieldDefinitionNode[] | undefined): tsCodegen.Method;
     _generateStoreMethods(entityName: string, idField: IdField): Array<tsCodegen.Method | tsCodegen.StaticMethod>;
     _generateEntityFieldMethods(entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): Array<tsCodegen.Method>;
     _generateEntityFieldGetter(_entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): tsCodegen.Method;
+    _generateDerivedFieldGetter(entityDef: any, fieldDef: FieldDefinitionNode): tsCodegen.Method;
+    _returnTypeForDervied(gqlType: any): any;
+    _generatedEntityDerivedFieldGetter(_entityDef: any, fieldDef: FieldDefinitionNode): tsCodegen.Method;
     _generateEntityFieldSetter(_entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): tsCodegen.Method | null;
     _resolveFieldType(gqlType: NamedTypeNode): string;
     /** Return the type that values for this field must have. For scalar

package/dist/codegen/schema.js

@@ -22,7 +22,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable unicorn/no-array-for-each */
+const debug_1 = __importDefault(require("debug"));
 const typesCodegen = __importStar(require("./types"));
 const tsCodegen = __importStar(require("./typescript"));
 class IdField {
@@ -98,10 +103,24 @@ class SchemaCodeGenerator {
         })
             .filter(Boolean);
     }
+    generateDerivedLoaders() {
+        const fields = this.schema.ast.definitions
+            .filter(def => this._isEntityTypeDefinition(def))
+            .flatMap((def) => def.fields)
+            .filter((def) => this._isDerivedField(def))
+            .map((def) => this._getTypeNameForField(def.type));
+        return [...new Set(fields)].map((typeName) => {
+            return this._generateDerivedLoader(typeName);
+        });
+    }
     _isEntityTypeDefinition(def) {
         return (def.kind === 'ObjectTypeDefinition' &&
             def.directives?.find(directive => directive.name.value === 'entity') !== undefined);
     }
+    _isDerivedField(field) {
+        return (field.directives?.find((directive) => directive.name.value === 'derivedFrom') !==
+            undefined);
+    }
     _isInterfaceDefinition(def) {
         return def.kind === 'InterfaceTypeDefinition';
     }
@@ -120,6 +139,42 @@ class SchemaCodeGenerator {
             .forEach((method) => klass.addMethod(method));
         return klass;
     }
+    _generateDerivedLoader(typeName) {
+        // <field>Loader
+        const klass = tsCodegen.klass(`${typeName}Loader`, { export: true, extends: 'Entity' });
+        klass.addMember(tsCodegen.klassMember('_entity', 'string'));
+        klass.addMember(tsCodegen.klassMember('_field', 'string'));
+        klass.addMember(tsCodegen.klassMember('_id', 'string'));
+        // Generate and add a constructor
+        klass.addMethod(tsCodegen.method('constructor', [
+            tsCodegen.param('entity', 'string'),
+            tsCodegen.param('id', 'string'),
+            tsCodegen.param('field', 'string'),
+        ], undefined, `
+      super();
+      this._entity = entity;
+      this._id = id;
+      this._field = field;
+`));
+        // Generate load() method for the Loader
+        klass.addMethod(tsCodegen.method('load', [], `${typeName}[]`, `
+  let value = store.loadRelated(this._entity, this._id, this._field);
+  return changetype<${typeName}[]>(value);
+  `));
+        return klass;
+    }
+    _getTypeNameForField(gqlType) {
+        if (gqlType.kind === 'NonNullType') {
+            return this._getTypeNameForField(gqlType.type);
+        }
+        if (gqlType.kind === 'ListType') {
+            return this._getTypeNameForField(gqlType.type);
+        }
+        if (gqlType.kind === 'NamedType') {
+            return gqlType.name.value;
+        }
+        throw new Error(`Unknown type kind: ${gqlType}`);
+    }
     _generateConstructor(_entityName, fields) {
         const idField = IdField.fromFields(fields);
         return tsCodegen.method('constructor', [tsCodegen.param('id', idField.tsNamedType())], undefined, `
@@ -156,6 +211,12 @@ class SchemaCodeGenerator {
             .filter(Boolean);
     }
     _generateEntityFieldGetter(_entityDef, fieldDef) {
+        const isDerivedField = this._isDerivedField(fieldDef);
+        const codegenDebug = (0, debug_1.default)('codegen');
+        if (isDerivedField) {
+            codegenDebug(`Generating derived field getter for ${fieldDef.name.value}`);
+            return this._generateDerivedFieldGetter(_entityDef, fieldDef);
+        }
         const name = fieldDef.name.value;
         const gqlType = fieldDef.type;
         const fieldValueType = this._valueTypeFromGraphQl(gqlType);
@@ -179,6 +240,42 @@ class SchemaCodeGenerator {
        ${isNullable ? getNullable : getNonNullable}
       `);
     }
+    _generateDerivedFieldGetter(entityDef, fieldDef) {
+        const entityName = entityDef.name.value;
+        const name = fieldDef.name.value;
+        const gqlType = fieldDef.type;
+        const returnType = this._returnTypeForDervied(gqlType);
+        return tsCodegen.method(`get ${name}`, [], returnType, `
+        return new ${returnType}('${entityName}', this.get('id')!.toString(), '${name}')
+      `);
+    }
+    _returnTypeForDervied(gqlType) {
+        if (gqlType.kind === 'NonNullType') {
+            return this._returnTypeForDervied(gqlType.type);
+        }
+        if (gqlType.kind === 'ListType') {
+            return this._returnTypeForDervied(gqlType.type);
+        }
+        const type = tsCodegen.namedType(gqlType.name.value + 'Loader');
+        return type;
+    }
+    _generatedEntityDerivedFieldGetter(_entityDef, fieldDef) {
+        const name = fieldDef.name.value;
+        const gqlType = fieldDef.type;
+        const fieldValueType = this._valueTypeFromGraphQl(gqlType);
+        const returnType = this._typeFromGraphQl(gqlType);
+        const isNullable = returnType instanceof tsCodegen.NullableType;
+        const getNonNullable = `return ${typesCodegen.valueToAsc('value!', fieldValueType)}`;
+        const getNullable = `if (!value || value.kind == ValueKind.NULL) {
+                          return null
+                        } else {
+                          return ${typesCodegen.valueToAsc('value', fieldValueType)}
+                        }`;
+        return tsCodegen.method(`get ${name}`, [], returnType, `
+       let value = this.get('${name}')
+       ${isNullable ? getNullable : getNonNullable}
+      `);
+    }
     _generateEntityFieldSetter(_entityDef, fieldDef) {
         const name = fieldDef.name.value;
         const isDerivedField = !!fieldDef.directives?.find(directive => directive.name.value === 'derivedFrom');

package/dist/codegen/schema.test.js

@@ -276,14 +276,9 @@ describe('Schema code generator', () => {
                     {
                         name: 'get wallets',
                         params: [],
-                        returnType: new typescript_1.NullableType(new typescript_1.ArrayType(new typescript_1.NamedType('string'))),
+                        returnType: new typescript_1.NamedType('WalletLoader'),
                         body: `
-              let value = this.get('wallets')
-              if (!value || value.kind == ValueKind.NULL) {
-                return null
-              } else {
-                return value.toStringArray()
-              }
+              return new WalletLoader("Account", this.get('id')!.toString(), "wallets") 
             `,
                     },
                 ],

package/dist/command-helpers/scaffold.d.ts

@@ -14,14 +14,6 @@ export declare const generateScaffold: ({ protocolInstance, abi, contract, netwo
     startBlock?: string | undefined;
     node?: string | undefined;
 }, spinner: Spinner) => Promise<{
-    'subgraph.yaml': string;
-    'schema.graphql': string;
-    'package.json': string;
-    'tsconfig.json'?: undefined;
-    src?: undefined;
-    abis?: undefined;
-    tests?: undefined;
-} | {
     'package.json': string;
     'subgraph.yaml': string;
     'schema.graphql': string;

package/dist/commands/init.js

@@ -39,10 +39,12 @@ const scaffold_1 = require("../command-helpers/scaffold");
 const spinner_1 = require("../command-helpers/spinner");
 const studio_1 = require("../command-helpers/studio");
 const subgraph_1 = require("../command-helpers/subgraph");
+const debug_1 = __importDefault(require("../debug"));
 const protocols_1 = __importDefault(require("../protocols"));
 const schema_1 = require("../scaffold/schema");
 const validation_1 = require("../validation");
 const add_1 = __importDefault(require("./add"));
+const initDebug = (0, debug_1.default)('graph-cli:init');
 const protocolChoices = Array.from(protocols_1.default.availableProtocols().keys());
 const availableNetworks = protocols_1.default.availableNetworks();
 const DEFAULT_EXAMPLE_SUBGRAPH = 'ethereum/gravatar';
@@ -83,18 +85,8 @@ class InitCommand extends core_1.Command {
         };
         // If all parameters are provided from the command-line,
         // go straight to creating the subgraph from the example
-        if (fromExample && subgraphName && directory && protocol) {
-            await initSubgraphFromExample.bind(this)({
-                fromExample,
-                allowSimpleName,
-                directory,
-                subgraphName,
-                studio,
-                product,
-                protocolInstance: new protocols_1.default(protocol),
-            }, { commands });
-            // Exit with success
-            return this.exit(0);
+        if (fromExample && subgraphName && directory) {
+            return await initSubgraphFromExample.bind(this)({ fromExample, allowSimpleName, directory, subgraphName, studio, product }, { commands });
         }
         // Will be assigned below if ethereum
         let abi;
@@ -130,7 +122,7 @@ class InitCommand extends core_1.Command {
                     }
                 }
             }
-            await initSubgraphFromContract.bind(this)({
+            return await initSubgraphFromContract.bind(this)({
                 protocolInstance,
                 abi,
                 allowSimpleName,
@@ -145,8 +137,6 @@ class InitCommand extends core_1.Command {
                 product,
                 startBlock,
             }, { commands, addContract: false });
-            // Exit with success
-            return this.exit(0);
         }
         // Otherwise, take the user through the interactive form
         const answers = await processInitForm.bind(this)({
@@ -155,7 +145,6 @@ class InitCommand extends core_1.Command {
             studio,
             node,
             abi,
-            abiPath,
             allowSimpleName,
             directory,
             contract: fromContract,
@@ -177,7 +166,6 @@ class InitCommand extends core_1.Command {
                 directory: answers.directory,
                 studio: answers.studio,
                 product: answers.product,
-                protocolInstance: answers.protocolInstance,
             }, { commands });
         }
         else {
@@ -203,8 +191,6 @@ class InitCommand extends core_1.Command {
                 startBlock: answers.startBlock,
             }, { commands, addContract: true });
         }
-        // Exit with success
-        this.exit(0);
     }
 }
 InitCommand.description = 'Creates a new subgraph with basic scaffolding.';
@@ -279,246 +265,227 @@ InitCommand.flags = {
     }),
 };
 exports.default = InitCommand;
-async function processInitForm({ protocol: initProtocol, product: initProduct, studio: initStudio, node: initNode, abi: initAbi, abiPath: initAbiPath, directory: initDirectory, contract: initContract, indexEvents: initIndexEvents, fromExample: initFromExample, network: initNetwork, subgraphName: initSubgraphName, contractName: initContractName, startBlock: initStartBlock, allowSimpleName: initAllowSimpleName, }) {
+async function processInitForm({ protocol, product, studio, node, abi, allowSimpleName, directory, contract, indexEvents, fromExample, network, subgraphName, contractName, startBlock, }) {
     let abiFromEtherscan = undefined;
-    try {
-        const { protocol } = await gluegun_1.prompt.ask({
+    let abiFromFile = undefined;
+    let protocolInstance;
+    let ProtocolContract;
+    let ABI;
+    const questions = [
+        {
             type: 'select',
             name: 'protocol',
             message: 'Protocol',
             choices: protocolChoices,
-            skip: protocolChoices.includes(String(initProtocol)),
-        });
-        const protocolInstance = new protocols_1.default(protocol);
-        const isSubstreams = protocol === 'substreams';
-        const { product } = await gluegun_1.prompt.ask([
-            {
-                type: 'select',
-                name: 'product',
-                message: 'Product for which to initialize',
-                choices: ['subgraph-studio', 'hosted-service'],
-                skip: protocol === 'arweave' ||
-                    protocol === 'cosmos' ||
-                    protocol === 'near' ||
-                    initProduct === 'subgraph-studio' ||
-                    initProduct === 'hosted-service' ||
-                    initStudio !== undefined ||
-                    initNode !== undefined,
-                result: value => {
-                    if (initProduct)
-                        return initProduct;
-                    if (initStudio)
-                        return 'subgraph-studio';
-                    // For now we only support NEAR subgraphs in the Hosted Service
-                    if (protocol === 'near') {
-                        return 'hosted-service';
-                    }
-                    if (value == 'subgraph-studio') {
-                        initAllowSimpleName = true;
-                    }
-                    return value;
-                },
+            skip: protocolChoices.includes(String(protocol)),
+            result: (value) => {
+                // eslint-disable-next-line -- prettier has problems with ||=
+                protocol = protocol || value;
+                protocolInstance = new protocols_1.default(protocol);
+                return protocol;
             },
-        ]);
-        const { subgraphName } = await gluegun_1.prompt.ask([
-            {
-                type: 'input',
-                name: 'subgraphName',
-                message: () => (product == 'subgraph-studio' ? 'Subgraph slug' : 'Subgraph name'),
-                initial: initSubgraphName,
-                validate: name => {
-                    try {
-                        (0, subgraph_1.validateSubgraphName)(name, { allowSimpleName: initAllowSimpleName });
-                        return true;
-                    }
-                    catch (e) {
-                        return `${e.message}
+        },
+        {
+            type: 'select',
+            name: 'product',
+            message: 'Product for which to initialize',
+            choices: ['subgraph-studio', 'hosted-service'],
+            skip: () => protocol === 'arweave' ||
+                protocol === 'cosmos' ||
+                protocol === 'near' ||
+                product === 'subgraph-studio' ||
+                product === 'hosted-service' ||
+                studio !== undefined ||
+                node !== undefined,
+            result: (value) => {
+                // For now we only support NEAR subgraphs in the Hosted Service
+                if (protocol === 'near') {
+                    // Can be overwritten because the question will be skipped (product === undefined)
+                    product = 'hosted-service';
+                    return product;
+                }
+                if (value == 'subgraph-studio') {
+                    allowSimpleName = true;
+                }
+                product = value;
+                return value;
+            },
+        },
+        {
+            type: 'input',
+            name: 'subgraphName',
+            message: () => (product == 'subgraph-studio' || studio ? 'Subgraph slug' : 'Subgraph name'),
+            initial: subgraphName,
+            validate: (name) => {
+                try {
+                    (0, subgraph_1.validateSubgraphName)(name, { allowSimpleName });
+                    return true;
+                }
+                catch (e) {
+                    return `${e.message}
 
-    Examples:
+  Examples:
 
-      $ graph init ${os_1.default.userInfo().username}/${name}
-      $ graph init ${name} --allow-simple-name`;
-                    }
-                },
+    $ graph init ${os_1.default.userInfo().username}/${name}
+    $ graph init ${name} --allow-simple-name`;
+                }
             },
-        ]);
-        const { directory } = await gluegun_1.prompt.ask([
-            {
-                type: 'input',
-                name: 'directory',
-                message: 'Directory to create the subgraph in',
-                initial: () => initDirectory || (0, subgraph_1.getSubgraphBasename)(subgraphName),
-                validate: value => gluegun_1.filesystem.exists(value || initDirectory || (0, subgraph_1.getSubgraphBasename)(subgraphName))
-                    ? 'Directory already exists'
-                    : true,
+            result: (value) => {
+                subgraphName = value;
+                return value;
             },
-        ]);
-        const { network } = await gluegun_1.prompt.ask([
-            {
-                type: 'select',
-                name: 'network',
-                message: () => `${protocolInstance.displayName()} network`,
-                choices: availableNetworks
+        },
+        {
+            type: 'input',
+            name: 'directory',
+            message: 'Directory to create the subgraph in',
+            initial: () => directory ||
+                (0, subgraph_1.getSubgraphBasename)(
+                // @ts-expect-error will be set by previous question
+                subgraphName),
+            validate: (value) => gluegun_1.filesystem.exists(value ||
+                directory ||
+                (0, subgraph_1.getSubgraphBasename)(
+                // @ts-expect-error will be set by previous question
+                subgraphName))
+                ? 'Directory already exists'
+                : true,
+        },
+        {
+            type: 'select',
+            name: 'network',
+            message: () => `${protocolInstance.displayName()} network`,
+            choices: () => {
+                initDebug('Generating list of available networks for protocol "%s" (%M)', protocol, availableNetworks.get(protocol));
+                return (
+                // @ts-expect-error TODO: wait what?
+                availableNetworks
                     .get(protocol) // Get networks related to the chosen protocol.
-                    ?.toArray() || ['mainnet'],
-                skip: initFromExample !== undefined,
-                result: value => {
-                    if (initNetwork)
-                        return initNetwork;
-                    return value;
-                },
+                    .toArray()); // Needed because of gluegun. It can't even receive a JS iterable.
             },
-        ]);
-        const { contract } = await gluegun_1.prompt.ask([
-            // TODO:
-            // protocols that don't support contract
-            // - arweave
-            // - cosmos
-            {
-                type: 'input',
-                name: 'contract',
-                message: `Contract ${protocolInstance.getContract()?.identifierName()}`,
-                skip: () => initFromExample !== undefined || !protocolInstance.hasContract() || isSubstreams,
-                initial: initContract,
-                validate: async (value) => {
-                    if (initFromExample !== undefined || !protocolInstance.hasContract()) {
-                        return true;
-                    }
-                    const protocolContract = protocolInstance.getContract();
-                    if (!protocolContract) {
-                        return 'Contract not found.';
-                    }
-                    // Validate whether the contract is valid
-                    const { valid, error } = (0, validation_1.validateContract)(value, protocolContract);
-                    return valid ? true : error;
-                },
-                result: async (value) => {
-                    if (initFromExample !== undefined || isSubstreams || initAbiPath) {
-                        return value;
-                    }
-                    const ABI = protocolInstance.getABI();
-                    // Try loading the ABI from Etherscan, if none was provided
-                    if (protocolInstance.hasABIs() && !initAbi) {
-                        try {
-                            if (network === 'poa-core') {
-                                // TODO: this variable is never used anywhere, what happens?
-                                // abiFromBlockScout = await loadAbiFromBlockScout(ABI, network, value)
-                            }
-                            else {
-                                abiFromEtherscan = await (0, abi_1.loadAbiFromEtherscan)(ABI, network, value);
-                            }
-                        }
-                        catch (e) {
-                            // noop
-                        }
-                    }
-                    // If startBlock is not set, try to load it.
-                    if (!initStartBlock) {
-                        try {
-                            // Load startBlock for this contract
-                            initStartBlock = Number(await (0, abi_1.loadStartBlockForContract)(network, value)).toString();
-                        }
-                        catch (error) {
-                            // noop
-                        }
-                    }
-                    return value;
-                },
+            skip: fromExample !== undefined,
+            initial: network || 'mainnet',
+            result: (value) => {
+                network = value;
+                return value;
             },
-        ]);
-        const { abi: abiFromFile } = await gluegun_1.prompt.ask([
-            {
-                type: 'input',
-                name: 'abi',
-                message: 'ABI file (path)',
-                initial: initAbi,
-                skip: () => !protocolInstance.hasABIs() ||
-                    initFromExample !== undefined ||
-                    abiFromEtherscan !== undefined ||
-                    isSubstreams ||
-                    !!initAbiPath,
-                validate: async (value) => {
-                    if (initFromExample || abiFromEtherscan || !protocolInstance.hasABIs()) {
-                        return true;
-                    }
-                    const ABI = protocolInstance.getABI();
+        },
+        // TODO:
+        //
+        // protocols that don't support contract
+        // - arweave
+        // - cosmos
+        {
+            type: 'input',
+            name: 'contract',
+            message: () => {
+                ProtocolContract = protocolInstance.getContract();
+                return `Contract ${ProtocolContract.identifierName()}`;
+            },
+            skip: () => fromExample !== undefined || !protocolInstance.hasContract(),
+            initial: contract,
+            validate: async (value) => {
+                if (fromExample !== undefined || !protocolInstance.hasContract()) {
+                    return true;
+                }
+                // Validate whether the contract is valid
+                const { valid, error } = (0, validation_1.validateContract)(value, ProtocolContract);
+                return valid ? true : error;
+            },
+            result: async (value) => {
+                if (fromExample !== undefined) {
+                    return value;
+                }
+                ABI = protocolInstance.getABI();
+                // Try loading the ABI from Etherscan, if none was provided
+                if (protocolInstance.hasABIs() && !abi) {
                     try {
-                        loadAbiFromFile(ABI, value);
-                        return true;
-                    }
-                    catch (e) {
-                        return false;
-                    }
-                },
-                result: async (value) => {
-                    if (initFromExample || abiFromEtherscan || !protocolInstance.hasABIs()) {
-                        return null;
-                    }
-                    const ABI = protocolInstance.getABI();
-                    if (initAbiPath) {
-                        try {
-                            return loadAbiFromFile(ABI, initAbiPath);
+                        if (network === 'poa-core') {
+                            // TODO: this variable is never used anywhere, what happens?
+                            // abiFromBlockScout = await loadAbiFromBlockScout(ABI, network, value)
                         }
-                        catch (e) {
-                            return e.message;
+                        else {
+                            abiFromEtherscan = await (0, abi_1.loadAbiFromEtherscan)(ABI, network, value);
                         }
                     }
+                    catch (e) {
+                        // noop
+                    }
+                }
+                // If startBlock is not set, try to load it.
+                if (!startBlock) {
                     try {
-                        return loadAbiFromFile(ABI, value);
+                        // Load startBlock for this contract
+                        startBlock = Number(await (0, abi_1.loadStartBlockForContract)(network, value)).toString();
                     }
-                    catch (e) {
-                        return e.message;
+                    catch (error) {
+                        // noop
                     }
-                },
+                }
+                return value;
             },
-        ]);
-        const { startBlock } = await gluegun_1.prompt.ask([
-            {
-                type: 'input',
-                name: 'startBlock',
-                message: 'Start Block',
-                initial: initStartBlock || '0',
-                skip: () => initFromExample !== undefined || isSubstreams,
-                validate: value => parseInt(value) >= 0,
-                result(value) {
-                    if (initStartBlock)
-                        return initStartBlock;
-                    return value;
-                },
+        },
+        {
+            type: 'input',
+            name: 'abi',
+            message: 'ABI file (path)',
+            initial: abi,
+            skip: () => !protocolInstance.hasABIs() || fromExample !== undefined || abiFromEtherscan !== undefined,
+            validate: async (value) => {
+                if (fromExample || abiFromEtherscan || !protocolInstance.hasABIs()) {
+                    return true;
+                }
+                try {
+                    abiFromFile = loadAbiFromFile(ABI, value);
+                    return true;
+                }
+                catch (e) {
+                    return e.message;
+                }
             },
-        ]);
-        const { contractName } = await gluegun_1.prompt.ask([
-            {
-                type: 'input',
-                name: 'contractName',
-                message: 'Contract Name',
-                initial: initContractName || 'Contract' || isSubstreams,
-                skip: () => initFromExample !== undefined || !protocolInstance.hasContract(),
-                validate: value => value && value.length > 0,
+        },
+        {
+            type: 'input',
+            name: 'startBlock',
+            message: 'Start Block',
+            initial: () => startBlock || '0',
+            skip: () => fromExample !== undefined,
+            validate: (value) => parseInt(value) >= 0,
+            result: (value) => {
+                startBlock = value;
+                return value;
             },
-        ]);
-        const { indexEvents } = await gluegun_1.prompt.ask([
-            {
-                type: 'confirm',
-                name: 'indexEvents',
-                message: 'Index contract events as entities',
-                initial: true,
-                skip: () => !!initIndexEvents || isSubstreams,
+        },
+        {
+            type: 'input',
+            name: 'contractName',
+            message: 'Contract Name',
+            initial: contractName || 'Contract',
+            skip: () => fromExample !== undefined || !protocolInstance.hasContract(),
+            validate: (value) => value && value.length > 0,
+            result: (value) => {
+                contractName = value;
+                return value;
             },
-        ]);
+        },
+        {
+            type: 'confirm',
+            name: 'indexEvents',
+            message: 'Index contract events as entities',
+            initial: true,
+            skip: () => !!indexEvents,
+            result: (value) => {
+                indexEvents = value;
+                return value;
+            },
+        },
+    ];
+    try {
+        const answers = await gluegun_1.prompt.ask(questions);
         return {
+            ...answers,
             abi: abiFromEtherscan || abiFromFile,
             protocolInstance,
-            subgraphName,
-            directory,
-            studio: product === 'subgraph-studio',
-            startBlock,
-            fromExample: !!initFromExample,
-            product,
-            network,
-            contractName,
-            contract,
-            indexEvents,
         };
     }
     catch (e) {
@@ -596,8 +563,7 @@ Subgraph ${subgraphName} created in ${relativeDir}
 
 Make sure to visit the documentation on https://thegraph.com/docs/ for further information.`);
 }
-async function initSubgraphFromExample({ protocolInstance, fromExample, allowSimpleName, subgraphName, directory, studio, product, }, { commands, }) {
-    const isSubstreams = protocolInstance.name === 'substreams';
+async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphName, directory, studio, product, }, { commands, }) {
     // Fail if the subgraph name is invalid
     if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
         process.exitCode = 1;
@@ -690,18 +656,15 @@ async function initSubgraphFromExample({ protocolInstance, fromExample, allowSim
         this.exit(1);
         return;
     }
-    if (!isSubstreams) {
-        // Run code-generation
-        const codegen = await runCodegen(directory, commands.codegen);
-        if (codegen !== true) {
-            this.exit(1);
-            return;
-        }
+    // Run code-generation
+    const codegen = await runCodegen(directory, commands.codegen);
+    if (codegen !== true) {
+        this.exit(1);
+        return;
     }
     printNextSteps.bind(this)({ subgraphName, directory }, { commands });
 }
 async function initSubgraphFromContract({ protocolInstance, allowSimpleName, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, studio, product, startBlock, }, { commands, addContract, }) {
-    const isSubstreams = protocolInstance.name === 'substreams';
     // Fail if the subgraph name is invalid
     if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
         this.exit(1);
@@ -767,17 +730,14 @@ async function initSubgraphFromContract({ protocolInstance, allowSimpleName, sub
         this.exit(1);
         return;
     }
-    // Substreams we have nothing to install or generate
-    if (!isSubstreams) {
-        // Run code-generation
-        const codegen = await runCodegen(directory, commands.codegen);
-        if (codegen !== true) {
-            this.exit(1);
-            return;
-        }
-        while (addContract) {
-            addContract = await addAnotherContract.bind(this)({ protocolInstance, directory });
-        }
+    // Run code-generation
+    const codegen = await runCodegen(directory, commands.codegen);
+    if (codegen !== true) {
+        this.exit(1);
+        return;
+    }
+    while (addContract) {
+        addContract = await addAnotherContract.bind(this)({ protocolInstance, directory });
     }
     printNextSteps.bind(this)({ subgraphName, directory }, { commands });
 }

package/dist/protocols/index.js

@@ -88,7 +88,7 @@ class Protocol {
         });
     }
     static availableNetworks() {
-        return immutable_1.default.fromJS({
+        let networks = immutable_1.default.fromJS({
             arweave: ['arweave-mainnet'],
             ethereum: [
                 'mainnet',
@@ -135,6 +135,13 @@ class Protocol {
             ],
             substreams: ['mainnet'],
         });
+        const allNetworks = [];
+        // eslint-disable-next-line unicorn/no-array-for-each
+        networks.forEach(value => {
+            allNetworks.push(...value);
+        });
+        networks = networks.set('substreams', immutable_1.default.List(allNetworks));
+        return networks;
     }
     static normalizeName(name) {
         return Protocol.availableProtocols().findKey(possibleNames => {

package/dist/scaffold/index.d.ts

@@ -23,7 +23,6 @@ export default class Scaffold {
     startBlock?: string;
     constructor(options: ScaffoldOptions);
     generatePackageJson(): string;
-    generatePackageJsonForSubstreams(): string;
     generateManifest(): string;
     generateSchema(): string;
     generateTsConfig(): string;
@@ -38,14 +37,6 @@ export default class Scaffold {
         [x: string]: string;
     } | undefined;
     generate(): {
-        'subgraph.yaml': string;
-        'schema.graphql': string;
-        'package.json': string;
-        'tsconfig.json'?: undefined;
-        src?: undefined;
-        abis?: undefined;
-        tests?: undefined;
-    } | {
         'package.json': string;
         'subgraph.yaml': string;
         'schema.graphql': string;

package/dist/scaffold/index.js

@@ -51,26 +51,6 @@ class Scaffold {
             devDependencies: this.protocol.hasEvents() ? { 'matchstick-as': `0.5.0` } : undefined,
         }), { parser: 'json' });
     }
-    generatePackageJsonForSubstreams() {
-        return prettier_1.default.format(JSON.stringify({
-            name: (0, subgraph_1.getSubgraphBasename)(String(this.subgraphName)),
-            license: 'UNLICENSED',
-            scripts: {
-                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,
-            },
-        }), { parser: 'json' });
-    }
     generateManifest() {
         const protocolManifest = this.protocol.getManifestScaffold();
         return prettier_1.default.format(`
@@ -135,13 +115,6 @@ dataSources:
             : undefined;
     }
     generate() {
-        if (this.protocol.name === 'substreams') {
-            return {
-                'subgraph.yaml': this.generateManifest(),
-                'schema.graphql': this.generateSchema(),
-                'package.json': this.generatePackageJsonForSubstreams(),
-            };
-        }
         return {
             'package.json': this.generatePackageJson(),
             'subgraph.yaml': this.generateManifest(),

package/dist/type-generator.js

@@ -130,6 +130,7 @@ class TypeGenerator {
                 typescript_1.GENERATED_FILE_NOTE,
                 ...codeGenerator.generateModuleImports(),
                 ...codeGenerator.generateTypes(),
+                ...codeGenerator.generateDerivedLoaders(),
             ].join('\n'), {
                 parser: 'typescript',
             });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.49.0-alpha-20230504191821-affcb14",
+  "version": "0.49.0-alpha-20230505103249-d3fbf0b",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.49.0-alpha-20230504191821-affcb14",
+  "version": "0.49.0-alpha-20230505103249-d3fbf0b",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -31,7 +31,7 @@
     "dockerode": "2.5.8",
     "fs-extra": "9.1.0",
     "glob": "9.3.5",
-    "gluegun": "5.1.2",
+    "gluegun": "https://github.com/edgeandnode/gluegun#v4.3.1-pin-colors-dep",
     "graphql": "15.5.0",
     "immutable": "4.2.1",
     "ipfs-http-client": "55.0.0",