create-eclesia-indexer 1.0.2

package/templates/basic/docker-compose.yml.template

@@ -0,0 +1,56 @@
+services:
+  postgres:
+    image: postgres:16
+    restart: always
+    environment:
+      POSTGRES_DB: indexer
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+    ports:
+      - "5432:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres -d {{PROJECT_NAME}}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+  indexer:
+    build: .
+    environment:    
+      - RPC_ENDPOINT={{RPC_ENDPOINT}}
+      - PG_CONNECTION_STRING=postgres://postgres:password@postgres:5432/indexer
+      - LOG_LEVEL={{LOG_LEVEL}}
+      - USE_POLLING={{USE_POLLING}}
+      - QUEUE_SIZE={{QUEUE_SIZE}}
+      - PROCESS_GENESIS={{PROCESS_GENESIS}}
+      - CHAIN_PREFIX={{CHAIN_PREFIX}}
+      - START_HEIGHT={{START_HEIGHT}}
+    volumes:
+      - {{GENESIS_PATH}}:/usr/src/app/genesis.json
+    depends_on:
+      postgres:
+        condition: service_healthy
+    restart: unless-stopped
+  graphql-engine:
+    image: hasura/graphql-engine:v2.38.0
+    ports:
+      - "8080:8080"
+    restart: always
+    environment:
+      ## postgres database to store Hasura metadata
+      HASURA_GRAPHQL_METADATA_DATABASE_URL: postgres://postgres:password@postgres:5432/indexer
+      ## this env var can be used to add the above postgres database to Hasura as a data source. this can be removed/updated based on your needs
+      HASURA_GRAPHQL_DATABASE_URL: postgres://postgres:password@postgres:5432/indexer
+      ## enable the console served by server
+      HASURA_GRAPHQL_ENABLE_CONSOLE: "true" # set to "false" to disable console
+      ## enable debugging mode. It is recommended to disable this in production
+      HASURA_GRAPHQL_DEV_MODE: "true"
+      HASURA_GRAPHQL_STRINGIFY_NUMERIC_TYPES: "true"
+      HASURA_GRAPHQL_ENABLED_LOG_TYPES: startup, http-log, webhook-log, websocket-log, query-log
+      ## uncomment next line to run console offline (i.e load console assets from server instead of CDN)
+      # HASURA_GRAPHQL_CONSOLE_ASSETS_DIR: /srv/console-assets
+      ## uncomment next line to set an admin secret
+      # HASURA_GRAPHQL_ADMIN_SECRET: myadminsecretkey
+volumes:
+  postgres_data:

package/templates/basic/eslint.config.mjs

