Merge pull request #14 from withtally/component/batch-executor

Component/batch executor

Author: 0xSero

.env.example

@@ -23,3 +23,10 @@ OPERATOR_PRIVATE_KEY=
 
 # API Keys
 ETHERSCAN_API_KEY=
+
+# CoinMarketCap API
+COINMARKETCAP_API_KEY=your-api-key-here
+
+# Profitability Settings
+TIP_RECEIVER_ADDRESS=0x...
+PRICE_FEED_TOKEN_ADDRESS=0x...

README.md

@@ -0,0 +1,57 @@
+# Staker Profitability Monitor
+
+A service that monitors staking deposits and executes profitable earning power bump transactions.
+
+## Setup
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Configure environment variables:
+   Copy `.env.example` to `.env` and fill in the required values:
+
+- `RPC_URL`: Your Ethereum RPC URL (e.g. from Alchemy or Infura)
+- `STAKER_CONTRACT_ADDRESS`: The address of the Staker contract
+- `PRIVATE_KEY`: Your wallet's private key (without 0x prefix)
+
+## Running the Service
+
+1. Build the TypeScript code:
+
+```bash
+npm run build
+```
+
+2. Start the service:
+
+```bash
+npm start
+```
+
+The service will:
+
+- Monitor deposits in the database
+- Analyze profitability of earning power bumps
+- Execute profitable transactions automatically
+- Log all activities to the console
+
+To stop the service gracefully, press Ctrl+C.
+
+## Configuration
+
+The service can be configured through the following parameters in `main.ts`:
+
+- Poll interval: How often to check for profitable opportunities (default: 15s)
+- Minimum profit margin: Minimum expected profit to execute a transaction (default: 0.001 ETH)
+- Gas price buffer: Additional buffer on gas price estimates (default: 20%)
+- Wallet minimum balance: Minimum wallet balance to maintain (default: 0.1 ETH)
+- Maximum pending transactions: Maximum number of pending transactions (default: 5)
+- Gas boost percentage: Percentage to boost gas price by (default: 10%)
+- Concurrent transactions: Number of transactions to execute concurrently (default: 3)
+
+## Database
+
+The service uses a JSON file database by default (`staker-monitor-db.json`). This can be changed to use Supabase by modifying the database configuration in `main.ts`.

package.json

@@ -21,11 +21,14 @@
   "license": "ISC",
   "dependencies": {
     "@supabase/supabase-js": "^2.48.1",
+    "axios": "^1.7.9",
     "dotenv": "^16.4.5",
-    "ethers": "^6.11.1"
+    "ethers": "^6.11.1",
+    "uuid": "^11.0.5"
   },
   "devDependencies": {
     "@types/node": "^20.17.17",
+    "@types/uuid": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
     "eslint": "^8.57.0",

src/config.ts

@@ -43,6 +43,24 @@ export const CONFIG = {
     confirmations: parseInt(process.env.CONFIRMATIONS || '20'),
     healthCheckInterval: parseInt(process.env.HEALTH_CHECK_INTERVAL || '60'),
   },
+  priceFeed: {
+    coinmarketcap: {
+      apiKey: process.env.COINMARKETCAP_API_KEY || '',
+      baseUrl: 'https://pro-api.coinmarketcap.com/v2',
+      timeout: 5000,
+      retries: 3,
+    },
+  },
+  profitability: {
+    minProfitMargin: ethers.parseEther('0.001'), // 0.001 tokens minimum profit
+    gasPriceBuffer: 20, // 20% buffer for gas price volatility
+    maxBatchSize: 10,
+    defaultTipReceiver: process.env.TIP_RECEIVER_ADDRESS || '',
+    priceFeed: {
+      tokenAddress: process.env.PRICE_FEED_TOKEN_ADDRESS || '',
+      cacheDuration: 10 * 60 * 1000, // 10 minutes
+    },
+  },
 } as const;
 
 // Helper to create provider

src/database/DatabaseWrapper.ts

