create-ponder 0.0.37 → 0.0.38

package/dist/src/index.js

@@ -1,154 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-const ethers_1 = require("ethers");
-const node_child_process_1 = require("node:child_process");
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const picocolors_1 = __importDefault(require("picocolors"));
-const prettier_1 = __importDefault(require("prettier"));
-const common_1 = require("./common");
-const detectPackageManager_1 = require("./helpers/detectPackageManager");
-const git_1 = require("./helpers/git");
-const basic_1 = require("./templates/basic");
-const etherscan_1 = require("./templates/etherscan");
-const subgraphId_1 = require("./templates/subgraphId");
-const subgraphRepo_1 = require("./templates/subgraphRepo");
-const run = async (options, overrides = {}) => {
-    const { rootDir } = options;
-    // Create required directories.
-    (0, node_fs_1.mkdirSync)(node_path_1.default.join(rootDir, "abis"), { recursive: true });
-    (0, node_fs_1.mkdirSync)(node_path_1.default.join(rootDir, "src"), { recursive: true });
-    let ponderConfig;
-    console.log(`\nCreating a new Ponder app in ${picocolors_1.default.bold(picocolors_1.default.green(rootDir))}.`);
-    switch (options.template?.kind) {
-        case common_1.TemplateKind.ETHERSCAN: {
-            console.log(`\nUsing ${picocolors_1.default.cyan("Etherscan contract link")} template.`);
-            ponderConfig = await (0, etherscan_1.fromEtherscan)({
-                rootDir,
-                etherscanLink: options.template.link,
-                etherscanApiKey: options.etherscanApiKey,
-            });
-            break;
-        }
-        case common_1.TemplateKind.SUBGRAPH_ID: {
-            console.log(`\nUsing ${picocolors_1.default.cyan("Subgraph ID")} template.`);
-            ponderConfig = await (0, subgraphId_1.fromSubgraphId)({
-                rootDir,
-                subgraphId: options.template.id,
-            });
-            break;
-        }
-        case common_1.TemplateKind.SUBGRAPH_REPO: {
-            console.log(`\nUsing ${picocolors_1.default.cyan("Subgraph repository")} template.`);
-            ponderConfig = (0, subgraphRepo_1.fromSubgraphRepo)({
-                rootDir,
-                subgraphPath: options.template.path,
-            });
-            break;
-        }
-        default: {
-            ponderConfig = (0, basic_1.fromBasic)({ rootDir });
-            break;
-        }
-    }
-    // Write the handler ts files.
-    ponderConfig.contracts.forEach((contract) => {
-        const abi = (0, node_fs_1.readFileSync)(node_path_1.default.join(rootDir, contract.abi), {
-            encoding: "utf-8",
-        });
-        const abiInterface = new ethers_1.ethers.utils.Interface(abi);
-        const eventNames = Object.keys(abiInterface.events).map((signature) => signature.slice(0, signature.indexOf("(")));
-        const eventNamesToWrite = eventNames.slice(0, 2);
-        const handlerFileContents = `
-      import { ponder } from '../generated'
-
-      ${eventNamesToWrite
-            .map((eventName) => `
-          ponder.on("${contract.name}:${eventName}", async ({ event, context }) => {
-            console.log(event.params)
-          })`)
-            .join("\n")}
-    `;
-        (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, `./src/${contract.name}.ts`), prettier_1.default.format(handlerFileContents, { parser: "typescript" }));
-    });
-    // Write the ponder.config.ts file.
-    const finalPonderConfig = `
-    import type { PonderConfig } from "@ponder/core";
-
-    export const config: PonderConfig = {
-      networks: ${JSON.stringify(ponderConfig.networks).replaceAll(/"process.env.PONDER_RPC_URL_(.*?)"/g, "process.env.PONDER_RPC_URL_$1")},
-      contracts: ${JSON.stringify(ponderConfig.contracts)},
-    };
-  `;
-    (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, "ponder.config.ts"), prettier_1.default.format(finalPonderConfig, { parser: "babel" }));
-    // Write the .env.local file.
-    const uniqueChainIds = Array.from(new Set(ponderConfig.networks.map((n) => n.chainId)));
-    const envLocal = `${uniqueChainIds.map((chainId) => `PONDER_RPC_URL_${chainId}=""\n`)}`;
-    (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, ".env.local"), envLocal);
-    // Write the package.json file.
-    const packageJson = `
-    {
-      "private": true,
-      "scripts": {
-        "dev": "ponder dev",
-        "start": "ponder start",
-        "codegen": "ponder codegen"
-      },
-      "dependencies": {
-        "@ponder/core": "latest"
-      },
-      "devDependencies": {
-        "@types/node": "^18.11.18",
-        "ethers": "^5.6.9"
-      },
-      "engines": {
-        "node": ">=16.0.0 <19.0.0"
-      }
-    }
-  `;
-    (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, "package.json"), prettier_1.default.format(packageJson, { parser: "json" }));
-    // Write the tsconfig.json file.
-    const tsConfig = `
-    {
-      "compilerOptions": {
-        "target": "esnext",
-        "module": "esnext",
-        "esModuleInterop": true,
-        "strict": true,
-        "moduleResolution": "node"
-      },
-      "include": ["./**/*.ts"],
-      "exclude": ["node_modules"]
-    }
-  `;
-    (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, "tsconfig.json"), prettier_1.default.format(tsConfig, { parser: "json" }));
-    // Write the .gitignore file.
-    (0, node_fs_1.writeFileSync)(node_path_1.default.join(rootDir, ".gitignore"), `node_modules/\n.DS_Store\n\n.env.local\n.ponder/\ngenerated/`);
-    const packageManager = await (0, detectPackageManager_1.detect)();
-    const runCommand = packageManager === "npm" ? `${packageManager} run` : packageManager;
-    // Install packages.
-    console.log(picocolors_1.default.bold(`\nInstalling with ${packageManager}.`));
-    const installCommand = overrides.installCommand
-        ? overrides.installCommand
-        : `${packageManager} install`;
-    (0, node_child_process_1.execSync)(installCommand, {
-        cwd: rootDir,
-        stdio: "inherit",
-    });
-    // Intialize git repository
-    process.chdir(rootDir);
-    (0, git_1.tryGitInit)(rootDir);
-    console.log(`\nInitialized a git repository.`);
-    // Run codegen.
-    (0, node_child_process_1.execSync)(`${runCommand} --silent codegen --silent`, {
-        cwd: rootDir,
-        stdio: "inherit",
-    });
-    console.log(`\nGenerated types.`);
-    console.log(picocolors_1.default.green("\nSuccess! ") + `Created ${options.projectName} at ${rootDir}`);
-};
-exports.run = run;