@@ -0,0 +1,84 @@
+import eslint from "@eslint/js";
+import stylistic from "@stylistic/eslint-plugin";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import tseslint from "typescript-eslint";
+export default tseslint.config([
+  {
+    name: "app/files-to-lint",
+    files: ["**/*.{ts,mts,tsx,js,mjs}", "eslint.config.mjs"],
+  },
+  {
+    name: "app/files-to-ignore",
+    ignores: ["**/lib/**", "**/dist-ssr/**", "**/dist/**", "**/coverage/**"],
+  },
+  {
+    plugins: {
+      "@stylistic": stylistic,
+    },
+  },
+
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  stylistic.configs.customize(),
+  {
+    rules: {
+      "@stylistic/array-element-newline": [
+        "error",
+        {
+          multiline: true,
+        },
+      ],
+      "@stylistic/array-bracket-newline": [
+        "error",
+        {
+          multiline: true,
+        },
+      ],
+      "@stylistic/object-curly-newline": ["error", "always"],
+      "@stylistic/object-curly-spacing": ["error", "always"],
+      "@stylistic/object-property-newline": "error",
+      "@stylistic/indent": ["error", 2],
+      "@stylistic/quote-props": ["error", "as-needed"],
+      "@stylistic/block-spacing": ["error", "always"],
+      "@stylistic/semi": ["error", "always"],
+      "@stylistic/quotes": ["error", "double"],
+      "@typescript-eslint/no-unused-vars": [
+        "error", // or "error"
+        {
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+          caughtErrorsIgnorePattern: "^_",
+        },
+      ],
+      "max-lines": [
+        "warn",
+        {
+          max: 700,
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+      "max-lines-per-function": [
+        "warn",
+        {
+          max: 350,
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+    },
+  },
+  {
+    plugins: {
+      "simple-import-sort": simpleImportSort,
+    },
+    rules: {
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error",
+    },
+  },
+  {
+    ignores: ["node_modules/*", "dist/*"],
+  },
+],
+);

package/templates/basic/package.json.template

@@ -0,0 +1,70 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "1.0.0",
+  "description": "{{DESCRIPTION}}",
+  "type": "module",
+  "scripts": {
+    "build": "tsc --noEmit && tsdown && {{PACKAGE_MANAGER}} run postbuild",
+    "postbuild": "copyfiles -u 1 \"src/**/*.sql\" dist",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "start": "node dist/index.js",
+    "dev": "tsx watch src/index.ts",
+    "docker:build": "docker build -t {{PROJECT_NAME}} .",
+    "docker:run": "docker run --env-file .env {{PROJECT_NAME}}",
+    "local-dev:start": "docker compose up -d",
+    "local-dev:stop": "docker compose down"
+  },
+  "bin": {
+    "{{PROJECT_NAME}}": "./dist/index.js"
+  },
+  "keywords": [
+    "cosmos",
+    "indexer",
+    "{{CHAIN_NAME}}",
+    "blockchain"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@cosmjs/proto-signing": "^0.36.0",
+    "@cosmjs/stargate": "^0.36.0",
+    "@cosmjs/tendermint-rpc": "^0.36.0",
+    "@eclesia/basic-pg-indexer": "^2.9.1",
+    "@eclesia/core-modules-pg": "^2.9.1",
+    "@eclesia/indexer-engine": "^2.9.1",
+    "bignumber.js": "^9.3.1",
+    "json-with-bigint": "^3.4.4",
+    "pg": "^8.16.3"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/core": "^0.18.2",
+    "@eslint/js": "^9.35.0",
+    "@stylistic/eslint-plugin": "^5.3.1",
+    "@types/json-bigint": "^1.0.4",
+    "@types/node": "^22.7.5",
+    "@types/pg": "^8.15.5",
+    "copyfiles": "^2.4.1",
+    "eslint": "^9.35.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "tsdown": "^0.15.2",
+    "tsx": "^4.19.1",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.44.0"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  }
+}

package/templates/basic/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+onlyBuiltDependencies:
+  - esbuild

package/templates/basic/src/index.ts.template

@@ -0,0 +1,49 @@
+import {
+  defaultRegistryTypes,
+} from "@cosmjs/stargate";
+import {
+  PgIndexer, PgIndexerConfig,
+} from "@eclesia/basic-pg-indexer";
+{{MODULES_IMPORT}}
+
+const config: PgIndexerConfig = {
+  startHeight: Number(process.env.START_HEIGHT) || {{START_HEIGHT}},
+  batchSize: Number(process.env.QUEUE_SIZE) || {{QUEUE_SIZE}},
+  modules: [],
+  rpcUrl: process.env.RPC_ENDPOINT || "{{RPC_ENDPOINT}}",
+  logLevel: process.env.LOG_LEVEL as PgIndexerConfig["logLevel"] ?? "debug",
+  usePolling: process.env.USE_POLLING == "true" || false,
+  pollingInterval: 3000,
+  processGenesis: process.env.PROCESS_GENESIS == "true" || false,
+  minimal: process.env.MINIMAL == "true" || false,
+  genesisPath: "./genesis.json",
+  dbConnectionString: process.env.PG_CONNECTION_STRING || "{{PG_CONNECTION_STRING}}",
+};
+
+// Initialize protocol registry
+// You may need to import specific protocol registries for your chain
+const registry = defaultRegistryTypes.concat([]); // Add your chain's proto registry here eg. defaultRegistryTypes.concat(myCustomRegistryTypes)
+
+// Initialize modules
+{{MODULES_INSTANTIATION}}
+
+const indexer = new PgIndexer(config, {{MODULES_ARRAY}});
+
+process.on("unhandledRejection", (reason, promise) => {
+  console.log("Unhandled Rejection at:", promise, "reason:", reason);
+  console.trace();
+  process.exit(1);
+});
+
+const run = async () => {
+  try {
+    await indexer.setup();
+    await indexer.run();
+  }
+  catch (error) {
+    console.error("Error running indexer:", error);
+    process.exit(1);
+  }
+};
+
+run();

package/templates/basic/tsconfig.json.template

@@ -0,0 +1,26 @@
+{
+  "include": [
+    "src/**/*"
+  ],
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "es2020",
+    "rootDir": "./src/",
+    "moduleResolution": "bundler",
+    "types": ["node"],
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": false,
+    "outDir": "./dist/",
+    "allowSyntheticDefaultImports": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "exclude": [
+    "src/**/*.test.ts",
+    "dist"
+  ]
+}

package/templates/basic/tsdown.config.ts

@@ -0,0 +1,31 @@
+import {
+  defineConfig,
+} from "tsdown";
+
+export default defineConfig([
+  {
+    entry: ["./src/index.ts"],
+    unbundle: true,
+    attw: true,
+    platform: "node",
+    nodeProtocol: "strip",
+    target: "es2020",
+    outDir: "./dist",
+    clean: true,
+    sourcemap: true,
+    dts: true,
+    format: ["cjs"],
+  },
+  {
+    entry: ["./src/index.ts"],
+    unbundle: true,
+    attw: true,
+    platform: "node",
+    target: "es2020",
+    outDir: "./dist",
+    clean: true,
+    sourcemap: true,
+    dts: true,
+    format: ["esm"],
+  },
+]);