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

package/{src/protocols/near/scaffold/mapping.ts → dist/protocols/near/scaffold/mapping.js}

@@ -1,5 +1,7 @@
-export const generatePlaceholderHandlers = () =>
-  `
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePlaceholderHandlers = void 0;
+const generatePlaceholderHandlers = () => `
   import { near, BigInt } from '@graphprotocol/graph-ts'
   import { ExampleEntity } from '../generated/schema'
 
@@ -33,3 +35,4 @@ export const generatePlaceholderHandlers = () =>
     // unchanged, allowing for partial updates to be applied.
   }
 `;
+exports.generatePlaceholderHandlers = generatePlaceholderHandlers;

package/dist/protocols/near/subgraph.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const immutable_1 = __importDefault(require("immutable"));
+class NearSubgraph {
+    manifest;
+    resolveFile;
+    protocol;
+    constructor(options) {
+        this.manifest = options.manifest;
+        this.resolveFile = options.resolveFile;
+        this.protocol = options.protocol;
+    }
+    validateManifest() {
+        return immutable_1.default.List();
+    }
+    handlerTypes() {
+        return immutable_1.default.List(['blockHandlers', 'receiptHandlers']);
+    }
+}
+exports.default = NearSubgraph;

package/dist/protocols/subgraph.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/protocols/substreams/scaffold/manifest.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapping = exports.source = void 0;
+const source = () => `
+      package:
+        moduleName: graph_out
+        file: substreams-eth-block-meta-v0.1.0.spkg`;
+exports.source = source;
+const mapping = () => `
+      apiVersion: 0.0.5
+      kind: substreams/graph-entities`;
+exports.mapping = mapping;

package/dist/protocols/substreams/subgraph.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const immutable_1 = __importDefault(require("immutable"));
+class SubstreamsSubgraph {
+    manifest;
+    resolveFile;
+    protocol;
+    constructor(options) {
+        this.manifest = options.manifest;
+        this.resolveFile = options.resolveFile;
+        this.protocol = options.protocol;
+    }
+    validateManifest() {
+        return immutable_1.default.List();
+    }
+    handlerTypes() {
+        return immutable_1.default.List([]);
+    }
+}
+exports.default = SubstreamsSubgraph;

package/{src/scaffold/cosmos.test.ts → dist/scaffold/cosmos.test.js}

@@ -1,19 +1,20 @@
-import Protocol from '../protocols';
-import Scaffold from './index';
-
-const protocol = new Protocol('cosmos');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const protocols_1 = __importDefault(require("../protocols"));
+const index_1 = __importDefault(require("./index"));
+const protocol = new protocols_1.default('cosmos');
 const scaffoldOptions = {
-  protocol,
-  network: 'cosmoshub-4',
-  contractName: 'CosmosHub',
+    protocol,
+    network: 'cosmoshub-4',
+    contractName: 'CosmosHub',
 };
-
-const scaffold = new Scaffold(scaffoldOptions);
-
+const scaffold = new index_1.default(scaffoldOptions);
 describe('Cosmos subgraph scaffolding', () => {
-  test('Manifest', () => {
-    expect(scaffold.generateManifest()).toEqual(`\
+    test('Manifest', () => {
+        expect(scaffold.generateManifest()).toEqual(`\
 specVersion: 0.0.5
 schema:
   file: ./schema.graphql
@@ -32,20 +33,18 @@ dataSources:
         - handler: handleBlock
       file: ./src/contract.ts
 `);
-  });
-
-  test('Schema (default)', () => {
-    expect(scaffold.generateSchema()).toEqual(`\
+    });
+    test('Schema (default)', () => {
+        expect(scaffold.generateSchema()).toEqual(`\
 type ExampleEntity @entity {
   id: ID!
   block: Bytes!
   count: BigInt!
 }
 `);
-  });
-
-  test('Mapping (default)', () => {
-    expect(scaffold.generateMapping()).toEqual(`\
+    });
+    test('Mapping (default)', () => {
+        expect(scaffold.generateMapping()).toEqual(`\
 import { cosmos, BigInt } from "@graphprotocol/graph-ts"
 import { ExampleEntity } from "../generated/schema"
 
@@ -79,5 +78,5 @@ export function handleBlock(block: cosmos.Block): void {
   // unchanged, allowing for partial updates to be applied.
 }
 `);
-  });
+    });
 });

package/{src/scaffold/ethereum.test.ts → dist/scaffold/ethereum.test.js}

@@ -1,85 +1,76 @@
-import immutable from 'immutable';
-import Protocol from '../protocols';
-import ABI from '../protocols/ethereum/abi';
-import Scaffold from './index';
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const immutable_1 = __importDefault(require("immutable"));
+const protocols_1 = __importDefault(require("../protocols"));
+const abi_1 = __importDefault(require("../protocols/ethereum/abi"));
+const index_1 = __importDefault(require("./index"));
 const TEST_EVENT = {
-  name: 'ExampleEvent',
-  type: 'event',
-  inputs: [
-    { name: 'a', type: 'uint256', indexed: true },
-    { name: 'b', type: 'bytes[4]' },
-    { type: 'string' },
-    {
-      name: 'c',
-      type: 'tuple',
-      components: [
-        { name: 'c1', type: 'uint256' },
-        { type: 'bytes32' },
+    name: 'ExampleEvent',
+    type: 'event',
+    inputs: [
+        { name: 'a', type: 'uint256', indexed: true },
+        { name: 'b', type: 'bytes[4]' },
         { type: 'string' },
         {
-          name: 'c3',
-          type: 'tuple',
-          components: [{ name: 'c31', type: 'uint96' }, { type: 'string' }, { type: 'bytes32' }],
+            name: 'c',
+            type: 'tuple',
+            components: [
+                { name: 'c1', type: 'uint256' },
+                { type: 'bytes32' },
+                { type: 'string' },
+                {
+                    name: 'c3',
+                    type: 'tuple',
+                    components: [{ name: 'c31', type: 'uint96' }, { type: 'string' }, { type: 'bytes32' }],
+                },
+            ],
         },
-      ],
-    },
-    { name: 'd', type: 'string', indexed: true },
-  ],
+        { name: 'd', type: 'string', indexed: true },
+    ],
 };
-
 const OVERLOADED_EVENT = {
-  name: 'ExampleEvent',
-  type: 'event',
-  inputs: [{ name: 'a', type: 'bytes32' }],
+    name: 'ExampleEvent',
+    type: 'event',
+    inputs: [{ name: 'a', type: 'bytes32' }],
 };
-
 const TEST_CONTRACT = {
-  name: 'ExampleContract',
-  type: 'contract',
+    name: 'ExampleContract',
+    type: 'contract',
 };
-
 const TEST_CALLABLE_FUNCTIONS = [
-  {
-    name: 'someVariable',
-    type: 'function',
-    stateMutability: 'view',
-    outputs: [{ type: 'uint256' }],
-  },
-  {
-    name: 'getSomeValue',
-    type: 'function',
-    stateMutability: 'pure',
-    outputs: [{ type: 'tuple', components: [{ type: 'uint256' }] }],
-  },
+    {
+        name: 'someVariable',
+        type: 'function',
+        stateMutability: 'view',
+        outputs: [{ type: 'uint256' }],
+    },
+    {
+        name: 'getSomeValue',
+        type: 'function',
+        stateMutability: 'pure',
+        outputs: [{ type: 'tuple', components: [{ type: 'uint256' }] }],
+    },
 ];
-
-const TEST_ABI = new ABI(
-  'Contract',
-  undefined,
-  immutable.fromJS([TEST_EVENT, OVERLOADED_EVENT, TEST_CONTRACT, ...TEST_CALLABLE_FUNCTIONS]),
-);
-
-const protocol = new Protocol('ethereum');
-
+const TEST_ABI = new abi_1.default('Contract', undefined, immutable_1.default.fromJS([TEST_EVENT, OVERLOADED_EVENT, TEST_CONTRACT, ...TEST_CALLABLE_FUNCTIONS]));
+const protocol = new protocols_1.default('ethereum');
 const scaffoldOptions = {
-  protocol,
-  abi: TEST_ABI,
-  contract: '0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d',
-  network: 'kovan',
-  contractName: 'Contract',
+    protocol,
+    abi: TEST_ABI,
+    contract: '0xf87e31492faf9a91b02ee0deaad50d51d56d5d4d',
+    network: 'kovan',
+    contractName: 'Contract',
 };