package/dist/src/templates/basic.d.ts

@@ -1,4 +0,0 @@
-import type { PartialPonderConfig } from "../index";
-export declare const fromBasic: ({ rootDir }: {
-    rootDir: string;
-}) => PartialPonderConfig;

package/dist/src/templates/basic.js

@@ -1,50 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromBasic = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const prettier_1 = __importDefault(require("prettier"));
-const fromBasic = ({ rootDir }) => {
-    const abiFileContents = `[]`;
-    const abiRelativePath = "./abis/ExampleContract.json";
-    const abiAbsolutePath = node_path_1.default.join(rootDir, abiRelativePath);
-    (0, node_fs_1.writeFileSync)(abiAbsolutePath, abiFileContents);
-    const schemaGraphqlFileContents = `
-    type ExampleToken @entity {
-      id: ID!
-      tokenId: Int!
-      trait: TokenTrait!
-    }
-    enum TokenTrait {
-      GOOD
-      BAD
-    }
-  `;
-    // Generate the schema.graphql file.
-    const ponderSchemaFilePath = node_path_1.default.join(rootDir, "schema.graphql");
-    (0, node_fs_1.writeFileSync)(ponderSchemaFilePath, prettier_1.default.format(schemaGraphqlFileContents, { parser: "graphql" }));
-    // Build the partial ponder config.
-    const ponderConfig = {
-        networks: [
-            {
-                name: "mainnet",
-                chainId: 1,
-                rpcUrl: `process.env.PONDER_RPC_URL_1`,
-            },
-        ],
-        contracts: [
-            {
-                name: "ExampleContract",
-                network: "mainnet",
-                address: "0x0",
-                abi: abiRelativePath,
-                startBlock: 1234567,
-            },
-        ],
-    };
-    return ponderConfig;
-};
-exports.fromBasic = fromBasic;

