Merge pull request #28 from turadg/ta/ci

turadg · web-flow · commit a76933c217be · 2024-12-10T09:08:05.000-08:00
set up CI with linting
diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -1,24 +1,50 @@
 name: PR
-# on:
-#   pull_request:
-#     paths-ignore:
-#       - ".github/workflows/**"
+on:
+  pull_request:
+
 jobs:
   pr:
-    name: pr
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16-alpine
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DB_USER: postgres
+      DB_PASS: postgres
+      DB_DATABASE: postgres
+      DB_HOST: localhost
+      DB_PORT: 5432
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+      # Before setup-node because that action runs `yarn cache dir`. See https://github.com/actions/setup-node/issues/480#issuecomment-1915448139
+      - run: corepack enable
+        shell: bash
       - name: Setup Node.js environment
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: 18
-      - run: yarn
+          cache: yarn
+      - run: yarn install
+      - run: yarn prettier:check
       - name: Codegen
         run: yarn codegen
+      # After codegen because that makes src/types/
+      - run: yarn tsc
       - name: Build
         run: yarn build
-      - name: Install subql-node-cosmos
-        run: yarn global add @subql/node-cosmos
-      - name: Run tests with Subquery Node
-        run: subql-node-cosmos test -f ${{ github.workspace }}
+      # TODO: https://github.com/Agoric/agoric-subql/issues/8
+      - name: Enable btree btree_gist
+        run: psql "postgresql://$DB_USER:$DB_PASS@$DB_HOST:$DB_PORT/$DB_DATABASE" -c "CREATE EXTENSION IF NOT EXISTS btree_gist;"
+      # - name: Install subql-node-cosmos
+      #   run: yarn global add @subql/node-cosmos
+      # - name: Run tests with Subquery Node
+      #   run: subql-node-cosmos test -f ${{ github.workspace }}
diff --git a/.gitignore b/.gitignore
@@ -7,10 +7,6 @@
 node_modules/
 dist/
 
-# lock files
-yarn.lock
-package-lock.json
-
 # Compiled Java class files
 *.class
 
@@ -55,6 +51,14 @@ Thumbs.db
 *.wmv
 
 .data
-.yarn
 
 .DS_Store
+
+# Yarn (https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored)
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,2 @@
+# UNTIL https://github.com/subquery/subql/issues/2621 is fixed
+nodeLinker: node-modules
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,4 +1,4 @@
-version: "3"
+version: '3'
 
 services:
   postgres:
@@ -12,15 +12,15 @@ services:
     environment:
       POSTGRES_PASSWORD: postgres
     healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      test: ['CMD-SHELL', 'pg_isready -U postgres']
       interval: 5s
       timeout: 5s
       retries: 5
 
   subquery-node:
     image: subquerynetwork/subql-node-cosmos:latest
     depends_on:
-      "postgres":
+      'postgres':
         condition: service_healthy
     restart: always
     environment:
@@ -40,7 +40,7 @@ services:
       # - --log-level=debug
       # - --unfinalized-blocks=true
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://subquery-node:3000/ready"]
+      test: ['CMD', 'curl', '-f', 'http://subquery-node:3000/ready']
       interval: 3s
       timeout: 5s
       retries: 10
@@ -50,9 +50,9 @@ services:
     ports:
       - 3000:3000
     depends_on:
-      "postgres":
+      'postgres':
         condition: service_healthy
-      "subquery-node":
+      'subquery-node':
         condition: service_healthy
     restart: always
     environment:
