Merge pull request #2605 from w3f/will-v3.0.18

Add Types to Nominator DB Queries

Author: wpank

apps/1kv-backend-staging/templates/kusama-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.17
+    targetRevision: v3.0.18
     plugin:
       env:
         - name: HELM_VALUES

apps/1kv-backend-staging/templates/polkadot-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.17
+    targetRevision: v3.0.18
     plugin:
       env:
         - name: HELM_VALUES

apps/1kv-backend/templates/kusama-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.17
+    targetRevision: v3.0.18
     plugin:
       env:
         - name: HELM_VALUES

apps/1kv-backend/templates/polkadot-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.17
+    targetRevision: v3.0.18
     plugin:
       env:
         - name: HELM_VALUES

charts/otv-backend/Chart.yaml

@@ -1,5 +1,5 @@
 description: 1K Validators Backend
 name: otv-backend
-version: v3.0.17
-appVersion: v3.0.17
+version: v3.0.18
+appVersion: v3.0.18
 apiVersion: v2

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1kv/common",
-  "version": "3.0.17",
+  "version": "3.0.18",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

packages/common/src/db/index.ts

@@ -18,6 +18,8 @@ export type NodeDetails = [
 
 export * from "./queries";
 
+export * from "./models";
+
 export const dbLabel = { label: "DB" };
 
 export class Db {

packages/common/src/db/models.ts

@@ -321,6 +321,22 @@ export const EraSchema = new Schema({
 
 export const EraModel = mongoose.model("Era", EraSchema);
 
+export interface Nominator {
+  address: string;
+  stash?: string;
+  proxy?: string;
+  bonded?: number;
+  avgStake?: number;
+  nominateAmount?: number;
+  proxyDelay?: number;
+  rewardDestination?: string;
+  newBondedAmount?: number;
+  current?: [{ name?: string; stash?: string; identity?: any }];
+  lastNomination?: number;
+  createdAt?: number;
+  now?: number;
+}
+
 export const NominatorSchema = new Schema({
   // The controller address
   address: String,

packages/common/src/db/queries/Nominator.ts

@@ -1,4 +1,4 @@
-import { CandidateModel, NominatorModel } from "../models";
+import { CandidateModel, Nominator, NominatorModel } from "../models";
 import logger from "../../logger";
 import { getCandidate } from "./Candidate";
 
@@ -24,26 +24,19 @@ export const removeStaleNominators = async (
 };
 
 /** Nominator accessor functions */
-export const addNominator = async (
-  nominator: any,
-  // address: string,
-  // stash: string,
-  // proxy: string,
-  // bonded: number,
-  // now: number,
-  // proxyDelay: number,
-  // rewardDestination: string
-
-  // avgStake: number,
-  // nominateAmount: number,
-  // newBondedAmount: number
-): Promise<boolean> => {
-  const { address, stash, proxy, bonded, now, proxyDelay, rewardDestination } =
-    nominator;
-
-  logger.info(`(Db::addNominator) Adding ${address} at ${now}.`);
-
+export const addNominator = async (nominator: Nominator): Promise<boolean> => {
   try {
+    const {
+      address,
+      stash,
+      proxy,
+      bonded,
+      now,
+      proxyDelay,
+      rewardDestination,
+    } = nominator;
+
+    logger.info(`(Db::addNominator) Adding ${address} at ${now}.`);
     const data = await NominatorModel.findOne({ address }).lean();
     if (!data) {
       const nominator = new NominatorModel({
@@ -53,9 +46,6 @@ export const addNominator = async (
         bonded,
         proxyDelay,
         rewardDestination,
-        // avgStake,
-        // nominateAmount,
-        // newBondedAmount,
         current: [],
         lastNomination: 0,
         createdAt: now,
@@ -75,19 +65,10 @@ export const addNominator = async (
         bonded,
         proxyDelay,
         rewardDestination,
-        // avgStake,
-        // nominateAmount,
-        // newBondedAmount,
       },
     );
   } catch (e) {
     logger.info(JSON.stringify(e));
-    logger.info(address);
-    logger.info(stash);
-    logger.info(proxy);
-    logger.info(bonded);
-    logger.info(proxyDelay);
-    logger.info(rewardDestination);
   }
 };
 
@@ -182,11 +163,15 @@ export const setLastNomination = async (
   return true;
 };
 
-export const getCurrentTargets = async (address: string): Promise<any[]> => {
+export const getCurrentTargets = async (
+  address: string,
+): Promise<{ name?: string; stash?: string; identity?: any }[]> => {
   try {
-    const nominator = await NominatorModel.findOne({ address }).lean();
+    const nominator = await NominatorModel.findOne({
+      address,
+    }).lean<Nominator>();
     if (nominator) {
-      return nominator?.current;
+      return nominator?.current || [];
     } else {
       return [];
     }
@@ -195,10 +180,10 @@ export const getCurrentTargets = async (address: string): Promise<any[]> => {
   }
 };
 
-export const allNominators = async (): Promise<any[]> => {
-  return NominatorModel.find({ address: /.*/ }).lean().exec();
+export const allNominators = async (): Promise<Nominator[]> => {
+  return NominatorModel.find({ address: /.*/ }).lean();
 };
 
-export const getNominator = async (stash: string): Promise<any> => {
-  return NominatorModel.findOne({ stash: stash }).lean().exec();
+export const getNominator = async (stash: string): Promise<Nominator> => {
+  return NominatorModel.findOne({ stash: stash }).lean();
 };

packages/common/src/index.ts

@@ -1,6 +1,7 @@
 import "@polkadot/api-augment";
 import { Db } from "./db";
 import * as queries from "./db/queries";
+import * as Models from "./db/models";
 import * as Config from "./config";
 import logger from "./logger";
 import { ChainData } from "./chaindata";
@@ -23,4 +24,5 @@ export {
   Util,
   Constraints,
   Score,
+  Models,
 };