package/dist/src/templates/etherscan.d.ts

@@ -1,6 +0,0 @@
-import type { PartialPonderConfig } from "src/index";
-export declare const fromEtherscan: ({ rootDir, etherscanLink, etherscanApiKey, }: {
-    rootDir: string;
-    etherscanLink: string;
-    etherscanApiKey?: string | undefined;
-}) => Promise<PartialPonderConfig>;

package/dist/src/templates/etherscan.js

@@ -1,112 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromEtherscan = void 0;
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const node_fetch_1 = __importDefault(require("node-fetch"));
-const prettier_1 = __importDefault(require("prettier"));
-const getEtherscanChainId_1 = require("../helpers/getEtherscanChainId");
-const wait_1 = require("../helpers/wait");
-const fromEtherscan = async ({ rootDir, etherscanLink, etherscanApiKey, }) => {
-    const apiKey = etherscanApiKey || process.env.ETHERSCAN_API_KEY;
-    const url = new URL(etherscanLink);
-    const network = (0, getEtherscanChainId_1.getNetworkByEtherscanHostname)(url.hostname);
-    if (!network) {
-        throw new Error(`Unrecognized etherscan hostname: ${url.hostname}`);
-    }
-    const { name, chainId, apiUrl } = network;
-    const contractAddress = url.pathname.slice(1).split("/")[1];
-    const txHash = await getContractCreationTxn(contractAddress, apiUrl, apiKey);
-    if (!apiKey) {
-        console.log("\n(1/2) Waiting 5 seconds for Etherscan API rate limit");
-        await (0, wait_1.wait)(5000);
-    }
-    const blockNumber = await getTxBlockNumber(txHash, apiUrl, apiKey);
-    if (!apiKey) {
-        console.log("(2/2) Waiting 5 seconds for Etherscan API rate limit");
-        await (0, wait_1.wait)(5000);
-    }
-    const { abi, contractName } = await getContractAbiAndName(contractAddress, apiUrl, apiKey);
-    // Write contract ABI file.
-    const abiRelativePath = `./abis/${contractName}.json`;
-    const abiAbsolutePath = node_path_1.default.join(rootDir, abiRelativePath);
-    (0, node_fs_1.writeFileSync)(abiAbsolutePath, prettier_1.default.format(abi, { parser: "json" }));
-    const schemaGraphqlFileContents = `
-    type ExampleEntity @entity {
-      id: ID!
-      name: String!
-    }
-  `;
-    // Generate the schema.graphql file.
-    const ponderSchemaFilePath = node_path_1.default.join(rootDir, "schema.graphql");
-    (0, node_fs_1.writeFileSync)(ponderSchemaFilePath, prettier_1.default.format(schemaGraphqlFileContents, { parser: "graphql" }));
-    // Build and return the partial ponder config.
-    const ponderConfig = {
-        networks: [
-            {
-                name: name,
-                chainId: chainId,
-                rpcUrl: `process.env.PONDER_RPC_URL_${chainId}`,
-            },
-        ],
-        contracts: [
-            {
-                name: contractName,
-                network: name,
-                abi: abiRelativePath,
-                address: contractAddress,
-                startBlock: blockNumber,
-            },
-        ],
-    };
-    return ponderConfig;
-};
-exports.fromEtherscan = fromEtherscan;
-const fetchEtherscan = async (url) => {
-    const response = await (0, node_fetch_1.default)(url);
-    const data = await response.json();
-    if (data.status === "0") {
-        throw new Error(`Etherscan API error: ${data.result}`);
-    }
-    return data;
-};
-const getContractCreationTxn = async (contractAddress, apiUrl, apiKey) => {
-    const searchParams = new URLSearchParams({
-        module: "contract",
-        action: "getcontractcreation",
-        contractaddresses: contractAddress,
-    });
-    if (apiKey)
-        searchParams.append("apikey", apiKey);
-    const data = await fetchEtherscan(`${apiUrl}?${searchParams.toString()}`);
-    return data.result[0].txHash;
-};
-const getTxBlockNumber = async (txHash, apiUrl, apiKey) => {
-    const searchParams = new URLSearchParams({
-        module: "proxy",
-        action: "eth_getTransactionByHash",
-        txhash: txHash,
-    });
-    if (apiKey)
-        searchParams.append("apikey", apiKey);
-    const data = await fetchEtherscan(`${apiUrl}?${searchParams.toString()}`);
-    const hexBlockNumber = data.result.blockNumber;
-    return parseInt(hexBlockNumber.slice(2), 16);
-};
-const getContractAbiAndName = async (contractAddress, apiUrl, apiKey) => {
-    const searchParams = new URLSearchParams({
-        module: "contract",
-        action: "getsourcecode",
-        address: contractAddress,
-    });
-    if (apiKey)
-        searchParams.append("apikey", apiKey);
-    const data = await fetchEtherscan(`${apiUrl}?${searchParams.toString()}`);
-    const abi = data.result[0].ABI;
-    const contractName = data.result[0].ContractName;
-    return { abi, contractName };
-};