diff --git a/package.json b/package.json
@@ -1,55 +1,45 @@
 {
-  "name": "agoric-starter",
+  "name": "agoric-indexer",
   "version": "0.0.1",
-  "description": "This project can be use as a starting point for developing your Agoric based SubQuery project",
+  "description": "This is the SubQuery project for indexing the Agoric chain",
   "main": "dist/index.js",
   "scripts": {
     "build": "subql build",
-    "pub": "subql publish",
     "codegen": "subql codegen",
     "start:docker": "docker-compose pull && docker-compose up --remove-orphans",
     "dev": "subql codegen && subql build && docker-compose pull && docker-compose up --remove-orphans",
     "prepack": "rm -rf dist && npm run build",
-    "test": "jest",
-    "subql": "subql codegen --help",
+    "test": "subql build && subql-node-cosmos test",
     "prettier:check": "prettier --list-different . --print-width 120",
     "prettier:write": "prettier --write . --print-width 120"
   },
-  "homepage": "https://github.com/subquery/cosmos-subql-starter",
-  "repository": "github:subquery/cosmos-subql-starter",
+  "homepage": "https://github.com/Agoric/agoric-subql",
+  "repository": "github:Agoric/agoric-subql",
   "files": [
     "dist",
     "schema.graphql",
     "project.yaml"
   ],
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node",
-    "modulePathIgnorePatterns": [
-      "/dist/"
-    ]
-  },
-  "author": "SubQuery Team",
-  "license": "MIT",
+  "author": "Agoric OpCo",
+  "license": "Apache-2.0",
   "devDependencies": {
-    "@babel/preset-typescript": "^7.23.2",
     "@cosmjs/stargate": "^0.28.9",
-    "@subql/cli": "^4.2.6",
-    "@subql/node-cosmos": "^3.9.2",
+    "@subql/cli": "^5.3.3",
+    "@subql/node-cosmos": "^4.2.1",
     "@subql/testing": "latest",
-    "@types/jest": "^29.5.7",
-    "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.2.2"
+    "prettier": "^3.4.2",
+    "starknet": "6.11.0",
+    "typescript": "^5.7.2"
   },
   "dependencies": {
-    "@subql/types-cosmos": "^3.2.3",
+    "@subql/types-cosmos": "^4.0.0",
+    "@subql/utils": "^2.16.0",
     "@types/node": "^17.0.21",
     "bech32": "^2.0.0",
     "js-sha256": "^0.11.0",
     "pino": "^7.8.0",
     "ts-proto": "^1.112.1",
     "tslib": "^2.3.1"
-  }
+  },
+  "packageManager": "yarn@4.5.3"
 }
