fix: move sr contracts to sstakingrouter-modules

src/common/registry/storage/key.storage.ts

@@ -1,7 +1,6 @@
 import { QueryOrder } from '@mikro-orm/core';
 import { FilterQuery, FindOptions } from '@mikro-orm/core';
 import { Injectable } from '@nestjs/common';
-import { KeyField } from 'staking-router-modules/interfaces/key-fields';
 import { RegistryKey } from './key.entity';
 import { RegistryKeyRepository } from './key.repository';
 

src/http/sr-modules-keys/sr-modules-keys.service.ts

@@ -4,7 +4,7 @@ import { GroupedByModuleKeyListResponse, SRModuleKeyListResponse } from './entit
 import { ModuleId, KeyQuery, Key, ELBlockSnapshot, SRModule } from 'http/common/entities';
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 import { StakingRouterService } from 'staking-router-modules/staking-router.service';
-import { KeyEntity } from 'staking-router-modules/interfaces';
+import { KeyEntity } from 'staking-router-modules/interfaces/staking-module.interface';
 
 @Injectable()
 export class SRModulesKeysService {

src/http/sr-modules-operators-keys/sr-modules-operators-keys.service.ts

@@ -5,7 +5,7 @@ import { ConfigService } from 'common/config';
 import { SRModuleOperatorsKeysResponse } from './entities';
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 import { StakingRouterService } from 'staking-router-modules/staking-router.service';
-import { KeyEntity, OperatorEntity } from 'staking-router-modules/interfaces';
+import { KeyEntity, OperatorEntity } from 'staking-router-modules/interfaces/staking-module.interface';
 
 @Injectable()
 export class SRModulesOperatorsKeysService {

src/jobs/keys-update/keys-update.module.ts

@@ -2,10 +2,9 @@ import { Module } from '@nestjs/common';
 import { KeysUpdateService } from './keys-update.service';
 import { LoggerModule } from 'common/logger';
 import { JobModule } from 'common/job';
-import { StakingRouterFetchModule } from 'common/contracts';
 
 @Module({
-  imports: [LoggerModule, JobModule, StakingRouterFetchModule],
+  imports: [LoggerModule, JobModule],
   providers: [KeysUpdateService],
   exports: [KeysUpdateService],
 })

src/staking-router-modules/contracts/staking-module-interface/index.ts

@@ -0,0 +1,2 @@
+export * from './staking-module-interface.module';
+export * from './staking-module-interface.service';

src/staking-router-modules/contracts/staking-module-interface/staking-module-interface.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { StakingModuleInterfaceService } from './staking-module-interface.service';
+
+@Module({
+  providers: [StakingModuleInterfaceService],
+  exports: [StakingModuleInterfaceService],
+})
+export class StakingModuleInterfaceModule {}

src/common/contracts/i-staking-module/i-staking-module.service.ts → src/staking-router-modules/contracts/staking-module-interface/staking-module-interface.service.ts

@@ -5,7 +5,7 @@ import { ethers } from 'ethers';
 import { BlockTag } from '../interfaces';
 
 @Injectable()
-export class IStakingModuleService {
+export class StakingModuleInterfaceService {
   constructor(protected readonly provider: ExecutionProvider) {}
 
   public async getType(contractAddress: string, blockTag: BlockTag): Promise<string> {

src/staking-router-modules/contracts/staking-router/staking-router-fetch.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { StakingRouterFetchService } from './staking-router-fetch.service';
+import { StakingModuleInterfaceModule } from 'staking-router-modules/contracts/staking-module-interface';
+import { LidoLocatorModule } from 'staking-router-modules/contracts/lido-locator/lido-locator.module';
+
+@Module({
+  imports: [StakingModuleInterfaceModule, LidoLocatorModule],
+  providers: [StakingRouterFetchService],
+  exports: [StakingRouterFetchService],
+})
+export class StakingRouterFetchModule {}

src/common/contracts/staking-router/staking-router-fetch.service.ts → src/staking-router-modules/contracts/staking-router/staking-router-fetch.service.ts

@@ -1,11 +1,9 @@
 import { Injectable, Inject, LoggerService } from '@nestjs/common';
-// TODO: move to staking-router-service
-import { StakingModule } from '../../../staking-router-modules/interfaces/staking-module';
+import { StakingModule } from '../../interfaces/staking-module.interface';
+import { STAKING_MODULE_TYPE } from '../../constants';
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
-import { IStakingModuleService } from 'common/contracts/i-staking-module';
-// TODO: instead of separate file and index create one module with all contants
-import { STAKING_MODULE_TYPE } from 'staking-router-modules/interfaces/staking-module-type';
-import { LidoLocatorService } from 'common/contracts/lido-locator';
+import { StakingModuleInterfaceService } from '../staking-module-interface';
+import { LidoLocatorService } from '../lido-locator';
 import { StakingRouter__factory } from 'generated';
 import { ExecutionProvider } from 'common/execution-provider';
 import { BlockTag } from '../interfaces';
@@ -14,11 +12,10 @@ import { Trace } from 'common/decorators/trace';
 const TRACE_TIMEOUT = 30 * 1000;
 
 @Injectable()
-// TODO: move to staking-router-service
 export class StakingRouterFetchService {
   constructor(
     @Inject(LOGGER_PROVIDER) protected readonly logger: LoggerService,
-    protected readonly iStakingModule: IStakingModuleService,
+    protected readonly stakingModuleInterface: StakingModuleInterfaceService,
     protected readonly lidoLocatorService: LidoLocatorService,
     protected readonly provider: ExecutionProvider,
   ) {}
@@ -47,7 +44,7 @@ export class StakingRouterFetchService {
       modules.map(async (stakingModule) => {
         const isActive = await srContract.getStakingModuleIsActive(stakingModule.id, { blockTag } as any);
 
-        const stakingModuleType = (await this.iStakingModule.getType(
+        const stakingModuleType = (await this.stakingModuleInterface.getType(
           stakingModule.stakingModuleAddress,
           blockTag,
         )) as STAKING_MODULE_TYPE;

src/staking-router-modules/curated-module.service.ts

@@ -11,9 +11,7 @@ import { Trace } from 'common/decorators/trace';
 import { LOGGER_PROVIDER, LoggerService } from 'common/logger';
 import { QueryOrder } from '@mikro-orm/core';
 import { StakingModuleInterface } from './interfaces/staking-module.interface';
-import { KeysFilter } from './interfaces/keys-filter';
-import { OperatorsFilter } from './interfaces';
-import { KeyField } from './interfaces/key-fields';
+import { KeyField, KeysFilter, OperatorsFilter } from './interfaces/filters';
 
 const TRACE_TIMEOUT = 15 * 60 * 1000;
 

src/staking-router-modules/index.ts

@@ -1,3 +1,2 @@
 export * from './staking-router.module';
 export * from './curated-module.service';
-export * from './interfaces/staking-module-type';

src/staking-router-modules/interfaces/filters.ts

@@ -0,0 +1,15 @@
+// TODO: here should be general type for key
+// will be used in /v1/keys and /v1/modules/keys
+
+export type KeyField = 'key' | 'depositSignature' | 'operatorIndex' | 'used' | 'moduleAddress';
+
+//TODO: KeysFilter HTTP query
+// should staking router service import this type from http/entities
+export interface KeysFilter {
+  used?: boolean;
+  operatorIndex?: number;
+}
+
+export interface OperatorsFilter {
+  index?: number;
+}

src/staking-router-modules/interfaces/staking-module.interface.ts

@@ -1,7 +1,34 @@
 import { RegistryKey, RegistryOperator } from 'common/registry';
-import { KeyField } from './key-fields';
-import { KeysFilter } from './keys-filter';
-import { OperatorsFilter } from './operators-filter';
+import { KeyField, KeysFilter, OperatorsFilter } from './filters';
+import { STAKING_MODULE_TYPE } from '../constants';
+
+// interface of modules we get from SR contract
+export interface StakingModule {
+  // unique id of the staking module
+  id: number;
+  // address of staking module
+  stakingModuleAddress: string;
+  // part of the fee taken from staking rewards that goes to the staking module
+  stakingModuleFee: number;
+  // part of the fee taken from staking rewards that goes to the treasury
+  treasuryFee: number;
+  // target percent of total validators in protocol, in BP
+  targetShare: number;
+  // staking module status if staking module can not accept the deposits or can participate in further reward distribution
+  status: number;
+  // name of staking module
+  name: string;
+  // block.timestamp of the last deposit of the staking module
+  lastDepositAt: number;
+  // block.number of the last deposit of the staking module
+  lastDepositBlock: number;
+  // number of exited validators
+  exitedValidatorsCount: number;
+  // type of staking router module
+  type: STAKING_MODULE_TYPE;
+  // is module active
+  active: boolean;
+}
 
 // TODO: in future Keys = CuratedKey (RegistryKey) | CommunityKey
 export type KeyEntity = RegistryKey;

src/staking-router-modules/staking-module-impl-config.ts

@@ -1,5 +1,5 @@
 import { CuratedModuleService } from './curated-module.service';
-import { STAKING_MODULE_TYPE } from './interfaces/staking-module-type';
+import { STAKING_MODULE_TYPE } from './constants';
 
 type StakingModuleImpl = typeof CuratedModuleService;
 

src/staking-router-modules/staking-router.module.ts

@@ -3,6 +3,7 @@ import { ExecutionProvider } from 'common/execution-provider';
 import { KeyRegistryModule } from 'common/registry';
 import { StorageModule } from 'storage/storage.module';
 import { ValidatorsModule } from 'validators';
+import { StakingRouterFetchModule } from './contracts';
 import { CuratedModuleService } from './curated-module.service';
 import { StakingRouterService } from './staking-router.service';
 
@@ -17,6 +18,7 @@ import { StakingRouterService } from './staking-router.service';
     }),
     StorageModule,
     ValidatorsModule,
+    StakingRouterFetchModule,
   ],
   providers: [CuratedModuleService, StakingRouterService],
   exports: [CuratedModuleService, StakingRouterService],

src/staking-router-modules/staking-router.service.ts

@@ -2,9 +2,9 @@ import { EntityManager } from '@mikro-orm/knex';
 import { Inject, Injectable, InternalServerErrorException, LoggerService, NotFoundException } from '@nestjs/common';
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 import { ModuleRef } from '@nestjs/core';
-import { StakingRouterFetchService } from 'common/contracts';
+import { StakingRouterFetchService } from 'staking-router-modules/contracts';
 import { ExecutionProviderService } from 'common/execution-provider';
-import { KeysFilter } from './interfaces/keys-filter';
+
 import { KeyEntity, OperatorEntity, StakingModuleInterface } from './interfaces/staking-module.interface';
 import { httpExceptionTooEarlyResp } from 'http/common/entities/http-exceptions';
 import { KeyWithModuleAddress } from 'http/keys/entities';
@@ -24,8 +24,9 @@ import {
   VALIDATORS_REGISTRY_DISABLED_ERROR,
 } from 'validators/validators.constants';
 import { ValidatorsService } from 'validators';
-import { KeyField } from './interfaces/key-fields';
+
 import { PrometheusService } from 'common/prometheus';
+import { KeyField, KeysFilter } from './interfaces/filters';
 
 @Injectable()
 export class StakingRouterService {

src/storage/sr-module.entity.ts

@@ -1,5 +1,5 @@
-import { Entity, EntityRepositoryType, PrimaryKey, PrimaryKeyType, Property, Unique } from '@mikro-orm/core';
-import { StakingModule } from '../staking-router-modules/interfaces';
+import { Entity, EntityRepositoryType, PrimaryKey, PrimaryKeyType, Property } from '@mikro-orm/core';
+import { StakingModule } from '../staking-router-modules/interfaces/staking-module.interface';
 import { SRModuleRepository } from './sr-module.repository';
 
 @Entity({ customRepository: () => SRModuleRepository })

src/storage/sr-module.storage.ts

@@ -1,7 +1,7 @@
 import { QueryOrder } from '@mikro-orm/core';
 import { FilterQuery, FindOptions } from '@mikro-orm/core';
 import { Injectable } from '@nestjs/common';
-import { StakingModule } from 'staking-router-modules/interfaces';
+import { StakingModule } from '../staking-router-modules/interfaces/staking-module.interface';
 import { SrModuleEntity } from './sr-module.entity';
 import { SRModuleRepository } from './sr-module.repository';