Add new datasource type for subgraph composition

Author: incrypto32

packages/cli/src/protocols/index.ts

@@ -20,6 +20,7 @@ import * as NearManifestScaffold from './near/scaffold/manifest';
 import * as NearMappingScaffold from './near/scaffold/mapping';
 import NearSubgraph from './near/subgraph';
 import { SubgraphOptions } from './subgraph';
+import SubgraphDS from './subgraph/subgraph';
 import * as SubstreamsManifestScaffold from './substreams/scaffold/manifest';
 import SubstreamsSubgraph from './substreams/subgraph';
 
@@ -43,6 +44,7 @@ export default class Protocol {
      * some other places use datasource object
      */
     const name = typeof datasource === 'string' ? datasource : datasource.kind;
+    protocolDebug('Initializing protocol with datasource %O', datasource);
     this.name = Protocol.normalizeName(name)!;
     protocolDebug('Initializing protocol %s', this.name);
 
@@ -59,6 +61,9 @@ export default class Protocol {
       case 'near':
         this.config = nearProtocol;
         break;
+      case 'subgraph':
+        this.config = subgraphProtocol;
+        break;
       case 'substreams':
         this.config = substreamsProtocol;
 
@@ -85,6 +90,7 @@ export default class Protocol {
       near: ['near'],
       cosmos: ['cosmos'],
       substreams: ['substreams'],
+      subgraph: ['subgraph'],
     }) as immutable.Collection<ProtocolName, string[]>;
   }
 
@@ -140,14 +146,16 @@ export default class Protocol {
         'uni-3', // Juno testnet
       ],
       substreams: ['mainnet'],
+      subgraph: ['mainnet'],
     }) as immutable.Map<
       | 'arweave'
       | 'ethereum'
       | 'near'
       | 'cosmos'
       | 'substreams'
       // this is temporary, until we have a better way to handle substreams triggers
-      | 'substreams/triggers',
+      | 'substreams/triggers'
+      | 'subgraph',
       immutable.List<string>
     >;
   }
@@ -234,7 +242,8 @@ export type ProtocolName =
   | 'near'
   | 'cosmos'
   | 'substreams'
-  | 'substreams/triggers';
+  | 'substreams/triggers'
+  | 'subgraph';
 
 export interface ProtocolConfig {
   displayName: string;
@@ -290,6 +299,19 @@ const ethereumProtocol: ProtocolConfig = {
   mappingScaffold: EthereumMappingScaffold,
 };
 
+const subgraphProtocol: ProtocolConfig = {
+  displayName: 'Subgraph',
+  abi: undefined,
+  contract: undefined,
+  getTemplateCodeGen: undefined,
+  getTypeGenerator: undefined,
+  getSubgraph(options) {
+    return new SubgraphDS(options);
+  },
+  manifestScaffold: undefined,
+  mappingScaffold: undefined,
+};
+
 const nearProtocol: ProtocolConfig = {
   displayName: 'NEAR',
   abi: undefined,

packages/cli/src/protocols/subgraph/manifest.graphql

@@ -0,0 +1,59 @@
+# Each referenced type's in any of the types below must be listed
+# here either as `scalar` or `type` for the validation code to work
+# properly.
+#
+# That's why `String` is listed as a scalar even though it's built-in
+# GraphQL basic types.
+scalar String
+scalar File
+scalar BigInt
+scalar Boolean
+scalar JSON
+
+type SubgraphManifest {
+  specVersion: String!
+  features: [String!]
+  schema: Schema!
+  description: String
+  repository: String
+  graft: Graft
+  dataSources: [DataSource!]!
+  indexerHints: IndexerHints
+}
+
+type Schema {
+  file: File!
+}
+
+type DataSource {
+  kind: String!
+  name: String!
+  network: String
+  context: JSON
+  source: ContractSource!
+  mapping: ContractMapping!
+}
+
+type ContractSource {
+  address: String!
+  startBlock: BigInt
+}
+
+type ContractMapping {
+  kind: String
+  apiVersion: String!
+  language: String!
+  file: File!
+  entities: [String!]!
+  handlers: [EntityHandler!]
+}
+
+type EntityHandler {
+  handler: String!
+  entity: String!
+}
+
+type Graft {
+  base: String!
+  block: BigInt!
+}

packages/cli/src/protocols/subgraph/scaffold/manifest.ts

@@ -0,0 +1,8 @@
+export const source = ({ spkgPath }: { spkgPath?: string }) => `
+      package:
+        moduleName: graph_out
+        file: ${spkgPath || 'substreams-eth-block-meta-v0.1.0.spkg'}`;
+
+export const mapping = () => `
+      apiVersion: 0.0.5
+      kind: substreams/graph-entities`;

packages/cli/src/protocols/subgraph/subgraph.ts

@@ -0,0 +1,22 @@
+import immutable from 'immutable';
+import { Subgraph, SubgraphOptions } from '../subgraph';
+
+export default class SubgraphDS implements Subgraph {
+  public manifest: SubgraphOptions['manifest'];
+  public resolveFile: SubgraphOptions['resolveFile'];
+  public protocol: SubgraphOptions['protocol'];
+
+  constructor(options: SubgraphOptions) {
+    this.manifest = options.manifest;
+    this.resolveFile = options.resolveFile;
+    this.protocol = options.protocol;
+  }
+
+  validateManifest() {
+    return immutable.List();
+  }
+
+  handlerTypes() {
+    return immutable.List([]);
+  }
+}