@graphprotocol/graph-cli 0.63.0-alpha-20231204215314-34e2f68 → 0.63.0-alpha-20231206152354-981f2bb

package/CHANGELOG.md

@@ -1,14 +1,24 @@
 # @graphprotocol/graph-cli
 
-## 0.63.0-alpha-20231204215314-34e2f68
+## 0.63.0-alpha-20231206152354-981f2bb
 
 ### Minor Changes
 
+- [#1490](https://github.com/graphprotocol/graph-tooling/pull/1490)
+  [`3fa19c5`](https://github.com/graphprotocol/graph-tooling/commit/3fa19c5b212bff03d57b027f1dbdf80090e69b02)
+  Thanks [@mangas](https://github.com/mangas)! - substreams based triggers support
+
 - [#1524](https://github.com/graphprotocol/graph-tooling/pull/1524)
   [`086a2da`](https://github.com/graphprotocol/graph-tooling/commit/086a2da03a4388277b69b6db541a0673dc9505bb)
   Thanks [@pedropregueiro](https://github.com/pedropregueiro)! - Add support for M3 apple silicon
   for `graph test`
 
+### Patch Changes
+
+- [#1521](https://github.com/graphprotocol/graph-tooling/pull/1521)
+  [`3571a57`](https://github.com/graphprotocol/graph-tooling/commit/3571a571b2a094f41932e7cbc91b605c7ba0962c)
+  Thanks [@saihaj](https://github.com/saihaj)! - remove studio network validation checks
+
 ## 0.62.0
 
 ### Minor Changes

package/dist/commands/deploy.js

@@ -38,7 +38,6 @@ const ipfs_1 = require("../command-helpers/ipfs");
 const jsonrpc_1 = require("../command-helpers/jsonrpc");
 const network_1 = require("../command-helpers/network");
 const node_1 = require("../command-helpers/node");
-const studio_1 = require("../command-helpers/studio");
 const version_1 = require("../command-helpers/version");
 const constants_1 = require("../constants");
 const protocols_1 = __importDefault(require("../protocols"));
@@ -293,27 +292,9 @@ class DeployCommand extends core_1.Command {
                 this.error(`Could not find subgraph manifest at IPFS hash ${ipfsHash}`, { exit: 1 });
             }
             await ipfsClient.pin.add(ipfsHash);
-            try {
-                const dataSourcesAndTemplates = DataSourcesExtractor.fromManifestString(manifestFile);
-                for (const { network } of dataSourcesAndTemplates) {
-                    (0, studio_1.validateStudioNetwork)({ studio, product, network });
-                }
-            }
-            catch (e) {
-                this.error(e, { exit: 1 });
-            }
             await deploySubgraph(ipfsHash);
             return;
         }
-        try {
-            const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest);
-            for (const { network } of dataSourcesAndTemplates) {
-                (0, studio_1.validateStudioNetwork)({ studio, product, network });
-            }
-        }
-        catch (e) {
-            this.error(e, { exit: 1 });
-        }
         let protocol;
         try {
             // Checks to make sure deploy doesn't run against

package/dist/commands/init.js

@@ -37,7 +37,6 @@ const network_1 = require("../command-helpers/network");
 const node_1 = require("../command-helpers/node");
 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"));
@@ -144,8 +143,6 @@ class InitCommand extends core_1.Command {
                 subgraphName,
                 contractName,
                 node,
-                studio,
-                product,
                 startBlock,
                 spkgPath,
                 skipInstall,
@@ -212,8 +209,6 @@ class InitCommand extends core_1.Command {
                 indexEvents: answers.indexEvents,
                 contractName: answers.contractName,
                 node,
-                studio: answers.studio,
-                product: answers.product,
                 startBlock: answers.startBlock,
                 spkgPath: answers.spkgPath,
                 skipInstall,
@@ -831,7 +826,7 @@ async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphN
     }
     printNextSteps.bind(this)({ subgraphName, directory }, { commands });
 }
-async function initSubgraphFromContract({ protocolInstance, allowSimpleName, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, studio, product, startBlock, spkgPath, skipInstall, }, { commands, addContract, }) {
+async function initSubgraphFromContract({ protocolInstance, allowSimpleName, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, startBlock, spkgPath, skipInstall, }, { commands, addContract, }) {
     const isSubstreams = protocolInstance.name === 'substreams';
     // Fail if the subgraph name is invalid
     if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
@@ -849,15 +844,6 @@ async function initSubgraphFromContract({ protocolInstance, allowSimpleName, sub
         // Fail if the ABI does not contain any events
         this.error(`ABI does not contain any events`, { exit: 1 });
     }
-    // We can validate this before the scaffold because we receive
-    // the network from the form or via command line argument.
-    // We don't need to read the manifest in this case.
-    try {
-        (0, studio_1.validateStudioNetwork)({ studio, product, network });
-    }
-    catch (e) {
-        this.error(e, { exit: 1 });
-    }
     // Scaffold subgraph
     const scaffold = await (0, spinner_1.withSpinner)(`Create subgraph scaffold`, `Failed to create subgraph scaffold`, `Warnings while creating subgraph scaffold`, async (spinner) => {
         const scaffold = await (0, scaffold_1.generateScaffold)({

package/dist/compiler/index.js

@@ -374,7 +374,7 @@ class Compiler {
                         return path_1.default.relative(this.options.outputDir, this._writeSubgraphFile(abiFile, JSON.stringify(abiData.data.toJS(), null, 2), this.sourceDir, this.subgraphDir(this.options.outputDir, dataSource), spinner));
                     })));
                 }
-                if (protocol.name == 'substreams') {
+                if (protocol.name == 'substreams' || protocol.name == 'substreams/triggers') {
                     updatedDataSource = updatedDataSource
                         // Write data source ABIs to the output directory
                         .updateIn(['source', 'package'], (substreamsPackage) => substreamsPackage.update('file', (packageFile) => {
@@ -382,6 +382,9 @@ class Compiler {
                         const packageContent = fs_extra_1.default.readFileSync(packageFile);
                         return path_1.default.relative(this.options.outputDir, this._writeSubgraphFile(packageFile, packageContent, this.sourceDir, this.subgraphDir(this.options.outputDir, dataSource), spinner));
                     }));
+                    if (updatedDataSource.getIn(['mapping', 'file'])) {
+                        updatedDataSource = updatedDataSource.updateIn(['mapping', 'file'], (mappingFile) => path_1.default.relative(this.options.outputDir, path_1.default.resolve(this.sourceDir, mappingFile)));
+                    }
                     return updatedDataSource;
                 }
                 // The mapping file is already being written to the output
@@ -435,12 +438,18 @@ class Compiler {
                 }
             }
             // Upload all mappings
-            if (this.protocol.name === 'substreams') {
+            if (this.protocol.name === 'substreams' || this.protocol.name === 'substreams/triggers') {
                 for (const [i, dataSource] of subgraph.get('dataSources').entries()) {
                     updates.push({
                         keyPath: ['dataSources', i, 'source', 'package', 'file'],
                         value: await this._uploadFileToIPFS(dataSource.getIn(['source', 'package', 'file']), uploadedFiles, spinner),
                     });
+                    if (dataSource.getIn(['mapping', 'file'])) {
+                        updates.push({
+                            keyPath: ['dataSources', i, 'mapping', 'file'],
+                            value: await this._uploadFileToIPFS(dataSource.getIn(['mapping', 'file']), uploadedFiles, spinner),
+                        });
+                    }
                 }
             }
             else {

package/dist/protocols/index.d.ts

@@ -6,9 +6,9 @@ export default class Protocol {
     static fromDataSources(dataSourcesAndTemplates: any): Protocol;
     name: ProtocolName;
     config: ProtocolConfig;
-    constructor(name: ProtocolName);
+    constructor(datasource: any);
     static availableProtocols(): immutable.Collection<ProtocolName, string[]>;
-    static availableNetworks(): immutable.Map<"ethereum" | "arweave" | "near" | "cosmos" | "substreams", immutable.List<string>>;
+    static availableNetworks(): immutable.Map<"ethereum" | "arweave" | "near" | "cosmos" | "substreams" | "substreams/triggers", immutable.List<string>>;
     static normalizeName(name: ProtocolName): ProtocolName;
     displayName(): string;
     isValidKindName(kind: string): boolean;
@@ -25,7 +25,7 @@ export default class Protocol {
     getManifestScaffold(): any;
     getMappingScaffold(): any;
 }
-export type ProtocolName = 'arweave' | 'ethereum' | 'near' | 'cosmos' | 'substreams';
+export type ProtocolName = 'arweave' | 'ethereum' | 'near' | 'cosmos' | 'substreams' | 'substreams/triggers';
 export interface ProtocolConfig {
     displayName: string;
     abi?: any;

package/dist/protocols/index.js

@@ -50,11 +50,18 @@ const subgraph_5 = __importDefault(require("./substreams/subgraph"));
 const protocolDebug = (0, debug_1.default)('graph-cli:protocol');
 class Protocol {
     static fromDataSources(dataSourcesAndTemplates) {
-        const firstDataSourceKind = dataSourcesAndTemplates[0].kind;
-        return new Protocol(firstDataSourceKind);
+        const firstDataSource = dataSourcesAndTemplates[0];
+        return new Protocol(firstDataSource);
     }
-    constructor(name) {
+    constructor(datasource) {
+        /**
+         * TODO: we should improve this `any` type, because some places
+         * we can initiate a Protocol with just a string (the name) and
+         * some other places use datasource object
+         */
+        const name = typeof datasource === 'string' ? datasource : datasource.kind;
         this.name = Protocol.normalizeName(name);
+        protocolDebug('Initializing protocol %s', this.name);
         switch (this.name) {
             case 'arweave':
                 this.config = arweaveProtocol;
@@ -70,6 +77,13 @@ class Protocol {
                 break;
             case 'substreams':
                 this.config = substreamsProtocol;
+                /**
+                 * Substreams triggers are a special case of substreams data sources
+                 * which have a mapping file and a handler.
+                 */
+                if (datasource?.mapping?.file && datasource?.mapping.handler) {
+                    this.name = 'substreams/triggers';
+                }
                 break;
             default:
             // Do not throw when undefined, a better error message is printed after the constructor

package/dist/protocols/substreams/manifest.graphql

@@ -32,14 +32,18 @@ type DataSource {
 
 type SubstreamsSource {
   package: SubstreamsPackage!
+  startBlock: BigInt
 }
 
 type SubstreamsPackage {
   moduleName: String!
   file: String!
+  params: String
 }
 
 type SubstreamMapping {
   apiVersion: String!
   kind: String!
+  file: File
+  handler: String
 }

package/dist/subgraph.js

@@ -60,7 +60,9 @@ class Subgraph {
             ]);
         }
         // Parse the default subgraph schema
-        const schema = graphql.parse(await fs_extra_1.default.readFile(path_1.default.join(__dirname, 'protocols', protocol.name, `manifest.graphql`), 'utf-8'));
+        const schema = graphql.parse(await fs_extra_1.default.readFile(path_1.default.join(__dirname, 'protocols', 
+        // TODO: substreams/triggers is a special case, should be handled better
+        protocol.name === 'substreams/triggers' ? 'substreams' : protocol.name, `manifest.graphql`), 'utf-8'));
         // Obtain the root `SubgraphManifest` type from the schema
         const rootType = schema.definitions.find(definition => {
             // @ts-expect-error TODO: name field does not exist on definition, really?

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.63.0-alpha-20231204215314-34e2f68",
+  "version": "0.63.0-alpha-20231206152354-981f2bb",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.63.0-alpha-20231204215314-34e2f68",
+  "version": "0.63.0-alpha-20231206152354-981f2bb",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {

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

@@ -1,6 +0,0 @@
-export declare const allowedStudioNetworks: readonly ["mainnet", "rinkeby", "goerli", "gnosis", "chapel", "optimism-goerli", "clover", "fantom", "matic", "fantom-testnet", "arbitrum-goerli", "fuji", "celo-alfajores", "mumbai", "aurora-testnet", "near-testnet", "optimism", "optimism-goerli", "theta-testnet-001", "osmo-test-4", "base-testnet", "base", "celo", "arbitrum-one", "arbitrum-sepolia", "avalanche", "zksync-era", "zksync-era-testnet", "sepolia", "polygon-zkevm-testnet", "polygon-zkevm", "scroll-sepolia", "scroll"];
-export declare const validateStudioNetwork: ({ studio, product, network, }: {
-    studio?: string | boolean | undefined;
-    product?: string | undefined;
-    network?: string | undefined;
-}) => void;

package/dist/command-helpers/studio.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStudioNetwork = exports.allowedStudioNetworks = void 0;
-exports.allowedStudioNetworks = [
-    'mainnet',
-    'rinkeby',
-    'goerli',
-    'gnosis',
-    'chapel',
-    'optimism-goerli',
-    'clover',
-    'fantom',
-    'matic',
-    'fantom-testnet',
-    'arbitrum-goerli',
-    'fuji',
-    'celo-alfajores',
-    'mumbai',
-    'aurora-testnet',
-    'near-testnet',
-    'optimism',
-    'optimism-goerli',
-    'theta-testnet-001',
-    'osmo-test-4',
-    'base-testnet',
-    'base',
-    'celo',
-    'arbitrum-one',
-    'arbitrum-sepolia',
-    'avalanche',
-    'zksync-era',
-    'zksync-era-testnet',
-    'sepolia',
-    'polygon-zkevm-testnet',
-    'polygon-zkevm',
-    'scroll-sepolia',
-    'scroll',
-];
-const validateStudioNetwork = ({ studio, product, network, }) => {
-    const isStudio = studio || product === 'subgraph-studio';
-    const isAllowedNetwork = !network ||
-        exports.allowedStudioNetworks.includes(
-        // @ts-expect-error we're checking if the network is allowed
-        network);
-    if (isStudio && !isAllowedNetwork) {
-        throw new Error(`The Subgraph Studio only allows subgraphs for these networks: ${exports.allowedStudioNetworks.join(', ')}`);
-    }
-};
-exports.validateStudioNetwork = validateStudioNetwork;

package/dist/command-helpers/studio.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/command-helpers/studio.test.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const studio_1 = require("./studio");
-describe('Version Command Helpers', () => {
-    describe('validateStudioNetwork', () => {
-        describe("When it's studio", () => {
-            test("And it's Ethereum mainnet", () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    studio: true,
-                    network: 'mainnet',
-                })).not.toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-            test("And it's Gnosis chain", () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    studio: true,
-                    network: 'gnosis',
-                })).not.toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-            test('And no network is passed', () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    studio: true,
-                    network: undefined,
-                })).not.toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-            test("And it's NOT an allowed network", () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    product: 'subgraph-studio',
-                    network: 'moonriver',
-                })).toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-        });
-        describe("When it's NOT studio", () => {
-            test("And it's Rinkeby", () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    studio: false,
-                    network: 'rinkeby',
-                })).not.toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-            test("And it's NOT an allowed network", () => {
-                expect(() => (0, studio_1.validateStudioNetwork)({
-                    product: 'hosted-service',
-                    network: 'celo',
-                })).not.toThrow(new Error(`The Subgraph Studio only allows subgraphs for these networks: ${studio_1.allowedStudioNetworks.join(', ')}`));
-            });
-        });
-    });
-});