diff --git a/project.ts b/project.ts
@@ -1,57 +1,57 @@
-import { CosmosDatasourceKind, CosmosHandlerKind, CosmosProject } from "@subql/types-cosmos";
+import { CosmosDatasourceKind, CosmosHandlerKind, CosmosProject } from '@subql/types-cosmos';
 
 // Can expand the Datasource processor types via the genreic param
 const project: CosmosProject = {
-  specVersion: "1.0.0",
-  version: "0.0.1",
-  name: "agoric-starter",
-  description: "This project can be use as a starting point for developing your Cosmos agoric based SubQuery project",
+  specVersion: '1.0.0',
+  version: '0.0.1',
+  name: 'agoric-starter',
+  description: 'This project can be use as a starting point for developing your Cosmos agoric based SubQuery project',
   runner: {
     node: {
-      name: "@subql/node-cosmos",
-      version: ">=3.0.0",
+      name: '@subql/node-cosmos',
+      version: '>=3.0.0',
     },
     query: {
-      name: "@subql/query",
-      version: "*",
+      name: '@subql/query',
+      version: '*',
     },
   },
   schema: {
-    file: "./schema.graphql",
+    file: './schema.graphql',
   },
   network: {
     // chainId: "agoriclocal",
     // endpoint: ["http://host.docker.internal:26657/"],
-    chainId: "agoric-3",
-    endpoint: ["https://main-a.rpc.agoric.net:443"],
+    chainId: 'agoric-3',
+    endpoint: ['https://main-a.rpc.agoric.net:443'],
 
     chaintypes: new Map([
       [
-        "cosmos.slashing.v1beta1",
+        'cosmos.slashing.v1beta1',
         {
-          file: "./proto/cosmos/slashing/v1beta1/tx.proto",
-          messages: ["MsgUnjail"],
+          file: './proto/cosmos/slashing/v1beta1/tx.proto',
+          messages: ['MsgUnjail'],
         },
       ],
       [
-        "cosmos.gov.v1beta1",
+        'cosmos.gov.v1beta1',
         {
-          file: "./proto/cosmos/gov/v1beta1/tx.proto",
-          messages: ["MsgVoteWeighted"],
+          file: './proto/cosmos/gov/v1beta1/tx.proto',
+          messages: ['MsgVoteWeighted'],
         },
       ],
       [
-        "cosmos.gov.v1beta1.gov",
+        'cosmos.gov.v1beta1.gov',
         {
-          file: "./proto/cosmos/gov/v1beta1/gov.proto",
-          messages: ["WeightedVoteOption"],
+          file: './proto/cosmos/gov/v1beta1/gov.proto',
+          messages: ['WeightedVoteOption'],
         },
-      ],  
+      ],
       [
-        "/agoric.swingset.MsgInstallBundle",
+        '/agoric.swingset.MsgInstallBundle',
         {
-          file: "./proto/agoric/swingset/msgs.proto",
-          messages: ["MsgInstallBundle"],
+          file: './proto/agoric/swingset/msgs.proto',
+          messages: ['MsgInstallBundle'],
         },
       ],
     ]),
@@ -69,7 +69,7 @@ const project: CosmosProject = {
       startBlock: 7179262,
 
       mapping: {
-        file: "./dist/index.js",
+        file: './dist/index.js',
         handlers: [
           // {
           //     Using block handlers slows your project down as they can be executed with each and every block.
@@ -108,10 +108,10 @@ const project: CosmosProject = {
           //   },
           // },
           {
-            handler: "handleStateChangeEvent",
+            handler: 'handleStateChangeEvent',
             kind: CosmosHandlerKind.Event,
             filter: {
-              type: "state_change",
+              type: 'state_change',
             },
           },
           {
diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,2 @@
 //Exports all handler functions
-export * from "./mappings/mappingHandlers";
+export * from './mappings/mappingHandlers';
diff --git a/src/mappings/mappingHandlers.ts b/src/mappings/mappingHandlers.ts
@@ -1,5 +1,6 @@
+import type { tendermint37 } from '@cosmjs/tendermint-rpc';
 import { StateChangeEvent, IBCChannel, IBCTransfer, TransferType, BundleInstall } from '../types';
-import { CosmosEvent, CosmosMessage } from '@subql/types-cosmos';
+import { CosmosEvent, CosmosMessage, type CosmosBlock } from '@subql/types-cosmos';
 import {
   b64decode,
   extractStoragePath,
@@ -44,7 +45,7 @@ async function saveIbcChannel(channelName: string) {
 }
 
 export async function handleIbcSendPacketEvent(cosmosEvent: CosmosEvent): Promise<void> {
-  const { event, block, tx } = cosmosEvent;
+  const { event, block, tx } = cosmosEvent as CosmosEvent & { event: tendermint37.Event };
   if (event.type != EVENT_TYPES.SEND_PACKET) {
     logger.warn('Not valid send_packet event.');
     return;
@@ -86,7 +87,7 @@ export async function handleIbcSendPacketEvent(cosmosEvent: CosmosEvent): Promis
 }
 
 export async function handleIbcReceivePacketEvent(cosmosEvent: CosmosEvent): Promise<void> {
-  const { event, block, tx } = cosmosEvent;
+  const { event, block, tx } = cosmosEvent as CosmosEvent & { event: tendermint37.Event };
   if (event.type != EVENT_TYPES.RECEIVE_PACKET) {
     logger.warn('Not valid recv_packet event.');
     return;
@@ -153,7 +154,7 @@ export async function handleBundleInstallMessage(message: CosmosMessage): Promis
 }
 
 export async function handleStateChangeEvent(cosmosEvent: CosmosEvent): Promise<void> {
-  const { event, block } = cosmosEvent;
+  const { event, block } = cosmosEvent as CosmosEvent & { event: tendermint37.Event };
 
   if (event.type != EVENT_TYPES.STATE_CHANGE) {
     logger.warn('Not valid state_change event.');
diff --git a/src/test/mappingHandlers.test.ts b/src/test/mappingHandlers.test.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# UNTIL https://github.com/subquery/subql/issues/2621 is fixed`
	`2`	`+nodeLinker: node-modules`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`//Exports all handler functions`
`2`		`-export * from "./mappings/mappingHandlers";`
	`2`	`+export * from './mappings/mappingHandlers';`