chore: merge main

Author: Jonathansumner

.eslintrc.yml

@@ -0,0 +1,28 @@
+env:
+  browser: true
+  es2021: true
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/recommended
+overrides: []
+parser: '@typescript-eslint/parser'
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+plugins:
+  - '@typescript-eslint'
+ignorePatterns:
+  - "src/types/"
+rules:
+  indent:
+    - error
+    - 2
+  linebreak-style:
+    - error
+    - unix
+  quotes:
+    - error
+    - double
+  semi:
+    - error
+    - always

.github/workflows/test.yml

@@ -16,12 +16,18 @@ jobs:
       - name: Update
         run: sudo apt update
       - name: Install OS dependencies
-        run: sudo apt install -y python3-dev
+        run: sudo apt install -y python3-dev nodejs
 
       - uses: actions/checkout@v3
         with:
           submodules: recursive
 
+      - name: Install linter dependencies
+        run: yarn install
+
+      - name: Lint TypeScript
+        run: yarn lint
+
       - name: Start-up local test environment
         uses: isbang/[email protected]
         with:

docker-compose.yml

@@ -56,7 +56,7 @@ services:
       "postgres":
         condition: service_healthy
       "subquery-node":
-        condition: service_started
+        condition: service_healthy
     restart: always
     environment:
       DB_USER: "subquery"
@@ -134,4 +134,4 @@ services:
       WASM_RELAYER_MNEMONIC: "all expect burger grit believe forest match math holiday polar roof soccer thank focus note lion gesture dream bounce pony whip scale group refuse"
     expose:
       - 3000 # REST API https://hermes.informal.systems/rest-api.html#endpoints
-      - 3001 # prometheus telemetry
+      - 3001 # prometheus telemetry

docs/introduction.md