@@ -23,6 +23,7 @@ export class DatabaseWrapper implements IDatabase {
         deleteDeposit: supabaseDb.deleteDeposit,
         getDeposit: supabaseDb.getDeposit,
         getDepositsByDelegatee: supabaseDb.getDepositsByDelegatee,
+        getAllDeposits: supabaseDb.getAllDeposits,
         updateCheckpoint: supabaseCheckpoints.updateCheckpoint,
         getCheckpoint: supabaseCheckpoints.getCheckpoint,
         createScoreEvent: supabaseScoreEvents.createScoreEvent,
@@ -62,6 +63,14 @@ export class DatabaseWrapper implements IDatabase {
     return this.db.getDepositsByDelegatee(delegateeAddress);
   }
 
+  async getAllDeposits(): Promise<Deposit[]> {
+    if (this.db instanceof JsonDatabase) {
+      return Object.values(this.db.data.deposits);
+    } else {
+      return await supabaseDb.getAllDeposits();
+    }
+  }
+
   // Checkpoints
   async updateCheckpoint(checkpoint: ProcessingCheckpoint): Promise<void> {
     return this.db.updateCheckpoint(checkpoint);

src/database/interfaces/IDatabase.ts

@@ -5,6 +5,7 @@ export interface IDatabase {
   createDeposit(deposit: Deposit): Promise<void>;
   getDeposit(depositId: string): Promise<Deposit | null>;
   getDepositsByDelegatee(delegateeAddress: string): Promise<Deposit[]>;
+  getAllDeposits(): Promise<Deposit[]>;
   updateDeposit(
     depositId: string,
     update: Partial<Omit<Deposit, 'deposit_id'>>,

src/database/interfaces/types.ts

@@ -1,8 +1,8 @@
 export interface Deposit {
   deposit_id: string;
   owner_address: string;
-  amount: number;
-  delegatee_address: string;
+  amount: string;
+  delegatee_address: string | null;
   created_at?: string;
   updated_at?: string;
 }

src/database/json/JsonDatabase.ts

@@ -7,7 +7,7 @@ import { ConsoleLogger, Logger } from '@/monitor/logging';
 export class JsonDatabase implements IDatabase {
   private dbPath: string;
   private logger: Logger;
-  private data: {
+  public data: {
     deposits: Record<string, Deposit>;
     checkpoints: Record<string, ProcessingCheckpoint>;
     score_events: Record<string, Record<number, ScoreEvent>>;
@@ -94,6 +94,10 @@ export class JsonDatabase implements IDatabase {
     );
   }
 
+  async getAllDeposits(): Promise<Deposit[]> {
+    return Object.values(this.data.deposits);
+  }
+
   // Checkpoints
   async updateCheckpoint(checkpoint: ProcessingCheckpoint): Promise<void> {
     this.data.checkpoints[checkpoint.component_type] = {

src/database/supabase/deposits.ts

@@ -47,3 +47,9 @@ export async function getDepositsByDelegatee(
   if (error) throw error;
   return data;
 }
+
+export async function getAllDeposits(): Promise<Deposit[]> {
+  const { data, error } = await supabase.from('deposits').select();
+  if (error) throw error;
+  return data || [];
+}

src/executor/ExecutorWrapper.ts

@@ -0,0 +1,105 @@
+import { ethers } from 'ethers';
+import { BaseExecutor } from './strategies/BaseExecutor';
+import {
+  ExecutorConfig,
+  QueuedTransaction,
+  QueueStats,
+  TransactionReceipt,
+} from './interfaces/types';
+import { DEFAULT_EXECUTOR_CONFIG } from './constants';
+import { ProfitabilityCheck } from '@/profitability/interfaces/types';
+
+export class ExecutorWrapper {
+  private executor: BaseExecutor;
+
+  constructor(
+    stakerContract: ethers.Contract,
+    provider: ethers.Provider,
+    config: Partial<ExecutorConfig> = {},
+  ) {
+    // Merge provided config with defaults
+    const fullConfig: ExecutorConfig = {
+      ...DEFAULT_EXECUTOR_CONFIG,
+      ...config,
+      wallet: {
+        ...DEFAULT_EXECUTOR_CONFIG.wallet,
+        ...config.wallet,
+      },
+    };
+
+    this.executor = new BaseExecutor(stakerContract, provider, fullConfig);
+  }
+
+  /**
+   * Start the executor
+   */
+  async start(): Promise<void> {
+    await this.executor.start();
+  }
+
+  /**
+   * Stop the executor
+   */
+  async stop(): Promise<void> {
+    await this.executor.stop();
+  }
+
+  /**
+   * Get the current status of the executor
+   */
+  async getStatus(): Promise<{
+    isRunning: boolean;
+    walletBalance: bigint;
+    pendingTransactions: number;
+    queueSize: number;
+  }> {
+    return this.executor.getStatus();
+  }
+
+  /**
+   * Queue a transaction for execution
+   */
+  async queueTransaction(
+    depositId: bigint,
+    profitability: ProfitabilityCheck,
+  ): Promise<QueuedTransaction> {
+    return this.executor.queueTransaction(depositId, profitability);
+  }
+
+  /**
+   * Get statistics about the transaction queue
+   */
+  async getQueueStats(): Promise<QueueStats> {
+    return this.executor.getQueueStats();
+  }
+
+  /**
+   * Get a specific transaction by ID
+   */
+  async getTransaction(id: string): Promise<QueuedTransaction | null> {
+    return this.executor.getTransaction(id);
+  }
+
+  /**
+   * Get transaction receipt
+   */
+  async getTransactionReceipt(
+    hash: string,
+  ): Promise<TransactionReceipt | null> {
+    return this.executor.getTransactionReceipt(hash);
+  }
+
+  /**
+   * Transfer accumulated tips to the configured receiver
+   */
+  async transferOutTips(): Promise<TransactionReceipt | null> {
+    return this.executor.transferOutTips();
+  }
+
+  /**
+   * Clear the transaction queue
+   */
+  async clearQueue(): Promise<void> {
+    await this.executor.clearQueue();
+  }
+}