Move over EVM Verifier

Author: adg-flare

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - `Web2Json`: added `PublicWeb2` source support, allows calling any public Web2 endpoint. Only available on testnets.
+- Migrated `evm` verifier type with `EVMTransaction` attestation type support into this repository from the [evm-verifier](https://gitlab.com/flarenetwork/fdc/evm-verifier) repository, which is now deprecated.
 
 ### Changed
 

docker/verifier-evm/compose.yml

@@ -0,0 +1,39 @@
+services:
+  verifier_eth:
+    build: ../../
+    restart: unless-stopped
+    container_name: verifier_eth
+    environment:
+      VERIFIER_TYPE: eth
+      TESTNET: false
+      API_KEYS: "123456"
+      PORT: 3100
+      EVM_RPC: "https://ethereum.publicnode.com"
+    ports:
+      - "3004:3100"
+
+  verifier_flr:
+    build: ../../
+    restart: unless-stopped
+    container_name: verifier_flr
+    environment:
+      VERIFIER_TYPE: flr
+      TESTNET: false
+      API_KEYS: "123456"
+      PORT: 3100
+      EVM_RPC: "https://flare-api.flare.network/ext/C/rpc"
+    ports:
+      - "3005:3100"
+
+  verifier_sgb:
+    build: ../../
+    restart: unless-stopped
+    container_name: verifier_sgb
+    environment:
+      VERIFIER_TYPE: sgb
+      TESTNET: false
+      API_KEYS: "123456"
+      PORT: 3100
+      EVM_RPC: "https://songbird-api.flare.network/ext/C/rpc"
+    ports:
+      - "3006:3100"

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "fasset-verifier-server",
+  "name": "fdc-verifier-server",
   "version": "0.0.1",
   "description": "",
   "author": "",

src/auth/auth.service.ts

@@ -7,7 +7,7 @@ export class AuthService {
   API_KEYS: string[];
 
   constructor(private readonly configService: ConfigService<IConfig>) {
-    const API_KEYS: string[] = this.configService.get('api_keys');
+    const API_KEYS: string[] = this.configService.get('apiKeys');
     if (!API_KEYS) {
       throw new Error('Env variables are missing (API_KEYS)');
     }

src/config/configuration.ts

@@ -18,34 +18,38 @@ import { IndexerConfig } from './interfaces/chain-indexer';
 import { TypeOrmModuleOptions } from '@nestjs/typeorm';
 import { web2JsonDefaultParams } from './defaults/web2-json-config';
 import { getDatabaseConfig } from './defaults/indexer-config';
-import { IConfig, VerifierServerConfig } from './interfaces/common';
+import { IConfig } from './interfaces/common';
 import { Web2JsonConfig, Web2JsonSource } from './interfaces/web2-json';
 import { WEB2_JSON_TEST_SOURCES } from './web2/web2-json-test-sources';
 import { WEB2_JSON_SOURCES } from './web2/web2-json-sources';
 
 export default () => {
-  const api_keys = getApiKeys();
-  const verifier_type = extractVerifierType();
+  const apiKeys = getApiKeys();
+  const verifierType = extractVerifierType();
   const isTestnet = process.env.TESTNET == 'true';
 
-  const verifierConfig: VerifierServerConfig = {
-    verifierType: verifier_type,
-    numberOfConfirmations: parseInt(process.env.NUMBER_OF_CONFIRMATIONS || '6'), // TODO: This should be read from db state
-    indexerServerPageLimit: parseInt(
-      process.env.INDEXER_SERVER_PAGE_LIMIT || '100',
-    ),
-  };
-
   const config: IConfig = {
     port: parseInt(process.env.PORT || '3120'),
-    api_keys,
-    verifierConfig,
+    apiKeys: apiKeys,
     isTestnet,
+    verifierType,
   };
-  if (verifier_type === ChainType.Web2) {
-    config.web2JsonConfig = getWeb2Config(isTestnet);
-  } else {
-    config.indexerConfig = getIndexerConfig(verifier_type);
+
+  switch (verifierType) {
+    case VerifierType.BTC:
+    case VerifierType.DOGE:
+    case VerifierType.XRP:
+      config.indexerConfig = getIndexerConfig(verifierType);
+      break;
+    case VerifierType.ETH:
+    case VerifierType.SGB:
+    case VerifierType.FLR:
+      config.evmRpcUrl =
+        process.env.EVM_RPC || 'https://flare-api.flare.network/ext/C/rpc';
+      break;
+    case VerifierType.Web2:
+      config.web2JsonConfig = getWeb2Config(isTestnet);
+      break;
   }
 
   return config;
@@ -66,28 +70,34 @@ export function getApiKeys(): string[] {
   return apiKeys;
 }
 
-export function extractVerifierType(): ChainType {
+export function extractVerifierType(): VerifierType {
   const verifierType = process.env.VERIFIER_TYPE?.toLowerCase();
   switch (verifierType) {
     case 'doge':
-      return ChainType.DOGE;
+      return VerifierType.DOGE;
     case 'btc':
-      return ChainType.BTC;
+      return VerifierType.BTC;
     case 'xrp':
-      return ChainType.XRP;
+      return VerifierType.XRP;
     case 'web2':
-      return ChainType.Web2;
+      return VerifierType.Web2;
+    case 'eth':
+      return VerifierType.ETH;
+    case 'sgb':
+      return VerifierType.SGB;
+    case 'flr':
+      return VerifierType.FLR;
     default:
       throw new Error(
-        `Wrong verifier type: '${String(process.env.VERIFIER_TYPE)}' provide a valid verifier type: 'doge' | 'btc' | 'xrp' | 'web2'`,
+        `Wrong verifier type: '${String(process.env.VERIFIER_TYPE)}' provide a valid verifier type: 'doge' | 'btc' | 'xrp' | 'web2' | 'eht' | 'sgb' | 'flr'`,
       );
   }
 }
 
-export function getDatabaseEntities(verifierType: ChainType) {
+export function getDatabaseEntities(verifierType: VerifierType) {
   switch (verifierType) {
-    case ChainType.BTC:
-    case ChainType.DOGE:
+    case VerifierType.BTC:
+    case VerifierType.DOGE:
       return [
         DBUtxoIndexerBlock,
         DBUtxoTransaction,
@@ -98,7 +108,7 @@ export function getDatabaseEntities(verifierType: ChainType) {
         DBPruneSyncState,
         DBIndexerVersion,
       ];
-    case ChainType.XRP:
+    case VerifierType.XRP:
       return [
         DBXrpIndexerBlock,
         DBXrpTransaction,
@@ -137,47 +147,73 @@ function getWeb2Config(isTestnet: boolean): Web2JsonConfig {
   };
 }
 
-function getIndexerConfig(verifierType: ChainType): IndexerConfig {
-  switch (verifierType) {
-    case ChainType.BTC:
-    case ChainType.DOGE:
-    case ChainType.XRP: {
-      const entities = getDatabaseEntities(verifierType);
-      const databaseConfig = getDatabaseConfig();
-      const typeOrmModulePartialOptions: TypeOrmModuleOptions = {
-        ...databaseConfig,
-        type: 'postgres',
-        synchronize: false,
-        migrationsRun: false,
-        logging: false,
-      };
-      const typeOrmModuleOptions: TypeOrmModuleOptions = {
-        ...typeOrmModulePartialOptions,
-        entities,
-      };
-      return { db: databaseConfig, typeOrmModuleOptions };
-    }
-    case ChainType.Web2:
-      throw new Error('Web2 verifier does not use indexer config');
-    default:
-      throw new Error(`Unsupported verifier type: ${verifierType}`);
-  }
+function getIndexerConfig(verifierType: VerifierType): IndexerConfig {
+  const entities = getDatabaseEntities(verifierType);
+  const databaseConfig = getDatabaseConfig();
+  const typeOrmModulePartialOptions: TypeOrmModuleOptions = {
+    ...databaseConfig,
+    type: 'postgres',
+    synchronize: false,
+    migrationsRun: false,
+    logging: false,
+  };
+  const typeOrmModuleOptions: TypeOrmModuleOptions = {
+    ...typeOrmModulePartialOptions,
+    entities,
+  };
+  return {
+    db: databaseConfig,
+    typeOrmModuleOptions,
+    numberOfConfirmations: parseInt(process.env.NUMBER_OF_CONFIRMATIONS || '6'), // TODO: This should be read from db state
+    indexerServerPageLimit: parseInt(
+      process.env.INDEXER_SERVER_PAGE_LIMIT || '100',
+    ),
+  };
 }
 
-export type ChainSourceNames = 'DOGE' | 'BTC' | 'XRP';
 export type AttestationTypeOptions =
   | 'AddressValidity'
   | 'BalanceDecreasingTransaction'
   | 'ConfirmedBlockHeightExists'
   | 'Payment'
   | 'ReferencedPaymentNonexistence'
-  | 'Web2Json';
+  | 'Web2Json'
+  | 'EVMTransaction';
 
-export enum ChainType {
-  invalid = -1,
+export enum VerifierType {
   BTC = 0,
   DOGE = 2,
   XRP = 3,
   Web2 = 4,
-  // ... make sure IDs are the same as in Flare node
+  ETH = 5,
+  SGB = 6,
+  FLR = 7,
+}
+
+export function typeToSource(type: VerifierType): ChainSourceNames {
+  switch (type) {
+    case VerifierType.BTC:
+      return 'BTC';
+    case VerifierType.DOGE:
+      return 'DOGE';
+    case VerifierType.XRP:
+      return 'XRP';
+    case VerifierType.ETH:
+      return 'ETH';
+    case VerifierType.SGB:
+      return 'SGB';
+    case VerifierType.FLR:
+      return 'FLR';
+    case VerifierType.Web2:
+      return 'WEB2';
+  }
 }
+
+export type ChainSourceNames =
+  | 'DOGE'
+  | 'BTC'
+  | 'XRP'
+  | 'ETH'
+  | 'SGB'
+  | 'FLR'
+  | 'WEB2';

src/config/interfaces/chain-indexer.ts

@@ -30,4 +30,14 @@ export interface DatabaseConfig {
 export interface IndexerConfig {
   db: DatabaseConfig;
   typeOrmModuleOptions: TypeOrmModuleOptions;
+
+  /**
+   * The page size for indexer API queries when listing outputs
+   */
+  indexerServerPageLimit: number;
+
+  /**
+   * The number of confirmations required for a transaction to be considered confirmed
+   */
+  numberOfConfirmations: number;
 }

src/config/interfaces/common.ts

@@ -1,32 +1,17 @@
-import { ChainType } from '../configuration';
+import { VerifierType } from '../configuration';
 import { Web2JsonConfig } from './web2-json';
 import { IndexerConfig } from './chain-indexer';
 
 export interface IConfig {
   /** Server port (PORT) */
   port: number;
   /** Comma-separated list of API keys (API_KEYS) */
-  api_keys: string[];
-
+  apiKeys: string[];
   isTestnet: boolean;
-
-  verifierConfig: VerifierServerConfig;
+  verifierType: VerifierType;
   /** Indexer configuration for BTC, DOGE and XRP verifiers */
   indexerConfig?: IndexerConfig;
   /** Security and source configuration for Web2Json verifier */
   web2JsonConfig?: Web2JsonConfig;
-}
-
-export interface VerifierServerConfig {
-  verifierType: ChainType;
-
-  /**
-   * The page size for indexer API queries when listing outputs
-   */
-  indexerServerPageLimit: number;
-
-  /**
-   * The number of confirmations required for a transaction to be considered confirmed
-   */
-  numberOfConfirmations: number;
+  evmRpcUrl?: string;
 }