-
-const scaffold = new Scaffold(scaffoldOptions);
-
-const scaffoldWithIndexEvents = new Scaffold({
-  ...scaffoldOptions,
-  indexEvents: true,
+const scaffold = new index_1.default(scaffoldOptions);
+const scaffoldWithIndexEvents = new index_1.default({
+    ...scaffoldOptions,
+    indexEvents: true,
 });
-
 describe('Ethereum subgraph scaffolding', () => {
-  test('Manifest', () => {
-    expect(scaffold.generateManifest()).toEqual(`\
+    test('Manifest', () => {
+        expect(scaffold.generateManifest()).toEqual(`\
 specVersion: 0.0.5
 schema:
   file: ./schema.graphql
@@ -107,10 +98,9 @@ dataSources:
           handler: handleExampleEvent1
       file: ./src/contract.ts
 `);
-  });
-
-  test('Schema (default)', () => {
-    expect(scaffold.generateSchema()).toEqual(`\
+    });
+    test('Schema (default)', () => {
+        expect(scaffold.generateSchema()).toEqual(`\
 type ExampleEntity @entity {
   id: Bytes!
   count: BigInt!
@@ -118,10 +108,9 @@ type ExampleEntity @entity {
   b: [Bytes]! # bytes[4]
 }
 `);
-  });
-
-  test('Schema (for indexing events)', () => {
-    expect(scaffoldWithIndexEvents.generateSchema()).toEqual(`\
+    });
+    test('Schema (for indexing events)', () => {
+        expect(scaffoldWithIndexEvents.generateSchema()).toEqual(`\
 type ExampleEvent @entity(immutable: true) {
   id: Bytes!
   a: BigInt! # uint256
@@ -147,10 +136,9 @@ type ExampleEvent1 @entity(immutable: true) {
   transactionHash: Bytes!
 }
 `);
-  });
-
-  test('Mapping (default)', () => {
-    expect(scaffold.generateMapping()).toEqual(`\
+    });
+    test('Mapping (default)', () => {
+        expect(scaffold.generateMapping()).toEqual(`\
 import { BigInt } from "@graphprotocol/graph-ts"
 import {
   Contract,
@@ -204,10 +192,9 @@ 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)', () => {
+        expect(scaffoldWithIndexEvents.generateMapping()).toEqual(`\
 import {
   ExampleEvent as ExampleEventEvent,
   ExampleEvent1 as ExampleEvent1Event
@@ -249,13 +236,12 @@ export function handleExampleEvent1(event: ExampleEvent1Event): void {
   entity.save()
 }
 `);
-  });
-
-  test('Test Files (default)', () => {
-    const files = scaffoldWithIndexEvents.generateTests();
-    const testFile = files?.['contract.test.ts'];
-    const utilsFile = files?.['contract-utils.ts'];
-    expect(testFile).toEqual(`\
+    });
+    test('Test Files (default)', () => {
+        const files = scaffoldWithIndexEvents.generateTests();
+        const testFile = files?.['contract.test.ts'];
+        const utilsFile = files?.['contract-utils.ts'];
+        expect(testFile).toEqual(`\
 import {
   assert,
   describe,
@@ -331,7 +317,7 @@ describe("Describe entity assertions", () => {
   })
 })
 `);
-    expect(utilsFile).toEqual(`\
+        expect(utilsFile).toEqual(`\
 import { newMockEvent } from "matchstick-as"
 import { ethereum, BigInt, Bytes } from "@graphprotocol/graph-ts"
 import { ExampleEvent, ExampleEvent1 } from "../generated/Contract/Contract"
@@ -378,14 +364,12 @@ export function createExampleEvent1Event(a: Bytes): ExampleEvent1 {
   return exampleEvent1Event
 }
 `);
-  });
-
-  test('Test Files (for indexing events)', () => {
-    const files = scaffoldWithIndexEvents.generateTests();
-    const testFile = files?.['contract.test.ts'];
-    const utilsFile = files?.['contract-utils.ts'];
-
-    expect(testFile).toEqual(`\
+    });
+    test('Test Files (for indexing events)', () => {
+        const files = scaffoldWithIndexEvents.generateTests();
+        const testFile = files?.['contract.test.ts'];
+        const utilsFile = files?.['contract-utils.ts'];
+        expect(testFile).toEqual(`\
 import {
   assert,
   describe,
@@ -461,7 +445,7 @@ describe("Describe entity assertions", () => {
   })
 })
 `);
-    expect(utilsFile).toEqual(`\
+        expect(utilsFile).toEqual(`\
 import { newMockEvent } from "matchstick-as"
 import { ethereum, BigInt, Bytes } from "@graphprotocol/graph-ts"
 import { ExampleEvent, ExampleEvent1 } from "../generated/Contract/Contract"
@@ -508,5 +492,5 @@ export function createExampleEvent1Event(a: Bytes): ExampleEvent1 {
   return exampleEvent1Event
 }
 `);
-  });
+    });
 });

package/dist/scaffold/index.js

@@ -0,0 +1,133 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const gluegun_1 = require("gluegun");
+const prettier_1 = __importDefault(require("prettier"));
+const subgraph_1 = require("../command-helpers/subgraph");
+const mapping_1 = require("./mapping");
+const schema_1 = require("./schema");
+const tests_1 = require("./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);
+class Scaffold {
+    protocol;
+    abi;
+    indexEvents;
+    contract;
+    network;
+    contractName;
+    subgraphName;
+    node;
+    constructor(options) {
+        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_1.default.format(JSON.stringify({
+            name: (0, subgraph_1.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_1.default.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 ? (0, schema_1.abiEvents)(this.abi).toJS() : [];
+        return prettier_1.default.format(hasEvents && this.indexEvents
+            ? events.map((event) => (0, schema_1.generateEventType)(event, this.protocol.name)).join('\n\n')
+            : (0, schema_1.generateExampleEntityType)(this.protocol, events), {
+            parser: 'graphql',
+        });
+    }
+    generateTsConfig() {
+        return prettier_1.default.format(JSON.stringify({
+            extends: '@graphprotocol/graph-ts/types/tsconfig.base.json',
+            include: ['src'],
+        }), { parser: 'json' });
+    }
+    generateMappings() {
+        return this.protocol.getMappingScaffold()
+            ? { [`${gluegun_1.strings.kebabCase(this.contractName)}.ts`]: this.generateMapping() }
+            : undefined;
+    }
+    generateMapping() {
+        const hasEvents = this.protocol.hasEvents();
+        const events = hasEvents ? (0, schema_1.abiEvents)(this.abi).toJS() : [];
+        const protocolMapping = this.protocol.getMappingScaffold();
+        return prettier_1.default.format(hasEvents && this.indexEvents
+            ? (0, mapping_1.generateEventIndexingHandlers)(events, this.contractName)
+            : protocolMapping.generatePlaceholderHandlers({
+                ...this,
+                events,
+            }), { parser: 'typescript', semi: false });
+    }
+    generateABIs() {
+        return this.protocol.hasABIs()
+            ? {
+                [`${this.contractName}.json`]: prettier_1.default.format(JSON.stringify(this.abi?.data), {
+                    parser: 'json',
+                }),
+            }
+            : undefined;
+    }
+    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)
+            : 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(),
+        };
+    }
+}
+exports.default = Scaffold;

package/dist/scaffold/mapping.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEventIndexingHandlers = exports.generateEventFieldAssignments = exports.generateFieldAssignments = exports.generateFieldAssignment = void 0;
+const util = __importStar(require("../codegen/util"));
+const generateFieldAssignment = (path) => `entity.${path.join('_')} = event.params.${path.join('.')}`;
+exports.generateFieldAssignment = generateFieldAssignment;
+const generateFieldAssignments = ({ index, input }) => input.type === 'tuple'
+    ? util
+        .unrollTuple({ value: input, index, path: [input.name || `param${index}`] })
+        .map(({ path }) => (0, exports.generateFieldAssignment)(path))
+    : (0, exports.generateFieldAssignment)([input.name || `param${index}`]);
+exports.generateFieldAssignments = generateFieldAssignments;
+const generateEventFieldAssignments = (event) => event.inputs.reduce((acc, input, index) => acc.concat((0, exports.generateFieldAssignments)({ input, index })), []);
+exports.generateEventFieldAssignments = generateEventFieldAssignments;
+const generateEventIndexingHandlers = (events, contractName) => `
+  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()))
+    ${(0, exports.generateEventFieldAssignments)(event).join('\n')}
+
+    entity.blockNumber = event.block.number
+    entity.blockTimestamp = event.block.timestamp
+    entity.transactionHash = event.transaction.hash
+
+    entity.save()
+  }
+    `)
+    .join('\n')}
+`;
+exports.generateEventIndexingHandlers = generateEventIndexingHandlers;