@graphprotocol/graph-cli 0.63.0-alpha-20231206164429-cdb032a → 0.63.0-alpha-20231207185752-5284a6d

package/CHANGELOG.md

@@ -1,9 +1,22 @@
 # @graphprotocol/graph-cli
 
-## 0.63.0-alpha-20231206164429-cdb032a
+## 0.63.0-alpha-20231207185752-5284a6d
 
 ### Minor Changes
 
+- [#1531](https://github.com/graphprotocol/graph-tooling/pull/1531)
+  [`b168be1`](https://github.com/graphprotocol/graph-tooling/commit/b168be1526376fbb386b2ef650813b6696ab59f1)
+  Thanks [@travs](https://github.com/travs)! - Add `--skip-git` option to `init` cli command
+
+- [#1490](https://github.com/graphprotocol/graph-tooling/pull/1490)
+  [`95eb9d0`](https://github.com/graphprotocol/graph-tooling/commit/95eb9d0244a99fdfb7a4750963c1a982d024dd87)
+  Thanks [@mangas](https://github.com/mangas)! - substreams based triggers support
+
+- [#1533](https://github.com/graphprotocol/graph-tooling/pull/1533)
+  [`5284a6d`](https://github.com/graphprotocol/graph-tooling/commit/5284a6df70faa4c35a273c04b7cc1226f2b964a9)
+  Thanks [@saihaj](https://github.com/saihaj)! - adding deprecation notices for commands we plan to
+  change in the next major. See https://github.com/graphprotocol/graph-tooling/issues/1487
+
 - [#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

package/README.md

@@ -70,7 +70,13 @@ well, along with API documentation for the
 
 ## Releases
 
-The Graph CLI is released on [npm](https://www.npmjs.com/package/@graphprotocol/graph-cli) and published as a Binary on [GitHub Releases](https://github.com/graphprotocol/graph-tooling/releases). We support all the version of CLI that support [Maintenance, LTS and Current Node.js releases](https://github.com/nodejs/Release#release-schedule). Additionally if there are `graph-node` specific features that are breaking and no-longer supported, we will drop support for older versions of CLI. After 90 days of a new `Node.js` release, we will drop support for the oldest `Node.js` version.
+The Graph CLI is released on [npm](https://www.npmjs.com/package/@graphprotocol/graph-cli) and
+published as a Binary on [GitHub Releases](https://github.com/graphprotocol/graph-tooling/releases).
+We support all the version of CLI that support
+[Maintenance, LTS and Current Node.js releases](https://github.com/nodejs/Release#release-schedule).
+Additionally if there are `graph-node` specific features that are breaking and no-longer supported,
+we will drop support for older versions of CLI. After 90 days of a new `Node.js` release, we will
+drop support for the oldest `Node.js` version.
 
 End-of-life Releases
 

package/dist/commands/auth.js

@@ -54,10 +54,16 @@ AuthCommand.flags = {
     product: core_1.Flags.string({
         summary: 'Select a product for which to authenticate.',
         options: ['subgraph-studio', 'hosted-service'],
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
+        },
     }),
     studio: core_1.Flags.boolean({
         summary: 'Shortcut for "--product subgraph-studio".',
         exclusive: ['product'],
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
+        },
     }),
 };
 exports.default = AuthCommand;

package/dist/commands/create.d.ts

@@ -1,6 +1,9 @@
 import { Command } from '@oclif/core';
+import { Deprecation } from '@oclif/core/lib/interfaces';
 export default class CreateCommand extends Command {
     static description: string;
+    static state: string;
+    static deprecationOptions: Deprecation;
     static args: {
         'subgraph-name': import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
     };

package/dist/commands/create.js

@@ -57,6 +57,10 @@ class CreateCommand extends core_1.Command {
     }
 }
 CreateCommand.description = 'Registers a subgraph name';
+CreateCommand.state = 'deprecated';
+CreateCommand.deprecationOptions = {
+    message: 'In next major version, this command will be merged as a subcommand for `graph local`.',
+};
 CreateCommand.args = {
     'subgraph-name': core_1.Args.string({
         required: true,

package/dist/commands/deploy.js

@@ -375,9 +375,11 @@ DeployCommand.flags = {
         exclusive: ['access-token'],
     }),
     'access-token': core_1.Flags.string({
-        deprecated: true,
-        summary: 'Graph access key. DEPRECATED: Use "--deploy-key" instead.',
         exclusive: ['deploy-key'],
+        deprecated: {
+            to: 'deploy-key',
+            message: "In next version, we are removing this flag in favor of '--deploy-key'",
+        },
     }),
     'version-label': core_1.Flags.string({
         summary: 'Version label used for the deployment.',

package/dist/commands/init.d.ts

@@ -17,6 +17,7 @@ export default class InitCommand extends Command {
         'contract-name': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         'index-events': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'skip-install': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'skip-git': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'start-block': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         abi: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         spkg: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;

package/dist/commands/init.js

@@ -50,7 +50,7 @@ const initDebugger = (0, debug_1.default)('graph-cli:commands:init');
 class InitCommand extends core_1.Command {
     async run() {
         const { args: { subgraphName, directory }, flags, } = await this.parse(InitCommand);
-        const { protocol, product, studio, node: nodeFlag, 'allow-simple-name': allowSimpleNameFlag, 'from-contract': fromContract, 'contract-name': contractName, 'from-example': fromExample, 'index-events': indexEvents, 'skip-install': skipInstall, network, abi: abiPath, 'start-block': startBlock, spkg: spkgPath, } = flags;
+        const { protocol, product, studio, node: nodeFlag, 'allow-simple-name': allowSimpleNameFlag, 'from-contract': fromContract, 'contract-name': contractName, 'from-example': fromExample, 'index-events': indexEvents, 'skip-install': skipInstall, 'skip-git': skipGit, network, abi: abiPath, 'start-block': startBlock, spkg: spkgPath, } = flags;
         initDebugger('Flags: %O', flags);
         let { node, allowSimpleName } = (0, node_1.chooseNodeUrl)({
             product,
@@ -94,6 +94,7 @@ class InitCommand extends core_1.Command {
                 directory,
                 subgraphName,
                 skipInstall,
+                skipGit,
             }, { commands });
             // Exit with success
             return this.exit(0);
@@ -146,6 +147,7 @@ class InitCommand extends core_1.Command {
                 startBlock,
                 spkgPath,
                 skipInstall,
+                skipGit,
             }, { commands, addContract: false });
             // Exit with success
             return this.exit(0);
@@ -166,6 +168,7 @@ class InitCommand extends core_1.Command {
                 subgraphName: answers.subgraphName,
                 directory: answers.directory,
                 skipInstall,
+                skipGit,
             }, { commands });
         }
         else {
@@ -212,6 +215,7 @@ class InitCommand extends core_1.Command {
                 startBlock: answers.startBlock,
                 spkgPath: answers.spkgPath,
                 skipInstall,
+                skipGit,
             }, { commands, addContract: true });
         }
         // Exit with success
@@ -233,10 +237,16 @@ InitCommand.flags = {
     product: core_1.Flags.string({
         summary: 'Selects the product for which to initialize.',
         options: ['subgraph-studio', 'hosted-service'],
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
+        },
     }),
     studio: core_1.Flags.boolean({
         summary: 'Shortcut for "--product subgraph-studio".',
         exclusive: ['product'],
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
+        },
     }),
     node: core_1.Flags.string({
         summary: 'Graph node for which to initialize.',
@@ -245,6 +255,9 @@ InitCommand.flags = {
     'allow-simple-name': core_1.Flags.boolean({
         description: 'Use a subgraph name without a prefix.',
         default: false,
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/',
+        },
     }),
     'from-contract': core_1.Flags.string({
         description: 'Creates a scaffold based on an existing contract.',
@@ -270,6 +283,13 @@ InitCommand.flags = {
         summary: 'Skip installing dependencies.',
         default: false,
     }),
+    'skip-git': core_1.Flags.boolean({
+        summary: 'Skip initializing a Git repository.',
+        default: false,
+        deprecated: {
+            message: 'In next major version, this flag will be removed. By default we will stop initializing a Git repository.',
+        },
+    }),
     'start-block': core_1.Flags.string({
         helpGroup: 'Scaffold from contract',
         description: 'Block number to start indexing from.',
@@ -730,7 +750,7 @@ Subgraph ${subgraphName} created in ${relativeDir}
 
 Make sure to visit the documentation on https://thegraph.com/docs/ for further information.`);
 }
-async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphName, directory, skipInstall, }, { commands, }) {
+async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphName, directory, skipInstall, skipGit, }, { commands, }) {
     // Fail if the subgraph name is invalid
     if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
         process.exitCode = 1;
@@ -805,10 +825,12 @@ async function initSubgraphFromExample({ fromExample, allowSimpleName, subgraphN
         return;
     }
     // Initialize a fresh Git repository
-    const repo = await initRepository(directory);
-    if (repo !== true) {
-        this.exit(1);
-        return;
+    if (!skipGit) {
+        const repo = await initRepository(directory);
+        if (repo !== true) {
+            this.exit(1);
+            return;
+        }
     }
     // Install dependencies
     if (!skipInstall) {
@@ -826,7 +848,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, startBlock, spkgPath, skipInstall, }, { commands, addContract, }) {
+async function initSubgraphFromContract({ protocolInstance, allowSimpleName, subgraphName, directory, abi, network, contract, indexEvents, contractName, node, startBlock, spkgPath, skipInstall, skipGit, }, { commands, addContract, }) {
     const isSubstreams = protocolInstance.name === 'substreams';
     // Fail if the subgraph name is invalid
     if (!revalidateSubgraphName.bind(this)(subgraphName, { allowSimpleName })) {
@@ -874,10 +896,12 @@ async function initSubgraphFromContract({ protocolInstance, allowSimpleName, sub
         }
     }
     // Initialize a fresh Git repository
-    const repo = await initRepository(directory);
-    if (repo !== true) {
-        this.exit(1);
-        return;
+    if (!skipGit) {
+        const repo = await initRepository(directory);
+        if (repo !== true) {
+            this.exit(1);
+            return;
+        }
     }
     if (!skipInstall) {
         // Install dependencies

package/dist/commands/remove.d.ts

@@ -1,6 +1,9 @@
 import { Command } from '@oclif/core';
+import { Deprecation } from '@oclif/core/lib/interfaces';
 export default class RemoveCommand extends Command {
     static description: string;
+    static state: string;
+    static deprecationOptions: Deprecation;
     static args: {
         'subgraph-name': import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
     };

package/dist/commands/remove.js

@@ -58,6 +58,10 @@ class RemoveCommand extends core_1.Command {
     }
 }
 RemoveCommand.description = 'Unregisters a subgraph name';
+RemoveCommand.state = 'deprecated';
+RemoveCommand.deprecationOptions = {
+    message: 'In next major version, this command will be merged as a subcommand for `graph local`.',
+};
 RemoveCommand.args = {
     'subgraph-name': core_1.Args.string({
         required: true,

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-20231206164429-cdb032a",
+  "version": "0.63.0-alpha-20231207185752-5284a6d",
   "commands": {
     "add": {
       "id": "add",
@@ -86,7 +86,10 @@
           "options": [
             "subgraph-studio",
             "hosted-service"
-          ]
+          ],
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/"
+          }
         },
         "studio": {
           "name": "studio",
@@ -95,7 +98,10 @@
           "allowNo": false,
           "exclusive": [
             "product"
-          ]
+          ],
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/"
+          }
         }
       },
       "args": {
@@ -288,7 +294,11 @@
       "pluginName": "@graphprotocol/graph-cli",
       "pluginAlias": "@graphprotocol/graph-cli",
       "pluginType": "core",
+      "state": "deprecated",
       "aliases": [],
+      "deprecationOptions": {
+        "message": "In next major version, this command will be merged as a subcommand for `graph local`."
+      },
       "flags": {
         "help": {
           "name": "help",
@@ -373,12 +383,14 @@
         "access-token": {
           "name": "access-token",
           "type": "option",
-          "summary": "Graph access key. DEPRECATED: Use \"--deploy-key\" instead.",
           "multiple": false,
           "exclusive": [
             "deploy-key"
           ],
-          "deprecated": true
+          "deprecated": {
+            "to": "deploy-key",
+            "message": "In next version, we are removing this flag in favor of '--deploy-key'"
+          }
         },
         "version-label": {
           "name": "version-label",
@@ -505,7 +517,10 @@
           "options": [
             "subgraph-studio",
             "hosted-service"
-          ]
+          ],
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/"
+          }
         },
         "studio": {
           "name": "studio",
@@ -514,7 +529,10 @@
           "allowNo": false,
           "exclusive": [
             "product"
-          ]
+          ],
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/"
+          }
         },
         "node": {
           "name": "node",
@@ -527,7 +545,10 @@
           "name": "allow-simple-name",
           "type": "boolean",
           "description": "Use a subgraph name without a prefix.",
-          "allowNo": false
+          "allowNo": false,
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will deploy to the Graph Studio. Learn more about Sunrise of Decentralized Data https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/"
+          }
         },
         "from-contract": {
           "name": "from-contract",
@@ -573,6 +594,15 @@
           "summary": "Skip installing dependencies.",
           "allowNo": false
         },
+        "skip-git": {
+          "name": "skip-git",
+          "type": "boolean",
+          "summary": "Skip initializing a Git repository.",
+          "allowNo": false,
+          "deprecated": {
+            "message": "In next major version, this flag will be removed. By default we will stop initializing a Git repository."
+          }
+        },
         "start-block": {
           "name": "start-block",
           "type": "option",
@@ -769,7 +799,11 @@
       "pluginName": "@graphprotocol/graph-cli",
       "pluginAlias": "@graphprotocol/graph-cli",
       "pluginType": "core",
+      "state": "deprecated",
       "aliases": [],
+      "deprecationOptions": {
+        "message": "In next major version, this command will be merged as a subcommand for `graph local`."
+      },
       "flags": {
         "help": {
           "name": "help",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.63.0-alpha-20231206164429-cdb032a",
+  "version": "0.63.0-alpha-20231207185752-5284a6d",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {