Add create-ponder --from-subgraph-id (#110)

* wip: subgraph conversion tool

* feat: add from-subgraph-id template and prompts

* chore: improve log style and simplify bin script

* chore: rename option

* chore: changeset

* fix: change directory to root before git init

* fix: use template passed as option

* fix: allow Bytes and String as id field type

* chore: changeset

* test: add create-ponder subgraph id test

.changeset/curvy-otters-begin.md

@@ -0,0 +1,5 @@
+---
+"create-ponder": patch
+---
+
+Added `--from-subgraph-id` option, renamed `--from-subgraph` to `--from-subgraph-repo`, and added `prompts`

.changeset/stupid-baboons-check.md

@@ -0,0 +1,5 @@
+---
+"@ponder/core": patch
+---
+
+Updated schema definition to allow `Bytes` and `String` types for entity `id` fields

packages/core/src/schema/buildSchema.ts

@@ -225,8 +225,14 @@ const getIdField = (
     throw new Error(`${entityName}.id field must be non-null`);
   }
 
-  if (baseType.name !== "ID") {
-    throw new Error(`${entityName}.id field must have type ID`);
+  if (
+    baseType.name !== "ID" &&
+    baseType.name !== "String" &&
+    baseType.name !== "Bytes"
+  ) {
+    throw new Error(
+      `${entityName}.id field must have type ID, String, or Bytes`
+    );
   }
 
   return <IDField>{

packages/create-ponder/package.json

@@ -8,10 +8,10 @@
     "dist/src"
   ],
   "bin": {
-    "create-ponder": "dist/src/bin/create-ponder"
+    "create-ponder": "dist/src/bin/create-ponder.js"
   },
   "scripts": {
-    "build": "rm -rf dist && tsc && tsconfig-replace-paths --src . && mv dist/src/bin/create-ponder.js dist/src/bin/create-ponder",
+    "build": "rm -rf dist && tsc && tsconfig-replace-paths --src .",
     "test": "$npm_execpath build && export $(grep -v '^#' .env.local | xargs) && jest",
     "typecheck": "tsc --noEmit"
   },
@@ -24,6 +24,8 @@
     "node-fetch": "^2.6.7",
     "picocolors": "^1.0.0",
     "prettier": "^2.6.2",
+    "prompts": "^2.4.2",
+    "rimraf": "^4.1.2",
     "yaml": "^2.1.1"
   },
   "devDependencies": {
@@ -32,6 +34,7 @@
     "@types/node": "^18.7.8",
     "@types/node-fetch": "2",
     "@types/prettier": "^2.7.1",
+    "@types/prompts": "^2.4.2",
     "jest": "^29.3.1",
     "tsconfig-replace-paths": "^0.0.11",
     "typescript": "^4.5.5"

packages/create-ponder/src/bin/create-ponder.ts

@@ -1,57 +1,126 @@
 #!/usr/bin/env node
-/* eslint-disable @typescript-eslint/no-var-requires */
-
 import { cac } from "cac";
 import path from "node:path";
+import prompts from "prompts";
+
+import { CreatePonderOptions, Template, TemplateKind } from "@/common";
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import packageJson from "../../../package.json";
+import { run } from "../index";
 
-const cli = cac(packageJson.name)
-  .version(packageJson.version)
-  .usage("[options]")
-  .help()
-  .option("--dir [path]", "Path to directory for generated project")
-  .option("--from-subgraph [path]", "Path to subgraph directory")
-  .option("--from-etherscan [url]", "Link to etherscan contract page")
-  .option("--etherscan-api-key [key]", "Etherscan API key");
-
-const parsed = cli.parse(process.argv);
-
-const options = parsed.options as {
-  help?: boolean;
-  dir?: string;
-  fromSubgraph?: string;
-  fromEtherscan?: string;
-  etherscanApiKey?: string;
-};
+const createPonder = async () => {
+  const cli = cac(packageJson.name)
+    .version(packageJson.version)
+    .usage("[options]")
+    .help()
+    .option("--dir [path]", "Path to directory for generated project")
+    .option("--from-subgraph-id [id]", "Subgraph deployment ID")
+    .option("--from-subgraph-repo [path]", "Path to subgraph repository")
+    .option("--from-etherscan [url]", "Link to etherscan contract page")
+    .option("--etherscan-api-key [key]", "Etherscan API key");
+
+  const parsed = cli.parse(process.argv);
+
+  const options = parsed.options as {
+    help?: boolean;
+    dir?: string;
+    fromSubgraphId?: string;
+    fromSubgraphRepo?: string;
+    fromEtherscan?: string;
+    etherscanApiKey?: string;
+  };
+
+  if (options.help) {
+    process.exit(0);
+  }
+
+  const { fromEtherscan, fromSubgraphId, fromSubgraphRepo } = options;
+
+  // Validate CLI options.
+  if (
+    (fromSubgraphId && fromSubgraphRepo) ||
+    (fromSubgraphId && fromEtherscan) ||
+    (fromSubgraphRepo && fromEtherscan)
+  ) {
+    throw new Error(
+      `Cannot specify more than one "--from" option:\n  --from-subgraph\n  --from-etherscan-id\n  --from-etherscan-repo`
+    );
+  }
+
+  const { projectName } = await prompts({
+    type: "text",
+    name: "projectName",
+    message: "What is your project named?",
+    initial: "my-app",
+  });
+
+  // Get template from options if provided.
+  let template: Template | undefined = undefined;
+  if (fromEtherscan) {
+    template = { kind: TemplateKind.ETHERSCAN, link: fromEtherscan };
+  }
+  if (fromSubgraphId) {
+    template = { kind: TemplateKind.SUBGRAPH_ID, id: fromSubgraphId };
+  }
+  if (fromSubgraphRepo) {
+    template = { kind: TemplateKind.SUBGRAPH_REPO, path: fromSubgraphRepo };
+  }
+
+  // Get template from prompts if not provided.
+  if (!fromSubgraphId && !fromSubgraphRepo && !fromEtherscan) {
+    const { template: templateKind } = await prompts({
+      type: "select",
+      name: "template",
+      message: "Would you like to use a template for this project?",
+      choices: [
+        { title: "None" },
+        { title: "Etherscan contract link" },
+        { title: "Subgraph ID" },
+        { title: "Subgraph repository" },
+      ],
+    });
+
+    if (templateKind === TemplateKind.ETHERSCAN) {
+      const { link } = await prompts({
+        type: "text",
+        name: "link",
+        message: "Enter an Etherscan contract link",
+        initial: "https://etherscan.io/address/0x97...",
+      });
+      template = { kind: TemplateKind.ETHERSCAN, link };
+    }
+
+    if (templateKind === TemplateKind.SUBGRAPH_ID) {
+      const { id } = await prompts({
+        type: "text",
+        name: "id",
+        message: "Enter a subgraph deployment ID",
+        initial: "QmNus...",
+      });
+      template = { kind: TemplateKind.SUBGRAPH_ID, id };
+    }
+
+    if (templateKind === TemplateKind.SUBGRAPH_REPO) {
+      const { path } = await prompts({
+        type: "text",
+        name: "path",
+        message: "Enter a path to a subgraph repository",
+        initial: "../subgraph",
+      });
+      template = { kind: TemplateKind.SUBGRAPH_REPO, path };
+    }
+  }
+
+  const validatedOptions: CreatePonderOptions = {
+    projectName,
+    rootDir: path.resolve(".", options.dir ? options.dir : projectName),
+    template,
+    etherscanApiKey: options.etherscanApiKey,
+  };
 
-if (options.help) {
-  process.exit(0);
-}
-
-// Validate CLI options.
-if (options.fromSubgraph && options.fromEtherscan) {
-  throw new Error(`Cannot specify more than one "--from" option:
---from-subgraph
---from-etherscan
-`);
-}
-
-export interface CreatePonderOptions {
-  ponderRootDir: string;
-  fromSubgraph?: string;
-  fromEtherscan?: string;
-  etherscanApiKey?: string;
-}
-
-const validatedOptions: CreatePonderOptions = {
-  // Default `dir` to "ponder".
-  ponderRootDir: path.resolve(".", options.dir ? options.dir : "ponder"),
-  fromSubgraph: options.fromSubgraph,
-  fromEtherscan: options.fromEtherscan,
-  etherscanApiKey: options.etherscanApiKey,
+  await run(validatedOptions);
 };
 
-require("../index").run(validatedOptions);
+createPonder();

packages/create-ponder/src/common.ts

@@ -0,0 +1,27 @@
+export enum TemplateKind {
+  NONE,
+  ETHERSCAN,
+  SUBGRAPH_ID,
+  SUBGRAPH_REPO,
+}
+
+export type Template =
+  | {
+      kind: TemplateKind.ETHERSCAN;
+      link: string;
+    }
+  | {
+      kind: TemplateKind.SUBGRAPH_ID;
+      id: string;
+    }
+  | {
+      kind: TemplateKind.SUBGRAPH_REPO;
+      path: string;
+    };
+
+export interface CreatePonderOptions {
+  rootDir: string;
+  projectName: string;
+  template?: Template;
+  etherscanApiKey?: string;
+}

packages/create-ponder/src/helpers/git.ts

@@ -0,0 +1,51 @@
+/* eslint-disable no-empty */
+import { execSync } from "child_process";
+import path from "path";
+import rimraf from "rimraf";
+
+// File adapted from next.js
+// https://github.dev/vercel/next.js/blob/9ad1f321b7902542acd2be041fb2f15f023a0ed9/packages/create-next-app/helpers/git.ts
+
+function isInGitRepository(): boolean {
+  try {
+    execSync("git rev-parse --is-inside-work-tree", { stdio: "ignore" });
+    return true;
+  } catch (_) {}
+  return false;
+}
+
+function isInMercurialRepository(): boolean {
+  try {
+    execSync("hg --cwd . root", { stdio: "ignore" });
+    return true;
+  } catch (_) {}
+  return false;
+}
+
+export function tryGitInit(root: string): boolean {
+  let didInit = false;
+  try {
+    execSync("git --version", { stdio: "ignore" });
+    if (isInGitRepository() || isInMercurialRepository()) {
+      return false;
+    }
+
+    execSync("git init", { stdio: "ignore" });
+    didInit = true;
+
+    execSync("git checkout -b main", { stdio: "ignore" });
+
+    execSync("git add -A", { stdio: "ignore" });
+    execSync('git commit -m "chore: initial commit from create-ponder"', {
+      stdio: "ignore",
+    });
+    return true;
+  } catch (e) {
+    if (didInit) {
+      try {
+        rimraf.sync(path.join(root, ".git"));
+      } catch (_) {}
+    }
+    return false;
+  }
+}

packages/create-ponder/src/helpers/validateGraphProtocolSource.ts

@@ -15,7 +15,7 @@ export type GraphSource = {
     entities: string[]; // Corresponds to entities by name defined in schema.graphql
     abis: {
       name: string;
-      file: string;
+      file: any;
     }[];
     eventHandlers?: {
       event: string;

packages/create-ponder/src/helpers/wait.ts

@@ -0,0 +1,2 @@
+export const wait = (ms: number) =>
+  new Promise((resolve) => setTimeout(resolve, ms));