package/dist/src/templates/subgraphId.d.ts

@@ -1,5 +0,0 @@
-import type { PartialPonderConfig } from "src/index";
-export declare const fromSubgraphId: ({ rootDir, subgraphId, }: {
-    rootDir: string;
-    subgraphId: string;
-}) => Promise<PartialPonderConfig>;

package/dist/src/templates/subgraphId.js

@@ -1,72 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromSubgraphId = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const node_fetch_1 = __importDefault(require("node-fetch"));
-const prettier_1 = __importDefault(require("prettier"));
-const yaml_1 = require("yaml");
-const getGraphProtocolChainId_1 = require("../helpers/getGraphProtocolChainId");
-const validateGraphProtocolSource_1 = require("../helpers/validateGraphProtocolSource");
-const fetchIpfsFile = async (cid) => {
-    const url = `https://ipfs.network.thegraph.com/api/v0/cat?arg=${cid}`;
-    const response = await (0, node_fetch_1.default)(url);
-    const contentRaw = await response.text();
-    return contentRaw;
-};
-const fromSubgraphId = async ({ rootDir, subgraphId, }) => {
-    const ponderNetworks = [];
-    let ponderContracts = [];
-    // Fetch the manifest file.
-    const manifestRaw = await fetchIpfsFile(subgraphId);
-    const manifest = (0, yaml_1.parse)(manifestRaw);
-    // Fetch and write the schema.graphql file.
-    const schemaCid = manifest.schema.file["/"].slice(6);
-    const schemaRaw = await fetchIpfsFile(schemaCid);
-    const ponderSchemaFilePath = node_path_1.default.join(rootDir, "schema.graphql");
-    (0, node_fs_1.writeFileSync)(ponderSchemaFilePath, prettier_1.default.format(schemaRaw, { parser: "graphql" }));
-    const dataSources = manifest.dataSources.map(validateGraphProtocolSource_1.validateGraphProtocolSource);
-    // Fetch and write all referenced ABIs.
-    const abiFiles = dataSources
-        .map((source) => source.mapping.abis)
-        .flat()
-        .filter((source, idx, arr) => arr.findIndex((s) => s.name === source.name) === idx);
-    await Promise.all(abiFiles.map(async (abi) => {
-        const abiContent = await fetchIpfsFile(abi.file["/"].slice(6));
-        const abiPath = node_path_1.default.join(rootDir, `./abis/${abi.name}.json`);
-        (0, node_fs_1.writeFileSync)(abiPath, prettier_1.default.format(abiContent, { parser: "json" }));
-    }));
-    // Build the ponder sources.
-    ponderContracts = dataSources.map((source) => {
-        const network = source.network || "mainnet";
-        const chainId = (0, getGraphProtocolChainId_1.getGraphProtocolChainId)(network);
-        if (!chainId || chainId === -1) {
-            throw new Error(`Unhandled network name: ${network}`);
-        }
-        if (!ponderNetworks.map((n) => n.name).includes(network)) {
-            ponderNetworks.push({
-                name: network,
-                chainId: chainId,
-                rpcUrl: `process.env.PONDER_RPC_URL_${chainId}`,
-            });
-        }
-        const abiRelativePath = `./abis/${source.source.abi}.json`;
-        return {
-            name: source.name,
-            network: network,
-            address: source.source.address,
-            abi: abiRelativePath,
-            startBlock: source.source.startBlock,
-        };
-    });
-    // Build the partial ponder config.
-    const ponderConfig = {
-        networks: ponderNetworks,
-        contracts: ponderContracts,
-    };
-    return ponderConfig;
-};
-exports.fromSubgraphId = fromSubgraphId;