@@ -40,7 +40,8 @@ Postgraphile plugins also play a critical role; in particular, the [connection-f
 ### Pagination
 The graphql API implements [the connections specification](https://relay.dev/graphql/connections.htm) for pagination (see: [GraphQL pagination docs](https://graphql.org/learn/pagination/#end-of-list-counts-and-connections) for more).
 
-!!! tip It is recommended to prefer using pagination operators by default (e.g. `first: <limit>`) to avoid unnecessary delays in query responses. 
+!!! tip
+    It is recommended to prefer using pagination operators by default (e.g. `first: <limit>`) to avoid unnecessary delays in query responses. 
 
 ### Filtering
 

k8s/subquery/templates/name/node.cmap.yml renamed to k8s/subquery/templates/node/node.cmap.yml

@@ -24,7 +24,7 @@ spec:
       containers:
         - name: node
           image: "{{ .Values.subquery.node.image }}:{{ .Values.subquery.node.tag }}"
-          args: ["-f=/app", "--db-schema=app", "--batch-size=1"]
+          args: ["-f=/app", "--db-schema=app", "--batch-size={{ .Values.subquery.node.batchSize }}"]
           envFrom:
             - configMapRef:
                 name: subquery-node-config

k8s/subquery/templates/name/node.secrets.yml renamed to k8s/subquery/templates/node/node.secrets.yml

@@ -5,6 +5,7 @@ subquery:
     startBlock: "827201"
     networkEndpoint: https://rpc-dorado.fetch.ai:443
     chainId: "dorado-1"
+    batchSize: 1
 
   api:
     image: gcr.io/fetch-ai-sandbox/subquery-api

k8s/subquery/templates/name/node.sts.yml renamed to k8s/subquery/templates/node/node.sts.yml

@@ -4,6 +4,8 @@
   "description": "This is the Fetch Ledger SubQuery project, an indexer for the Fetch network.",
   "main": "dist/index.js",
   "scripts": {
+    "lint": "yarn eslint ./src",
+    "lint:fix": "yarn eslint --fix ./src",
     "build": "subql build",
     "prepack": "rm -rf dist && npm build",
     "test": "jest",
@@ -22,6 +24,9 @@
   "devDependencies": {
     "@cosmjs/stargate": "^0.28.9",
     "@subql/cli": "^1.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "^5.40.0",
+    "eslint": "^8.25.0",
     "typescript": "^4.7.4"
   },
   "dependencies": {

k8s/subquery/templates/name/node.svc.yml renamed to k8s/subquery/templates/node/node.svc.yml

@@ -14,8 +14,8 @@ repository: https://github.com/fetchai/ledger-subquery
 schema:
   file: ./schema.graphql
 network:
-  chainId: dorado-1
-  endpoint: https://rpc-dorado.fetch.ai:443
+  chainId: fetchchain
+  endpoint: http://fetch-node:26657
   chainTypes: # This is a beta feature that allows support for any Cosmos chain by importing the correct protobuf messages
     cosmos.slashing.v1beta1:
       file: "./proto/cosmos/slashing/v1beta1/tx.proto"
@@ -25,7 +25,7 @@ network:
   dictionary: https://api.subquery.network/sq/subquery/cosmos-fetch-ai-dictionary
 dataSources:
   - kind: cosmos/Runtime
-    startBlock: 827201
+    startBlock: 1
     mapping:
       file: "./dist/index.js"
       handlers:
@@ -38,32 +38,42 @@ dataSources:
         - handler: handleEvent
           kind: cosmos/EventHandler
         - handler: handleGovProposalVote
-          kind: cosmos/MessageHandler
+          kind: cosmos/EventHandler
           filter:
-            type: "/cosmos.gov.v1beta1.MsgVote"
+            type: "proposal_vote"
+            messageFilter:
+              type: "/cosmos.gov.v1beta1.MsgVote"
         - handler: handleDistDelegatorClaim
-          kind: cosmos/MessageHandler
+          kind: cosmos/EventHandler
           filter:
-            type: "/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward"
-        - handler: handleExecuteContractMessage
-          kind: cosmos/MessageHandler
+            type: "withdraw_rewards"
+            messageFilter:
+              type: "/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward"
+        - handler: handleExecuteContractEvent
+          kind: cosmos/EventHandler
           filter:
-            type: "/cosmwasm.wasm.v1.MsgExecuteContract"
+            type: "execute"
+            messageFilter:
+              type: "/cosmwasm.wasm.v1.MsgExecuteContract"
         - handler: handleLegacyBridgeSwap
-          kind: cosmos/MessageHandler
+          kind: cosmos/EventHandler
           filter:
-            type: "/cosmwasm.wasm.v1.MsgExecuteContract"
-            # Filter to only messages with the swap function call
-            contractCall: "swap" # The name of the contract function that was called
+            type: "execute"
+            messageFilter:
+              type: "/cosmwasm.wasm.v1.MsgExecuteContract"
+              # Filter to only messages with the swap function call
+              contractCall: "swap"
         - handler: handleNativeTransfer
-          kind: cosmos/MessageHandler
+          kind: cosmos/EventHandler
           filter:
-            type: "/cosmos.bank.v1beta1.MsgSend"
+            type: "transfer"
+            messageFilter:
+              type: "/cosmos.bank.v1beta1.MsgSend"
         - handler: handleDelegatorWithdrawRewardEvent
           kind: cosmos/EventHandler
           filter:
             type: "withdraw_rewards"
-            # TODO: perhaps merge this handler config and that of Cw20BalanceTransfer
+        # TODO: perhaps merge this handler config and that of Cw20BalanceTransfer
         - handler: handleCw20Transfer
           kind: cosmos/EventHandler
           filter:

k8s/subquery/values.yaml

@@ -38,7 +38,7 @@
 db_port = env_db_port or args.db_port
 db_user = env_db_user or args.db_user
 db_pass = env_db_pass or args.db_pass
-db_schema = env_db_schema or args.db_schema
+db_schema = env_db_schema or args.db_schema or "app"
 db_name = env_db_name or args.db_name
 
 # TODO: progress indicators (?)
@@ -53,7 +53,7 @@
     "dbname": db_name,
     "user": db_user,
     "password": db_pass,
-    "options": "-c search_path=app"
+    "options": f"-c search_path={db_schema}"
 }
 
 

package.json

@@ -18,4 +18,4 @@ if [[ ! -z "${NETWORK_ENDPOINT}" ]]; then
 fi
 
 # run the main node
-exec /sbin/tini -- /usr/local/lib/node_modules/@subql/node-cosmos/bin/run
+exec /sbin/tini -- /usr/local/lib/node_modules/@subql/node-cosmos/bin/run "$@"

project.yaml

@@ -1,2 +1,2 @@
 //Exports all handler functions
-export * from './mappings/mappingHandlers'
+export * from "./mappings/mappingHandlers";

scripts/genesis.py

@@ -0,0 +1,88 @@
+import {CosmosEvent} from "@subql/types-cosmos";
+import {NativeBalanceChange, Transaction} from "../../types";
+import {checkBalancesAccount, messageId, parseCoins} from "../utils";
+
+export async function saveNativeBalanceEvent(id: string, address: string, amount: bigint, denom: string, event: CosmosEvent) {
+  await checkBalancesAccount(address, event.block.block.header.chainId);
+  const nativeBalanceChangeEntity = NativeBalanceChange.create({
+    id,
+    balanceOffset: amount.valueOf(),
+    denom,
+    accountId: address,
+    eventId: `${messageId(event)}-${event.idx}`,
+    blockId: event.block.block.id,
+    transactionId: event.tx.hash,
+  });
+  await nativeBalanceChangeEntity.save();
+}
+
+async function saveNativeFeesEvent(event: CosmosEvent) {
+  const transaction = await Transaction.get(event.tx.hash);
+  const fees = transaction.fees[0], signer = transaction.signerAddress;
+  const amount = fees.amount, denom = fees.denom;
+  await saveNativeBalanceEvent(`${event.tx.hash}-fee`, signer, BigInt(0) - BigInt(amount), denom, event);
+}
+
+export async function handleNativeBalanceDecrement(event: CosmosEvent): Promise<void> {
+  logger.info(`[handleNativeBalanceDecrement] (tx ${event.tx.hash}): indexing event ${event.idx + 1} / ${event.tx.tx.events.length}`);
+  logger.debug(`[handleNativeBalanceDecrement] (event.event): ${JSON.stringify(event.event, null, 2)}`);
+  logger.debug(`[handleNativeBalanceDecrement] (event.log): ${JSON.stringify(event.log, null, 2)}`);
+
+  // sample event.event.attributes:
+  // [
+  //   {"key":"spender","value":"fetch1jv65s3grqf6v6jl3dp4t6c9t9rk99cd85zdctg"},
+  //   {"key":"amount","value":"75462013217046121atestfet"},
+  //   {"key":"spender","value":"fetch1wurz7uwmvchhc8x0yztc7220hxs9jxdjdsrqmn"},
+  //   {"key":"amount","value":"100atestfet"}
+  // ]
+  const spendEvents = [];
+  for (const [i, e] of Object.entries(event.event.attributes)) {
+    if (e.key !== "spender") {
+      continue;
+    }
+    const spender = e.value;
+    const amountStr = event.event.attributes[parseInt(i) + 1].value;
+
+    const coin = parseCoins(amountStr)[0];
+    const amount = BigInt(0) - BigInt(coin.amount); // save a negative amount for a "spend" event
+    spendEvents.push({spender: spender, amount: amount, denom: coin.denom});
+  }
+  
+
+  for (const [i, spendEvent] of Object.entries(spendEvents)) {
+    await saveNativeBalanceEvent(`${messageId(event)}-spend-${i}`, spendEvent.spender, spendEvent.amount, spendEvent.denom, event);
+  }
+  await saveNativeFeesEvent(event);
+}
+
+export async function handleNativeBalanceIncrement(event: CosmosEvent): Promise<void> {
+  logger.info(`[handleNativeBalanceIncrement] (tx ${event.tx.hash}): indexing event ${event.idx + 1} / ${event.tx.tx.events.length}`);
+  logger.debug(`[handleNativeBalanceIncrement] (event.event): ${JSON.stringify(event.event, null, 2)}`);
+  logger.debug(`[handleNativeBalanceIncrement] (event.log): ${JSON.stringify(event.log, null, 2)}`);
+
+  // sample event.event.attributes:
+  // [
+  //   {"key":"receiver","value":"fetch1jv65s3grqf6v6jl3dp4t6c9t9rk99cd85zdctg"},
+  //   {"key":"amount","value":"75462013217046121atestfet"},
+  //   {"key":"receiver","value":"fetch1wurz7uwmvchhc8x0yztc7220hxs9jxdjdsrqmn"},
+  //   {"key":"amount","value":"100atestfet"}
+  // ]
+  const receiveEvents = [];
+  for (const [i, e] of Object.entries(event.event.attributes)) {
+    if (e.key !== "receiver") {
+      continue;
+    }
+    const receiver = e.value;
+    const amountStr = event.event.attributes[parseInt(i) + 1].value;
+
+    const coin = parseCoins(amountStr)[0];
+    const amount = BigInt(coin.amount);
+    receiveEvents.push({receiver: receiver, amount: amount, denom: coin.denom});
+  }
+  
+
+  for (const [i, receiveEvent] of Object.entries(receiveEvents)) {
+    await saveNativeBalanceEvent(`${messageId(event)}-receive-${i}`, receiveEvent.receiver, receiveEvent.amount, receiveEvent.denom, event);
+  }
+  await saveNativeFeesEvent(event);
+}

scripts/node-entrypoint.sh

@@ -0,0 +1,2 @@
+export * from "./transfer";
+export * from "./balanceChange";

src/index.ts

@@ -0,0 +1,35 @@
+import {CosmosEvent, CosmosMessage} from "@subql/types-cosmos";
+import {NativeTransferMsg} from "../types";
+import {messageId} from "../utils";
+import {NativeTransfer} from "../../types";
+
+export async function handleNativeTransfer(event: CosmosEvent): Promise<void> {
+  const msg: CosmosMessage<NativeTransferMsg> = event.msg;
+  logger.info(`[handleNativeTransfer] (tx ${msg.tx.hash}): indexing message ${msg.idx + 1} / ${msg.tx.decodedTx.body.messages.length}`);
+  logger.debug(`[handleNativeTransfer] (msg.msg): ${JSON.stringify(msg.msg, null, 2)}`);
+
+  const fromAddress = msg.msg?.decodedMsg?.fromAddress;
+  const toAddress = msg.msg?.decodedMsg?.toAddress;
+  const amounts = msg.msg?.decodedMsg?.amount;
+
+  if (!fromAddress || !amounts || !toAddress) {
+    logger.warn(`[handleNativeTransfer] (tx ${event.tx.hash}): cannot index event (event.event): ${JSON.stringify(event.event, null, 2)}`);
+    return;
+  }
+
+  // workaround: assuming one denomination per transfer message
+  const denom = amounts[0].denom;
+  const id = messageId(msg);
+  const transferEntity = NativeTransfer.create({
+    id,
+    toAddress,
+    fromAddress,
+    amounts,
+    denom,
+    messageId: id,
+    transactionId: msg.tx.hash,
+    blockId: msg.block.block.id
+  });
+
+  await transferEntity.save();
+}

src/mappings/bank/balanceChange.ts

@@ -0,0 +1 @@
+export * from "./rewards";