create-ponder 0.1.7 → 0.1.8

package/dist/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 // src/index.ts
-import { writeFileSync as writeFileSync2 } from "node:fs";
-import path3 from "node:path";
+import { writeFileSync as writeFileSync3 } from "node:fs";
+import path4 from "node:path";
 import { fileURLToPath } from "node:url";
 import { cac } from "cac";
 import cpy from "cpy";
@@ -10,13 +10,13 @@ import { execa } from "execa";
 import fs2 from "fs-extra";
 import { oraPromise } from "ora";
 import pico5 from "picocolors";
-import prettier2 from "prettier";
+import prettier3 from "prettier";
 import { default as prompts } from "prompts";
 
 // package.json
 var package_default = {
   name: "create-ponder",
-  version: "0.1.7",
+  version: "0.1.8",
   type: "module",
   description: "A CLI tool to create Ponder apps",
   license: "MIT",
@@ -48,7 +48,8 @@ var package_default = {
     prompts: "^2.4.2",
     "update-check": "^1.5.4",
     "validate-npm-package-name": "^5.0.0",
-    viem: "^2.0.10"
+    viem: "^2.0.10",
+    yaml: "^2.3.4"
   },
   devDependencies: {
     "@types/fs-extra": "^11.0.4",
@@ -92,6 +93,7 @@ var fromEtherscan = async ({
   etherscanLink,
   etherscanApiKey
 }) => {
+  const warnings = [];
   const apiKey = etherscanApiKey || process.env.ETHERSCAN_API_KEY;
   const explorerUrl = new URL(etherscanLink);
   const chainExplorer = chainExplorerByHostname[explorerUrl.hostname];
@@ -167,6 +169,12 @@ var fromEtherscan = async ({
       if (!apiKey)
         await wait(5e3);
       const { abi, contractName: implContractName } = await getContractAbiAndName(implAddress, apiUrl, apiKey);
+      if (typeof abi !== "string") {
+        warnings.push(
+          `Unable to fetch ABI for implementation contract ${implAddress}. Please see the proxy contract documentation for more details: https://ponder.sh/docs/guides/add-contracts#multiple-abis`
+        );
+        continue;
+      }
       contractName = implContractName;
       abis.push({
         abi: JSON.parse(abi),
@@ -187,9 +195,7 @@ var fromEtherscan = async ({
       abiAbsolutePath,
       await prettier.format(
         `export const ${contractName2}Abi = ${JSON.stringify(abi)} as const`,
-        {
-          parser: "typescript"
-        }
+        { parser: "typescript" }
       )
     );
     if (abis.length === 1) {
@@ -225,7 +231,7 @@ var fromEtherscan = async ({
       }
     }
   };
-  return config;
+  return { config, warnings };
 };
 var fetchEtherscan = async (url) => {
   const maxRetries = 5;
@@ -420,6 +426,143 @@ var ValidationError = class extends Error {
   }
 };
 
+// src/subgraph.ts
+import { mkdirSync as mkdirSync2, writeFileSync as writeFileSync2 } from "node:fs";
+import path3 from "node:path";
+import prettier2 from "prettier";
+import { parse } from "yaml";
+
+// src/helpers/getGraphProtocolChainId.ts
+var chainIdByGraphNetwork = {
+  mainnet: 1,
+  kovan: 42,
+  rinkeby: 4,
+  ropsten: 3,
+  goerli: 5,
+  "poa-core": 99,
+  "poa-sokol": 77,
+  xdai: 100,
+  matic: 137,
+  mumbai: 80001,
+  fantom: 250,
+  "fantom-testnet": 4002,
+  bsc: 56,
+  chapel: -1,
+  clover: 0,
+  avalanche: 43114,
+  fuji: 43113,
+  celo: 42220,
+  "celo-alfajores": 44787,
+  fuse: 122,
+  moonbeam: 1284,
+  moonriver: 1285,
+  mbase: -1,
+  "arbitrum-one": 42161,
+  "arbitrum-rinkeby": 421611,
+  optimism: 10,
+  "optimism-kovan": 69,
+  aurora: 1313161554,
+  "aurora-testnet": 1313161555
+};
+var getGraphProtocolChainId = (networkName) => {
+  return chainIdByGraphNetwork[networkName];
+};
+var subgraphYamlFileNames = ["subgraph.yaml"].concat(
+  Object.keys(chainIdByGraphNetwork).map((n) => `subgraph-${n}.yaml`)
+);
+
+// src/helpers/validateGraphProtocolSource.ts
+var validateGraphProtocolSource = (source) => {
+  return source;
+};
+
+// src/subgraph.ts
+var fetchIpfsFile = async (cid) => {
+  const url = `https://ipfs.network.thegraph.com/api/v0/cat?arg=${cid}`;
+  const response = await fetch(url);
+  const contentRaw = await response.text();
+  return contentRaw;
+};
+var fromSubgraphId = async ({
+  rootDir,
+  subgraphId
+}) => {
+  const manifestRaw = await fetchIpfsFile(subgraphId);
+  const manifest = parse(manifestRaw);
+  const contracts = {};
+  manifest.dataSources.forEach((d) => {
+    contracts[d.name] = {
+      network: d.network,
+      address: d.source.address,
+      startBlock: d.source.startBlock
+    };
+  });
+  const dataSources = manifest.dataSources;
+  mkdirSync2(path3.join(rootDir, "abis"), { recursive: true });
+  mkdirSync2(path3.join(rootDir, "src"), { recursive: true });
+  const abiFiles = dataSources.flatMap((source) => validateGraphProtocolSource(source).mapping.abis).filter(
+    (source, idx, arr) => arr.findIndex((s) => s.name === source.name) === idx
+  );
+  const abis = {};
+  await Promise.all(
+    abiFiles.map(async (abi) => {
+      const abiContent = await fetchIpfsFile(abi.file["/"].slice(6));
+      const abiPath = path3.join(rootDir, `./abis/${abi.name}Abi.ts`);
+      writeFileSync2(
+        abiPath,
+        await prettier2.format(
+          `export const ${abi.name}Abi = ${abiContent} as const`,
+          { parser: "typescript" }
+        )
+      );
+      abis[abi.name] = JSON.parse(abiContent);
+    })
+  );
+  const ponderContracts = dataSources.map((sourceInvalid) => {
+    const source = validateGraphProtocolSource(sourceInvalid);
+    const network = source.network || "mainnet";
+    const chainId = getGraphProtocolChainId(network);
+    if (!chainId || chainId === -1) {
+      throw new Error(`Unhandled network name: ${network}`);
+    }
+    const abiRelativePath = `./abis/${source.source.abi}Abi.ts`;
+    return {
+      name: source.name,
+      network,
+      address: source.source.address,
+      abi: {
+        abi: abis[source.source.abi],
+        dir: abiRelativePath,
+        name: `${source.source.abi}Abi`
+      },
+      startBlock: source.source.startBlock
+    };
+  });
+  const contractsObject = {};
+  const networksObject = {};
+  ponderContracts.forEach((pc) => {
+    contractsObject[pc.name] = pc;
+    networksObject[pc.network] = {
+      chainId: getGraphProtocolChainId(pc.network),
+      transport: `http(process.env.PONDER_RPC_URL_${getGraphProtocolChainId(
+        pc.network
+      )})`
+    };
+    contractsObject[pc.name].name = void 0;
+  });
+  const config = {
+    networks: networksObject,
+    contracts: contractsObject
+  };
+  const warnings = [];
+  if (manifest.templates?.length > 0) {
+    warnings.push(
+      "Factory contract detected. Please see the factory contract documentation for more details: https://ponder.sh/docs/guides/add-contracts#factory-contracts"
+    );
+  }
+  return { config, warnings };
+};
+
 // src/index.ts
 var log2 = console.log;
 var templates = [
@@ -427,7 +570,12 @@ var templates = [
   {
     id: "etherscan",
     title: "Etherscan contract link",
-    description: "Bootstrap from an Etherscan contract link"
+    description: "Create from an Etherscan contract link"
+  },
+  {
+    id: "subgraph",
+    title: "Subgraph ID",
+    description: "Create from a deployed subgraph"
   },
   {
     id: "feature-factory",
@@ -481,6 +629,7 @@ async function run({
 }) {
   if (options.help)
     return;
+  const warnings = [];
   log2();
   log2(
     `Welcome to ${pico5.bold(
@@ -489,7 +638,7 @@ async function run({
   );
   log2();
   const __dirname = fileURLToPath(new URL(".", import.meta.url));
-  const templatesPath = path3.join(__dirname, "..", "templates");
+  const templatesPath = path4.join(__dirname, "..", "templates");
   let templateId = options.template || options.t;
   let templateValidation = await validateTemplateName({
     isNameRequired: false,
@@ -530,8 +679,10 @@ async function run({
   });
   if (!nameValidation.valid)
     throw new ValidationError(nameValidation);
-  if (options.etherscanContractLink && !templateId)
+  if (options.etherscan && !templateId)
     templateId = "etherscan";
+  if (options.subgraph && !templateId)
+    templateId = "subgraph";
   if (!templateId) {
     templateId = (await prompts({
       name: "templateId",
@@ -553,27 +704,42 @@ async function run({
   if (!templateValidation.valid)
     throw new ValidationError(templateValidation);
   let config;
-  const targetPath = path3.join(process.cwd(), projectPath);
-  let link = void 0;
+  const targetPath = path4.join(process.cwd(), projectPath);
+  let url = options.etherscan;
   if (templateMeta.id === "etherscan") {
-    link = options.etherscanContractLink;
-    if (!link) {
+    if (!url) {
       const result = await prompts({
         type: "text",
-        name: "link",
-        message: "Enter a block explorer contract link",
+        name: "url",
+        message: "Enter a block explorer contract url",
         initial: "https://etherscan.io/address/0x97..."
       });
-      link = result.link;
+      url = result.url;
+    }
+  }
+  let subgraph = options.subgraph;
+  if (templateMeta.id === "subgraph") {
+    if (!subgraph) {
+      const result = await prompts({
+        type: "text",
+        name: "id",
+        message: "Enter a subgraph ID",
+        initial: "Qmb3hd2hYd2nWFgcmRswykF1dUBSrDUrinYCgN1dmE1tNy"
+      });
+      subgraph = result.id;
+    }
+    if (!subgraph) {
+      log2(pico5.red("No subgraph ID provided."));
+      process.exit(0);
     }
   }
   log2();
   if (templateMeta.id === "etherscan") {
-    const host = new URL(link).host;
-    config = await oraPromise(
+    const host = new URL(url).host;
+    const result = await oraPromise(
       fromEtherscan({
         rootDir: targetPath,
-        etherscanLink: link,
+        etherscanLink: url,
         etherscanApiKey: options.etherscanApiKey
       }),
       {
@@ -584,9 +750,23 @@ async function run({
         successText: `Fetched contract metadata from ${pico5.bold(host)}.`
       }
     );
+    config = result.config;
+    warnings.push(...result.warnings);
   }
-  const templatePath = path3.join(templatesPath, templateMeta.id);
-  await cpy(path3.join(templatePath, "**", "*"), targetPath, {
+  if (templateMeta.id === "subgraph") {
+    const result = await oraPromise(
+      fromSubgraphId({ rootDir: targetPath, subgraphId: subgraph }),
+      {
+        text: "Fetching subgraph metadata. This may take a few seconds.",
+        failText: "Failed to fetch subgraph metadata.",
+        successText: `Fetched subgraph metadata for ${pico5.bold(subgraph)}.`
+      }
+    );
+    config = result.config;
+    warnings.push(...result.warnings);
+  }
+  const templatePath = path4.join(templatesPath, templateMeta.id);
+  await cpy(path4.join(templatePath, "**", "*"), targetPath, {
     rename: (name) => name.replace(/^_dot_/, ".")
   });
   if (config) {
@@ -594,7 +774,9 @@ async function run({
       import { createConfig${Object.values(config.contracts).some((c) => Array.isArray(c.abi)) ? ", mergeAbis" : ""} } from "@ponder/core";
       import { http } from "viem";
 
-      ${Object.values(config.contracts).flatMap((c) => c.abi).map(
+      ${Object.values(config.contracts).flatMap((c) => c.abi).filter(
+      (tag, index, array) => array.findIndex((t) => t.dir === tag.dir) === index
+    ).map(
       (abi) => `import {${abi.name}} from "${abi.dir.slice(
         0,
         abi.dir.length - 3
@@ -620,14 +802,14 @@ async function run({
     ).replaceAll(/"abi":"(.*?)"/g, "abi:$1")},
       });
     `;
-    writeFileSync2(
-      path3.join(targetPath, "ponder.config.ts"),
-      await prettier2.format(configContent, { parser: "typescript" })
+    writeFileSync3(
+      path4.join(targetPath, "ponder.config.ts"),
+      await prettier3.format(configContent, { parser: "typescript" })
     );
     for (const [name, contract] of Object.entries(config.contracts)) {
       const abi = Array.isArray(contract.abi) ? contract.abi[1].abi : contract.abi.abi;
       const abiEvents = abi.filter(
-        (item) => item.type === "event"
+        (item) => item.type === "event" && !item.anonymous
       );
       const eventNamesToWrite = abiEvents.map((event) => event.name).slice(0, 2);
       const indexingFunctionFileContents = `
@@ -640,20 +822,20 @@ async function run({
           })`
       ).join("\n")}
     `;
-      writeFileSync2(
-        path3.join(targetPath, `./src/${name}.ts`),
-        await prettier2.format(indexingFunctionFileContents, {
+      writeFileSync3(
+        path4.join(targetPath, `./src/${name}.ts`),
+        await prettier3.format(indexingFunctionFileContents, {
           parser: "typescript"
         })
       );
     }
   }
-  const packageJson = await fs2.readJSON(path3.join(targetPath, "package.json"));
+  const packageJson = await fs2.readJSON(path4.join(targetPath, "package.json"));
   packageJson.name = projectName;
   packageJson.dependencies["@ponder/core"] = `^${package_default.version}`;
   packageJson.devDependencies["eslint-config-ponder"] = `^${package_default.version}`;
   await fs2.writeFile(
-    path3.join(targetPath, "package.json"),
+    path4.join(targetPath, "package.json"),
     JSON.stringify(packageJson, null, 2)
   );
   const packageManager = getPackageManager({ options });
@@ -704,13 +886,17 @@ async function run({
       }
     );
   }
+  for (const warning of warnings) {
+    log2();
+    log2(pico5.yellow(warning));
+  }
   log2();
   log2("\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015\u2015");
   log2();
   log2(
     `${pico5.green("Success!")} Created ${pico5.bold(
       projectName
-    )} at ${pico5.green(path3.resolve(projectPath))}`
+    )} at ${pico5.green(path4.resolve(projectPath))}`
   );
   log2();
   log2(
@@ -727,10 +913,13 @@ async function run({
   log2();
 }
 (async () => {
-  const cli = cac(package_default.name).version(package_default.version).usage(`${pico5.green("<project-directory>")} [options]`).option(
-    "-t, --template [name]",
-    `A template to bootstrap with. Available: ${templates.map(({ id }) => id).join(", ")}`
-  ).option("--etherscan-contract-link [link]", "Etherscan contract link").option("--etherscan-api-key [key]", "Etherscan API key").option("--npm", "Use npm as your package manager").option("--pnpm", "Use pnpm as your package manager").option("--yarn", "Use yarn as your package manager").option("--skip-git", "Skips initializing the project as a git repository").help();
+  const cli = cac(package_default.name).version(package_default.version).usage(`${pico5.green("<directory>")} [options]`).option(
+    "-t, --template [id]",
+    `Use a template. Options: ${templates.map(({ id }) => id).join(", ")}`
+  ).option("--etherscan [url]", "Use the Etherscan template").option("--subgraph [id]", "Use the subgraph template").option("--npm", "Use npm as your package manager").option("--pnpm", "Use pnpm as your package manager").option("--yarn", "Use yarn as your package manager").option("--skip-git", "Skip initializing a git repository").option(
+    "--etherscan-api-key [key]",
+    "Etherscan API key for Etherscan template"
+  ).help();
   const _nodeVersion = process.version.split(".");
   const nodeVersion = [
     Number(_nodeVersion[0].slice(1)),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ponder",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "type": "module",
   "description": "A CLI tool to create Ponder apps",
   "license": "MIT",
@@ -27,7 +27,8 @@
     "prompts": "^2.4.2",
     "update-check": "^1.5.4",
     "validate-npm-package-name": "^5.0.0",
-    "viem": "^2.0.10"
+    "viem": "^2.0.10",
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",

package/templates/feature-factory/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/feature-filter/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/feature-multichain/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/feature-proxy/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/feature-read-contract/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/project-friendtech/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/project-uniswap-v3-flash/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/reference-erc20/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/reference-erc721/ponder-env.d.ts

@@ -1,4 +1,6 @@
-// This file is required for type inference and generated by Ponder.
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
 // See https://ponder.sh/docs/guides/typescript for more information.
 
 declare module "@/generated" {

package/templates/subgraph/_dot_env.local

@@ -0,0 +1,5 @@
+# Mainnet RPC URL used for fetching blockchain data. Alchemy is recommended.
+PONDER_RPC_URL_1=
+
+# (Optional) Postgres database URL. If not provided, SQLite will be used. 
+DATABASE_URL=

package/templates/subgraph/_dot_eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "ponder"
+}

package/templates/subgraph/_dot_gitignore

@@ -0,0 +1,18 @@
+# Dependencies
+/node_modules
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# Misc
+.DS_Store
+
+# Env files
+.env*.local
+
+# Ponder
+/generated/
+/.ponder/

package/templates/subgraph/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "ponder-etherscan",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "ponder dev",
+    "start": "ponder start",
+    "codegen": "ponder codegen",
+    "lint": "eslint .",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@ponder/core": "^0.0.95",
+    "viem": "^1.19.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0",
+    "eslint": "^8.53.0",
+    "eslint-config-ponder": "^0.0.95",
+    "typescript": "^5.2.2"
+  },
+  "engines": {
+    "node": ">=18.14"
+  }
+}

package/templates/subgraph/ponder-env.d.ts

@@ -0,0 +1,32 @@
+// This file enables type checking and editor autocomplete for this Ponder project.
+// After upgrading, you may find that changes have been made to this file.
+// If this happens, please commit the changes. Do not manually edit this file.
+// See https://ponder.sh/docs/guides/typescript for more information.
+
+declare module "@/generated" {
+  import type {
+    PonderContext,
+    PonderEvent,
+    PonderEventNames,
+    PonderApp,
+  } from "@ponder/core";
+
+  type Config = typeof import("./ponder.config.ts").default;
+  type Schema = typeof import("./ponder.schema.ts").default;
+
+  export const ponder: PonderApp<Config, Schema>;
+  export type EventNames = PonderEventNames<Config>;
+  export type Event<name extends EventNames = EventNames> = PonderEvent<
+    Config,
+    name
+  >;
+  export type Context<name extends EventNames = EventNames> = PonderContext<
+    Config,
+    Schema,
+    name
+  >;
+  export type IndexingFunctionArgs<name extends EventNames = EventNames> = {
+    event: Event<name>;
+    context: Context<name>;
+  };
+}

package/templates/subgraph/ponder.schema.ts

@@ -0,0 +1,8 @@
+import { createSchema } from "@ponder/core";
+
+export default createSchema((p) => ({
+  Example: p.createTable({
+    id: p.string(),
+    name: p.string().optional(),
+  }),
+}));

package/templates/subgraph/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    // Type checking
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+
+    // Interop constraints
+    "verbatimModuleSyntax": false,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+
+    // Language and environment
+    "moduleResolution": "bundler",
+    "module": "ESNext",
+    "noEmit": true,
+    "lib": ["ES2022"],
+    "target": "ES2022",
+
+    // Skip type checking for node modules
+    "skipLibCheck": true
+  },
+  "include": ["./**/*.ts"],
+  "exclude": ["node_modules"]
+}