create-eclesia-indexer 1.0.2

package/bin/create-eclesia-indexer.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+// This is a simple shim that points to the built CLI
+import '../dist/index.js';

package/dist/index.cjs

@@ -0,0 +1,382 @@
+#!/usr/bin/env node
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let node_fs = require("node:fs");
+node_fs = __toESM(node_fs);
+let node_path = require("node:path");
+node_path = __toESM(node_path);
+let node_url = require("node:url");
+node_url = __toESM(node_url);
+let picocolors = require("picocolors");
+picocolors = __toESM(picocolors);
+let enquirer = require("enquirer");
+enquirer = __toESM(enquirer);
+let fs_extra = require("fs-extra");
+fs_extra = __toESM(fs_extra);
+
+//#region src/create-indexer.ts
+const { prompt } = enquirer.default;
+const { ensureDirSync, copySync, writeFileSync, readFileSync } = fs_extra.default;
+const __filename$2 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
+const __dirname$1 = (0, node_path.dirname)(__filename$2);
+const availableModules = [
+	{
+		name: "Auth",
+		value: "auth",
+		hint: "Account and authentication data"
+	},
+	{
+		name: "Bank",
+		value: "bank",
+		hint: "Token transfers and balances"
+	},
+	{
+		name: "Staking",
+		value: "staking",
+		hint: "Validator and delegation data"
+	}
+];
+const minimalAvailableModules = [{
+	name: "Auth",
+	value: "auth",
+	hint: "Account and authentication data"
+}, {
+	name: "Bank",
+	value: "bank",
+	hint: "Token transfers and balances"
+}];
+async function createIndexer(initialProjectName) {
+	const config = await gatherProjectInfo(initialProjectName);
+	const targetDir = (0, node_path.resolve)(process.cwd(), config.projectName);
+	console.log(picocolors.default.blue("📁 Creating project directory..."));
+	ensureDirSync(targetDir);
+	console.log(picocolors.default.blue("📋 Copying files..."));
+	await copyTemplateFiles(config, targetDir);
+	console.log(picocolors.default.blue("🔧 Processing template variables..."));
+	await processTemplates(config, targetDir);
+	console.log(picocolors.default.blue("📦 Installing dependencies..."));
+	await installDependencies(config, targetDir);
+	console.log(picocolors.default.blue("📦 Building..."));
+	await buildProject(config, targetDir);
+	console.log();
+	console.log(picocolors.default.green("🎉 Your indexer is ready!"));
+	console.log();
+	console.log("Next steps:");
+	console.log(picocolors.default.cyan(`  cd ${config.projectName}`));
+	console.log(picocolors.default.cyan(`  ${config.packageManager} local-dev:start # To run a self-contained local development environment with Postgres`));
+	console.log();
+	console.log("If you want to run the indexer against an external Postgres database instead of the local development environment, set the database connection string in the .env file.");
+	console.log();
+	console.log(picocolors.default.cyan(`  ${config.packageManager} start # To run the indexer`));
+	console.log();
+	console.log("Happy indexing!");
+	console.log();
+}
+async function gatherProjectInfo(initialProjectName) {
+	const answers1 = await prompt([
+		{
+			type: "input",
+			name: "projectName",
+			message: "Project name:",
+			initial: initialProjectName || "my-indexer",
+			skip: !!initialProjectName
+		},
+		{
+			type: "input",
+			name: "chainName",
+			message: "Chain name:",
+			initial: "cosmos-hub"
+		},
+		{
+			type: "input",
+			name: "chainPrefix",
+			message: "Chain address prefix:",
+			initial: "cosmos"
+		},
+		{
+			type: "input",
+			name: "description",
+			message: "Description:",
+			initial: "A custom Cosmos SDK chain indexer"
+		},
+		{
+			type: "input",
+			name: "rpcEndpoint",
+			message: "RPC endpoint:",
+			initial: "https://rpc.cosmos.network",
+			validate: (value) => {
+				try {
+					const url = new URL(value);
+					if (url.protocol === "http:" || url.protocol === "https:" || url.protocol === "ws:" || url.protocol === "wss:") return true;
+					return "Please enter a valid HTTP/HTTPS/WS/WSS URL.";
+				} catch (err) {
+					return "Please enter a valid URL: " + err;
+				}
+			}
+		},
+		{
+			type: "toggle",
+			name: "minimal",
+			message: "Minimal block indexing? (Only stores heights)",
+			enabled: "Yes",
+			disabled: "No",
+			initial: false
+		},
+		{
+			type: "number",
+			name: "queueSize",
+			message: "Number of blocks to keep prefetched (queue size):",
+			initial: 200
+		},
+		{
+			type: "number",
+			name: "startHeight",
+			message: "Height to start indexing from (>1 not compatible with standard modules):",
+			initial: 1
+		}
+	]);
+	if (answers1.startHeight == 1) answers1.processGenesis = (await prompt([{
+		type: "toggle",
+		name: "processGenesis",
+		message: "Process genesis file?",
+		enabled: "Yes",
+		disabled: "No"
+	}])).processGenesis;
+	else answers1.processGenesis = "No";
+	if (answers1.processGenesis === "Yes") {
+		const genesisPathQuestion = await prompt([{
+			type: "input",
+			name: "genesisPath",
+			message: "Path to genesis file:",
+			initial: "./genesis.json",
+			validate: (value) => {
+				try {
+					fs_extra.default.accessSync(value, fs_extra.default.constants.R_OK);
+					return true;
+				} catch (err) {
+					return "File not found or not readable. Please enter a valid path: " + err;
+				}
+			}
+		}]);
+		answers1.genesisPath = genesisPathQuestion.genesisPath ? node_path.default.resolve(genesisPathQuestion.genesisPath) : null;
+	} else answers1.genesisPath = null;
+	const questions2 = [
+		{
+			type: "multiselect",
+			name: "modules",
+			message: "Select modules to include:",
+			choices: answers1.startHeight == 1 && !answers1.minimal && answers1.processGenesis ? availableModules : minimalAvailableModules,
+			initial: answers1.startHeight == 1 && !answers1.minimal && answers1.processGenesis ? [
+				0,
+				1,
+				2
+			] : [0, 1]
+		},
+		{
+			type: "select",
+			name: "packageManager",
+			message: "Package manager:",
+			choices: [
+				{
+					name: "pnpm",
+					hint: "recommended"
+				},
+				{ name: "npm" },
+				{ name: "yarn" }
+			],
+			initial: 0
+		},
+		{
+			type: "select",
+			name: "logLevel",
+			message: "Log level:",
+			choices: [
+				"error",
+				"warn",
+				"info",
+				"verbose",
+				"debug",
+				"silly"
+			],
+			initial: 4
+		}
+	];
+	const answers2 = await prompt(questions2);
+	return {
+		...answers1,
+		...answers2
+	};
+}
+async function copyTemplateFiles(config, targetDir) {
+	const templatesDir = (0, node_path.resolve)(__dirname$1, "..", "templates", "basic");
+	if (config.genesisPath) {
+		console.log(picocolors.default.blue("📋 Copying genesis file..."));
+		copySync(config.genesisPath, targetDir + "/genesis.json");
+	}
+	console.log(picocolors.default.blue("📋 Copying template files..."));
+	copySync(templatesDir, targetDir, { filter: (src) => {
+		if (src.includes(".template")) return false;
+		if (config.packageManager !== "pnpm" && src.includes("pnpm-workspace")) return false;
+		if (src.includes("Dockerfile")) return false;
+		return true;
+	} });
+	copySync((0, node_path.resolve)(templatesDir, "Dockerfile." + config.packageManager), targetDir + "/Dockerfile");
+	[
+		"package.json.template",
+		"src/index.ts.template",
+		"tsconfig.json.template",
+		"docker-compose.yml.template",
+		"README.md.template",
+		".env.template"
+	].forEach((templateFile) => {
+		const srcPath = (0, node_path.resolve)(templatesDir, templateFile);
+		const destPath = (0, node_path.resolve)(targetDir, templateFile.replace(".template", ""));
+		try {
+			copySync(srcPath, destPath);
+		} catch (_error) {}
+	});
+}
+async function processTemplates(config, targetDir) {
+	let polling = false;
+	const url = new URL(config.rpcEndpoint);
+	if (url.protocol === "http:" || url.protocol === "https:") polling = true;
+	const templateVars = {
+		PROJECT_NAME: config.projectName,
+		CHAIN_NAME: config.chainName,
+		DESCRIPTION: config.description,
+		RPC_ENDPOINT: config.rpcEndpoint,
+		PG_CONNECTION_STRING: "postgres://postgres:password@postgres:5432/indexer",
+		LOG_LEVEL: config.logLevel,
+		QUEUE_SIZE: config.queueSize.toString(),
+		USE_POLLING: polling ? "true" : "false",
+		PROCESS_GENESIS: config.processGenesis + "",
+		GENESIS_PATH: node_path.default.resolve(targetDir, "genesis.json"),
+		MINIMAL: config.minimal ? "true" : "false",
+		START_HEIGHT: config.startHeight.toString(),
+		CHAIN_PREFIX: config.chainName.split("-")[0] || "cosmos",
+		MODULES_IMPORT: generateModulesImport(config),
+		PACKAGE_MANAGER: config.packageManager,
+		MODULES_INSTANTIATION: generateModulesInstantiation(config),
+		MODULES_ARRAY: generateModulesArray(config)
+	};
+	[
+		"package.json",
+		"src/index.ts",
+		"tsconfig.json",
+		"docker-compose.yml",
+		"README.md",
+		"pnpm-workspace.yaml",
+		".env"
+	].forEach((file) => {
+		const filePath = (0, node_path.resolve)(targetDir, file);
+		try {
+			let content = readFileSync(filePath, "utf-8");
+			Object.entries(templateVars).forEach(([key, value]) => {
+				const regex = new RegExp(`{{${key}}}`, "g");
+				content = content.replace(regex, value);
+			});
+			writeFileSync(filePath, content);
+		} catch (_error) {}
+	});
+}
+function generateModulesImport(config) {
+	const imports = [];
+	imports.push("  Blocks");
+	if (config.modules.includes("Auth")) imports.push("  AuthModule");
+	if (config.modules.includes("Bank") && config.startHeight === 1 && config.processGenesis) imports.push("  BankModule");
+	if (config.modules.includes("Staking") && !config.minimal) imports.push("  StakingModule");
+	return `import {\n${imports.join(",")}\n} from "@eclesia/core-modules-pg";\n`;
+}
+function generateModulesInstantiation(config) {
+	const instantiations = [];
+	if (config.minimal) instantiations.push("const blocksModule = new Blocks.MinimalBlocksModule(registry);");
+	else instantiations.push("const blocksModule = new Blocks.FullBlocksModule(registry);");
+	if (config.modules.includes("Auth")) instantiations.push("const authModule = new AuthModule(registry);");
+	if (config.modules.includes("Bank") && config.startHeight === 1 && config.processGenesis) instantiations.push("const bankModule = new BankModule(registry);");
+	if (config.modules.includes("Staking") && !config.minimal) instantiations.push("const stakingModule = new StakingModule(registry);");
+	return instantiations.join("\n");
+}
+function generateModulesArray(config) {
+	const moduleNames = [];
+	moduleNames.push("blocksModule");
+	if (config.modules.includes("Auth")) moduleNames.push("authModule");
+	if (config.modules.includes("Bank") && config.startHeight === 1 && config.processGenesis) moduleNames.push("bankModule");
+	if (config.modules.includes("Staking") && !config.minimal) moduleNames.push("stakingModule");
+	return `[${moduleNames.filter((m) => !m.includes("//")).join(", ")}]`;
+}
+async function installDependencies(config, targetDir) {
+	const { spawn } = await import("node:child_process");
+	return new Promise((resolve$2, reject) => {
+		spawn(config.packageManager, ["install"], {
+			cwd: targetDir,
+			stdio: "inherit"
+		}).on("close", (code) => {
+			if (code !== 0) reject(/* @__PURE__ */ new Error(`Package installation failed with code ${code}`));
+			else resolve$2();
+		});
+	});
+}
+async function buildProject(config, targetDir) {
+	const { spawn } = await import("node:child_process");
+	return new Promise((resolve$2, reject) => {
+		spawn(config.packageManager, ["run", "build"], {
+			cwd: targetDir,
+			stdio: "inherit"
+		}).on("close", (code) => {
+			if (code !== 0) reject(/* @__PURE__ */ new Error(`Package installation failed with code ${code}`));
+			else resolve$2();
+		});
+	});
+}
+
+//#endregion
+//#region src/index.ts
+const __filename$1 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
+(0, node_path.dirname)(__filename$1);
+async function main() {
+	console.log();
+	console.log(picocolors.default.cyan("🚀 Welcome to create-eclesia-indexer!"));
+	console.log(picocolors.default.gray("Scaffolding a new Cosmos SDK chain indexer..."));
+	console.log();
+	try {
+		const projectName = process.argv[2];
+		if (projectName && (0, node_fs.existsSync)((0, node_path.resolve)(process.cwd(), projectName))) {
+			console.log(picocolors.default.red(`❌ Directory '${projectName}' already exists.`));
+			process.exit(1);
+		}
+		await createIndexer(projectName);
+		console.log();
+		console.log(picocolors.default.green("✅ Indexer created successfully!"));
+		console.log();
+	} catch (error) {
+		console.error(picocolors.default.red("❌ Error creating indexer:"), error);
+		process.exit(1);
+	}
+}
+main().catch((error) => {
+	console.error(error);
+	process.exit(1);
+});
+
+//#endregion

package/dist/index.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { };