@graphprotocol/graph-cli 0.61.0 → 0.61.1-alpha-20231114172419-d3c3cb4

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @graphprotocol/graph-cli
 
+## 0.61.1-alpha-20231114172419-d3c3cb4
+
+### Patch Changes
+
+- [#1501](https://github.com/graphprotocol/graph-tooling/pull/1501)
+  [`6acf2a7`](https://github.com/graphprotocol/graph-tooling/commit/6acf2a7fc927857704ed734d2e6d974c3bbc772f)
+  Thanks [@saihaj](https://github.com/saihaj)! - dependencies updates:
+  - Updated dependency [`prettier@3.0.3` ↗︎](https://www.npmjs.com/package/prettier/v/3.0.3) (from
+    `1.19.1`, in `dependencies`)
+
 ## 0.61.0
 
 ### Minor Changes

package/dist/codegen/schema.test.js

@@ -32,9 +32,9 @@ const prettier_1 = __importDefault(require("prettier"));
 const schema_1 = __importDefault(require("../schema"));
 const schema_2 = __importDefault(require("./schema"));
 const typescript_1 = require("./typescript");
-const formatTS = (code) => prettier_1.default.format(code, { parser: 'typescript', semi: false });
+const formatTS = async (code) => prettier_1.default.format(code, { parser: 'typescript', semi: false });
 const createSchemaCodeGen = (schema) => new schema_2.default(new schema_1.default('', schema, graphql.parse(schema)));
-const testEntity = (generatedTypes, expectedEntity) => {
+const testEntity = async (generatedTypes, expectedEntity) => {
     const entity = generatedTypes.find(type => type.name === expectedEntity.name);
     expect(entity instanceof typescript_1.Class).toBe(true);
     expect(entity.extends).toBe('Entity');
@@ -49,7 +49,7 @@ const testEntity = (generatedTypes, expectedEntity) => {
             : expect(method instanceof typescript_1.Method).toBe(true);
         expect(method.params).toStrictEqual(expectedMethod.params);
         expect(method.returnType).toStrictEqual(expectedMethod.returnType);
-        expect(formatTS(method.body)).toBe(formatTS(expectedMethod.body));
+        expect(await formatTS(method.body)).toBe(await formatTS(expectedMethod.body));
     }
     expect(methods.length).toBe(expectedEntity.methods.length);
 };
@@ -105,8 +105,8 @@ describe('Schema code generator', () => {
             // Account and Wallet
             expect(generatedTypes.length).toBe(2);
         });
-        test('Account is an entity with the correct methods', () => {
-            testEntity(generatedTypes, {
+        test('Account is an entity with the correct methods', async () => {
+            await testEntity(generatedTypes, {
                 name: 'Account',
                 members: [],
                 methods: [
@@ -308,8 +308,8 @@ describe('Schema code generator', () => {
                 ],
             });
         });
-        test('Wallet is an entity with the correct methods', () => {
-            testEntity(generatedTypes, {
+        test('Wallet is an entity with the correct methods', async () => {
+            await testEntity(generatedTypes, {
                 name: 'Wallet',
                 members: [],
                 methods: [
@@ -419,7 +419,7 @@ describe('Schema code generator', () => {
             });
         });
     });
-    test('Should handle references with Bytes id types', () => {
+    test('Should handle references with Bytes id types', async () => {
         const codegen = createSchemaCodeGen(`
     interface Employee {
       id: Bytes!
@@ -440,7 +440,7 @@ describe('Schema code generator', () => {
    }
 `);
         const generatedTypes = codegen.generateTypes();
-        testEntity(generatedTypes, {
+        await testEntity(generatedTypes, {
             name: 'Task',
             members: [],
             methods: [
@@ -542,7 +542,7 @@ describe('Schema code generator', () => {
             ],
         });
     });
-    test('get related method for WithBytes entity', () => {
+    test('get related method for WithBytes entity', async () => {
         const codegen = createSchemaCodeGen(`
       type WithBytes @entity {
         id: Bytes!
@@ -555,7 +555,7 @@ describe('Schema code generator', () => {
       }
     `);
         const generatedTypes = codegen.generateTypes();
-        testEntity(generatedTypes, {
+        await testEntity(generatedTypes, {
             name: 'WithBytes',
             members: [],
             methods: [

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

@@ -15,18 +15,18 @@ export declare const generateScaffold: ({ protocolInstance, abi, contract, netwo
     node?: string | undefined;
     spkgPath?: string | undefined;
 }, spinner: Spinner) => Promise<{
-    'subgraph.yaml': Promise<string>;
-    'schema.graphql': Promise<string>;
-    'package.json': Promise<string>;
+    'subgraph.yaml': string;
+    'schema.graphql': string;
+    'package.json': string;
     'tsconfig.json'?: undefined;
     src?: undefined;
     abis?: undefined;
     tests?: undefined;
 } | {
-    'package.json': Promise<string>;
-    'subgraph.yaml': Promise<string>;
-    'schema.graphql': Promise<string>;
-    'tsconfig.json': Promise<string>;
+    'package.json': string;
+    'subgraph.yaml': string;
+    'schema.graphql': string;
+    'tsconfig.json': string;
     src: {
         [x: string]: Promise<string>;
     } | undefined;
@@ -34,7 +34,7 @@ export declare const generateScaffold: ({ protocolInstance, abi, contract, netwo
         [x: string]: Promise<string>;
     } | undefined;
     tests: {
-        [x: string]: Promise<string>;
+        [x: string]: string;
     } | undefined;
 }>;
 export declare const writeScaffold: (scaffold: any, directory: string, spinner: Spinner) => Promise<void>;

package/dist/command-helpers/scaffold.js

@@ -42,7 +42,7 @@ const generateScaffold = async ({ protocolInstance, abi, contract, network, subg
         node,
         spkgPath,
     });
-    return scaffold.generate();
+    return await scaffold.generate();
 };
 exports.generateScaffold = generateScaffold;
 const writeScaffoldDirectory = async (scaffold, directory, spinner) => {
@@ -70,7 +70,7 @@ const writeScaffold = async (scaffold, directory, spinner) => {
 };
 exports.writeScaffold = writeScaffold;
 const writeABI = async (abi, contractName) => {
-    const data = prettier_1.default.format(JSON.stringify(abi.data), {
+    const data = await prettier_1.default.format(JSON.stringify(abi.data), {
         parser: 'json',
     });
     await fs_extra_1.default.writeFile(`./abis/${contractName}.json`, data, 'utf-8');
@@ -82,7 +82,7 @@ const writeSchema = async (abi, protocol, schemaPath, entities, contractName) =>
             .filter(event => !entities.includes(event.get('name')))
             .toJS()
         : [];
-    const data = prettier_1.default.format(events.map(event => (0, schema_1.generateEventType)(event, protocol.name, contractName)).join('\n\n'), {
+    const data = await prettier_1.default.format(events.map(event => (0, schema_1.generateEventType)(event, protocol.name, contractName)).join('\n\n'), {
         parser: 'graphql',
     });
     await fs_extra_1.default.appendFile(schemaPath, data, { encoding: 'utf-8' });
@@ -94,7 +94,7 @@ const writeMapping = async (abi, protocol, contractName, entities) => {
             .filter(event => !entities.includes(event.get('name')))
             .toJS()
         : [];
-    const mapping = prettier_1.default.format((0, mapping_1.generateEventIndexingHandlers)(events, contractName), {
+    const mapping = await prettier_1.default.format((0, mapping_1.generateEventIndexingHandlers)(events, contractName), {
         parser: 'typescript',
         semi: false,
     });

package/dist/protocols/ethereum/type-generator.js

@@ -76,7 +76,7 @@ class EthereumTypeGenerator {
         try {
             (0, spinner_1.step)(spinner, `Generate types for contract ABI:`, `${abi.abi.name} (${(0, fs_1.displayPath)(abi.abi.file)})`);
             const codeGenerator = abi.abi.codeGenerator();
-            const code = prettier_1.default.format([
+            const code = await prettier_1.default.format([
                 typescript_1.GENERATED_FILE_NOTE,
                 ...codeGenerator.generateModuleImports(),
                 ...codeGenerator.generateTypes(),
@@ -101,7 +101,7 @@ class EthereumTypeGenerator {
         try {
             (0, spinner_1.step)(spinner, `Generate types for data source template ABI:`, `${abi.template.get('name')} > ${abi.abi.name} (${(0, fs_1.displayPath)(abi.abi.file)})`);
             const codeGenerator = abi.abi.codeGenerator();
-            const code = prettier_1.default.format([
+            const code = await prettier_1.default.format([
                 typescript_1.GENERATED_FILE_NOTE,
                 ...codeGenerator.generateModuleImports(),
                 ...codeGenerator.generateTypes(),

package/dist/scaffold/cosmos.test.js

@@ -13,8 +13,8 @@ const scaffoldOptions = {
 };
 const scaffold = new index_1.default(scaffoldOptions);
 describe('Cosmos subgraph scaffolding', () => {
-    test('Manifest', () => {
-        expect(scaffold.generateManifest()).toEqual(`\
+    test('Manifest', async () => {
+        expect(await scaffold.generateManifest()).toEqual(`\
 specVersion: 0.0.5
 schema:
   file: ./schema.graphql

package/dist/scaffold/ethereum.test.js

@@ -70,8 +70,8 @@ const scaffoldWithIndexEvents = new index_1.default({
     indexEvents: true,
 });
 describe('Ethereum subgraph scaffolding', () => {
-    test('Manifest', () => {
-        expect(scaffold.generateManifest()).toEqual(`\
+    test('Manifest', async () => {
+        expect(await scaffold.generateManifest()).toEqual(`\
 specVersion: 0.0.5
 schema:
   file: ./schema.graphql
@@ -101,8 +101,8 @@ dataSources:
       file: ./src/contract.ts
 `);
     });
-    test('Schema (default)', () => {
-        expect(scaffold.generateSchema()).toEqual(`\
+    test('Schema (default)', async () => {
+        expect(await scaffold.generateSchema()).toEqual(`\
 type ExampleEntity @entity {
   id: Bytes!
   count: BigInt!
@@ -111,8 +111,8 @@ type ExampleEntity @entity {
 }
 `);
     });
-    test('Schema (for indexing events)', () => {
-        expect(scaffoldWithIndexEvents.generateSchema()).toEqual(`\
+    test('Schema (for indexing events)', async () => {
+        expect(await scaffoldWithIndexEvents.generateSchema()).toEqual(`\
 type ExampleEvent @entity(immutable: true) {
   id: Bytes!
   a: BigInt! # uint256
@@ -139,8 +139,8 @@ type ExampleEvent1 @entity(immutable: true) {
 }
 `);
     });
-    test('Mapping (default)', () => {
-        expect(scaffold.generateMapping()).toEqual(`\
+    test('Mapping (default)', async () => {
+        expect(await scaffold.generateMapping()).toEqual(`\
 import { BigInt } from "@graphprotocol/graph-ts"
 import {
   Contract,
@@ -195,8 +195,8 @@ export function handleExampleEvent(event: ExampleEvent): void {
 export function handleExampleEvent1(event: ExampleEvent1): void {}
 `);
     });
-    test('Mapping (for indexing events)', () => {
-        expect(scaffoldWithIndexEvents.generateMapping()).toEqual(`\
+    test('Mapping (for indexing events)', async () => {
+        expect(await scaffoldWithIndexEvents.generateMapping()).toEqual(`\
 import {
   ExampleEvent as ExampleEventEvent,
   ExampleEvent1 as ExampleEvent1Event
@@ -239,8 +239,8 @@ export function handleExampleEvent1(event: ExampleEvent1Event): void {
 }
 `);
     });
-    test('Test Files (default)', () => {
-        const files = scaffoldWithIndexEvents.generateTests();
+    test('Test Files (default)', async () => {
+        const files = await scaffoldWithIndexEvents.generateTests();
         const testFile = files?.['contract.test.ts'];
         const utilsFile = files?.['contract-utils.ts'];
         expect(testFile).toEqual(`\
@@ -367,8 +367,8 @@ export function createExampleEvent1Event(a: Bytes): ExampleEvent1 {
 }
 `);
     });
-    test('Test Files (for indexing events)', () => {
-        const files = scaffoldWithIndexEvents.generateTests();
+    test('Test Files (for indexing events)', async () => {
+        const files = await scaffoldWithIndexEvents.generateTests();
         const testFile = files?.['contract.test.ts'];
         const utilsFile = files?.['contract-utils.ts'];
         expect(testFile).toEqual(`\

package/dist/scaffold/index.d.ts

@@ -33,25 +33,25 @@ export default class Scaffold {
         [x: string]: Promise<string>;
     } | undefined;
     generateMapping(): Promise<string>;
-    generateABIs(): {
+    generateABIs(): Promise<{
         [x: string]: Promise<string>;
-    } | undefined;
-    generateTests(): {
-        [x: string]: Promise<string>;
-    } | undefined;
-    generate(): {
-        'subgraph.yaml': Promise<string>;
-        'schema.graphql': Promise<string>;
-        'package.json': Promise<string>;
+    } | undefined>;
+    generateTests(): Promise<{
+        [x: string]: string;
+    } | undefined>;
+    generate(): Promise<{
+        'subgraph.yaml': string;
+        'schema.graphql': string;
+        'package.json': string;
         'tsconfig.json'?: undefined;
         src?: undefined;
         abis?: undefined;
         tests?: undefined;
     } | {
-        'package.json': Promise<string>;
-        'subgraph.yaml': Promise<string>;
-        'schema.graphql': Promise<string>;
-        'tsconfig.json': Promise<string>;
+        'package.json': string;
+        'subgraph.yaml': string;
+        'schema.graphql': string;
+        'tsconfig.json': string;
         src: {
             [x: string]: Promise<string>;
         } | undefined;
@@ -59,7 +59,7 @@ export default class Scaffold {
             [x: string]: Promise<string>;
         } | undefined;
         tests: {
-            [x: string]: Promise<string>;
+            [x: string]: string;
         } | undefined;
-    };
+    }>;
 }

package/dist/scaffold/index.js

@@ -29,7 +29,7 @@ class Scaffold {
         this.node = options.node;
         this.spkgPath = options.spkgPath;
     }
-    generatePackageJson() {
+    async generatePackageJson() {
         return prettier_1.default.format(JSON.stringify({
             name: (0, subgraph_1.getSubgraphBasename)(String(this.subgraphName)),
             license: 'UNLICENSED',
@@ -52,7 +52,7 @@ class Scaffold {
             devDependencies: this.protocol.hasEvents() ? { 'matchstick-as': `0.5.0` } : undefined,
         }), { parser: 'json' });
     }
-    generatePackageJsonForSubstreams() {
+    async generatePackageJsonForSubstreams() {
         return prettier_1.default.format(JSON.stringify({
             name: (0, subgraph_1.getSubgraphBasename)(String(this.subgraphName)),
             license: 'UNLICENSED',
@@ -72,7 +72,7 @@ class Scaffold {
             },
         }), { parser: 'json' });
     }
-    generateManifest() {
+    async generateManifest() {
         const protocolManifest = this.protocol.getManifestScaffold();
         return prettier_1.default.format(`
 specVersion: 0.0.5
@@ -86,7 +86,7 @@ dataSources:
     mapping: ${protocolManifest.mapping(this)}
 `, { parser: 'yaml' });
     }
-    generateSchema() {
+    async generateSchema() {
         const hasEvents = this.protocol.hasEvents();
         const events = hasEvents ? (0, schema_1.abiEvents)(this.abi).toJS() : [];
         return prettier_1.default.format(hasEvents && this.indexEvents
@@ -97,7 +97,7 @@ dataSources:
             parser: 'graphql',
         });
     }
-    generateTsConfig() {
+    async generateTsConfig() {
         return prettier_1.default.format(JSON.stringify({
             extends: '@graphprotocol/graph-ts/types/tsconfig.base.json',
             include: ['src', 'tests'],
@@ -108,7 +108,7 @@ dataSources:
             ? { [`${gluegun_1.strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() }
             : undefined;
     }
-    generateMapping() {
+    async generateMapping() {
         const hasEvents = this.protocol.hasEvents();
         const events = hasEvents ? (0, schema_1.abiEvents)(this.abi).toJS() : [];
         const protocolMapping = this.protocol.getMappingScaffold();
@@ -119,7 +119,7 @@ dataSources:
                 events,
             }), { parser: 'typescript', semi: false });
     }
-    generateABIs() {
+    async generateABIs() {
         return this.protocol.hasABIs()
             ? {
                 [`${this.contractName}.json`]: prettier_1.default.format(JSON.stringify(this.abi?.data), {
@@ -128,29 +128,29 @@ dataSources:
             }
             : undefined;
     }
-    generateTests() {
+    async generateTests() {
         const hasEvents = this.protocol.hasEvents();
         const events = hasEvents ? (0, schema_1.abiEvents)(this.abi).toJS() : [];
         return events.length > 0
-            ? (0, tests_1.generateTestsFiles)(this.contractName, events, this.indexEvents)
+            ? await (0, tests_1.generateTestsFiles)(this.contractName, events, this.indexEvents)
             : undefined;
     }
-    generate() {
+    async generate() {
         if (this.protocol.name === 'substreams') {
             return {
-                'subgraph.yaml': this.generateManifest(),
-                'schema.graphql': this.generateSchema(),
-                'package.json': this.generatePackageJsonForSubstreams(),
+                'subgraph.yaml': await this.generateManifest(),
+                'schema.graphql': await this.generateSchema(),
+                'package.json': await this.generatePackageJsonForSubstreams(),
             };
         }
         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.json': await this.generatePackageJson(),
+            'subgraph.yaml': await this.generateManifest(),
+            'schema.graphql': await this.generateSchema(),
+            'tsconfig.json': await this.generateTsConfig(),
+            src: await this.generateMappings(),
+            abis: await this.generateABIs(),
+            tests: await this.generateTests(),
         };
     }
 }

package/dist/scaffold/tests.d.ts

@@ -1,3 +1,3 @@
-export declare const generateTestsFiles: (contract: any, events: any[], indexEvents?: boolean) => {
-    [x: string]: Promise<string>;
-};
+export declare const generateTestsFiles: (contract: any, events: any[], indexEvents?: boolean) => Promise<{
+    [x: string]: string;
+}>;

package/dist/scaffold/tests.js

@@ -15,7 +15,7 @@ const VARIABLES_VALUES = {
     string: 'Example string value',
     bool: true,
 };
-const generateTestsFiles = (contract, events, indexEvents) => {
+const generateTestsFiles = async (contract, events, indexEvents) => {
     const eventsTypes = events
         .flatMap(event => event.inputs.map((input) => {
         // If the asc type is Array<T> we need to check if T is a native type or a custom graph-ts type
@@ -27,8 +27,8 @@ const generateTestsFiles = (contract, events, indexEvents) => {
         .filter(type => !type.startsWith('ethereum.') && !isNativeType(type));
     const importTypes = [...new Set(eventsTypes)].join(', ');
     return {
-        [`${gluegun_1.strings.kebabCase(contract)}.test.ts`]: prettier_1.default.format(generateExampleTest(contract, events[0], indexEvents, importTypes), { parser: 'typescript', semi: false }),
-        [`${gluegun_1.strings.kebabCase(contract)}-utils.ts`]: prettier_1.default.format(generateTestHelper(contract, events, importTypes), { parser: 'typescript', semi: false }),
+        [`${gluegun_1.strings.kebabCase(contract)}.test.ts`]: await prettier_1.default.format(generateExampleTest(contract, events[0], indexEvents, importTypes), { parser: 'typescript', semi: false }),
+        [`${gluegun_1.strings.kebabCase(contract)}-utils.ts`]: await prettier_1.default.format(generateTestHelper(contract, events, importTypes), { parser: 'typescript', semi: false }),
     };
 };
 exports.generateTestsFiles = generateTestsFiles;

package/dist/type-generator.js

@@ -136,7 +136,7 @@ class TypeGenerator {
         return await (0, spinner_1.withSpinner)(`Generate types for GraphQL schema`, `Failed to generate types for GraphQL schema`, `Warnings while generating types for GraphQL schema`, async (spinner) => {
             // Generate TypeScript module from schema
             const codeGenerator = schema.codeGenerator();
-            const code = prettier_1.default.format([
+            const code = await prettier_1.default.format([
                 typescript_1.GENERATED_FILE_NOTE,
                 ...codeGenerator.generateModuleImports(),
                 ...codeGenerator.generateTypes(),
@@ -166,7 +166,7 @@ class TypeGenerator {
                 return codeSegments.concat(codeGenerator.generateTypes());
             }, immutable_1.default.List());
             if (!codeSegments.isEmpty()) {
-                const code = prettier_1.default.format([typescript_1.GENERATED_FILE_NOTE, ...codeSegments].join('\n'), {
+                const code = await prettier_1.default.format([typescript_1.GENERATED_FILE_NOTE, ...codeSegments].join('\n'), {
                     parser: 'typescript',
                 });
                 const outputFile = path_1.default.join(this.options.outputDir, 'templates.ts');

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.61.0",
+  "version": "0.61.1-alpha-20231114172419-d3c3cb4",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.61.0",
+  "version": "0.61.1-alpha-20231114172419-d3c3cb4",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -39,7 +39,7 @@
     "ipfs-http-client": "55.0.0",
     "jayson": "4.0.0",
     "js-yaml": "3.14.1",
-    "prettier": "1.19.1",
+    "prettier": "3.0.3",
     "request": "2.88.2",
     "semver": "7.4.0",
     "sync-request": "6.1.0",