package/dist/src/templates/subgraphRepo.d.ts

@@ -1,5 +0,0 @@
-import type { PartialPonderConfig } from "../index";
-export declare const fromSubgraphRepo: ({ rootDir, subgraphPath, }: {
-    rootDir: string;
-    subgraphPath: string;
-}) => PartialPonderConfig;

package/dist/src/templates/subgraphRepo.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromSubgraphRepo = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const yaml_1 = require("yaml");
-const getGraphProtocolChainId_1 = require("../helpers/getGraphProtocolChainId");
-const validateGraphProtocolSource_1 = require("../helpers/validateGraphProtocolSource");
-const fromSubgraphRepo = ({ rootDir, subgraphPath, }) => {
-    const subgraphRootDir = node_path_1.default.resolve(subgraphPath);
-    const ponderNetworks = [];
-    let ponderContracts = [];
-    // If the `--from-subgraph` option was passed, parse subgraph files
-    const subgraphRootDirPath = node_path_1.default.resolve(subgraphRootDir);
-    // Read and parse the subgraph YAML file.
-    let subgraphYamlRaw = "";
-    for (const subgraphYamlFileName of getGraphProtocolChainId_1.subgraphYamlFileNames) {
-        try {
-            subgraphYamlRaw = (0, node_fs_1.readFileSync)(node_path_1.default.join(subgraphRootDirPath, subgraphYamlFileName), {
-                encoding: "utf-8",
-            });
-            break;
-        }
-        catch (e) {
-            continue;
-        }
-    }
-    if (subgraphYamlRaw === "") {
-        throw new Error(`subgraph.yaml file not found`);
-    }
-    const subgraphYaml = (0, yaml_1.parse)(subgraphYamlRaw);
-    // Copy over the schema.graphql file.
-    const subgraphSchemaFilePath = node_path_1.default.join(subgraphRootDirPath, subgraphYaml.schema.file);
-    const ponderSchemaFilePath = node_path_1.default.join(rootDir, "schema.graphql");
-    (0, node_fs_1.copyFileSync)(subgraphSchemaFilePath, ponderSchemaFilePath);
-    // Build the ponder sources. Also copy over the ABI files for each source.
-    ponderContracts = subgraphYaml.dataSources
-        .map(validateGraphProtocolSource_1.validateGraphProtocolSource)
-        .map((source) => {
-        const abiPath = source.mapping.abis.find((abi) => abi.name === source.name)?.file;
-        if (!abiPath) {
-            throw new Error(`ABI path not found for source: ${source.name}`);
-        }
-        const network = source.network || "mainnet";
-        const chainId = (0, getGraphProtocolChainId_1.getGraphProtocolChainId)(network);
-        if (!chainId || chainId === -1) {
-            throw new Error(`Unhandled network name: ${network}`);
-        }
-        if (!ponderNetworks.map((n) => n.name).includes(network)) {
-            ponderNetworks.push({
-                name: network,
-                chainId: chainId,
-                rpcUrl: `process.env.PONDER_RPC_URL_${chainId}`,
-            });
-        }
-        // Copy the ABI file.
-        const abiAbsolutePath = node_path_1.default.join(subgraphRootDirPath, abiPath);
-        const abiFileName = node_path_1.default.basename(abiPath);
-        const ponderAbiRelativePath = `./abis/${abiFileName}`;
-        const ponderAbiAbsolutePath = node_path_1.default.join(rootDir, ponderAbiRelativePath);
-        (0, node_fs_1.copyFileSync)(abiAbsolutePath, ponderAbiAbsolutePath);
-        return {
-            name: source.name,
-            network: network,
-            address: source.source.address,
-            abi: ponderAbiRelativePath,
-            startBlock: source.source.startBlock,
-        };
-    });
-    // Build the partial ponder config.
-    const ponderConfig = {
-        networks: ponderNetworks,
-        contracts: ponderContracts,
-    };
-    return ponderConfig;
-};
-exports.fromSubgraphRepo = fromSubgraphRepo;