refactor

Author: signorecello

tooling/sparta/README.md

@@ -44,7 +44,7 @@ sparta/
 ├── src/                      # Source code
 │   ├── clients/              # External API clients (Discord, Ethereum, Google)
 │   ├── roles/                # Role-specific Discord commands
-│   │   ├── 00_guardians/     # Commands for Guardian role 
+│   │   ├── nodeOperators/    # Commands for Node Operator role 
 │   │   └── admins/           # Admin-only commands
 │   ├── services/             # Business logic services
 │   │   ├── chaininfo-service.ts    # Chain information retrieval
@@ -156,7 +156,7 @@ terraform apply
 ### Role Management
 - Monitors Google Sheets for user scores
 - Assigns Discord roles based on score thresholds:
-  - Guardian (base role): Default role
+  - Node Operator (base role): Default role
   - Defender (middle role): Score > 5
   - Sentinel (highest role): Score > 10
 
@@ -173,7 +173,7 @@ terraform apply
 
 ## Available Commands
 
-### Guardian Commands
+### Node Operator Commands
 - `/get-info`: Get chain information including pending block, proven block, current epoch, current slot, and proposer
 - `/validator check`: Check if an address is a validator
 - `/validator register`: Register a validator address
@@ -223,6 +223,44 @@ terraform apply
 - Error tracking and reporting
 - Performance monitoring
 
+## Logging
+
+The application uses Pino for structured logging with the following features:
+
+- **Multiple log levels**: trace, debug, info, warn, error, fatal
+- **Colorful output**: Different colors for different log levels when pretty printing is enabled
+- **Timestamps**: Each log includes an ISO timestamp
+- **Request logging**: HTTP requests can be logged at the debug level
+- **Structured logging**: Logs are output in JSON format for easy parsing
+
+### Configuration
+
+Logging can be configured through environment variables:
+
+- `LOG_LEVEL`: Set the minimum log level (trace, debug, info, warn, error, fatal)
+- `LOG_PRETTY_PRINT`: Enable/disable colorful, human-readable logs (true/false)
+
+#### Example
+
+```sh
+# Set log level to debug and enable pretty printing
+export LOG_LEVEL=debug
+export LOG_PRETTY_PRINT=true
+npm run dev
+```
+
+### Terraform Configuration
+
+Logging can also be configured through Terraform variables:
+
+```hcl
+module "sparta" {
+  # ...
+  log_level        = "debug"
+  log_pretty_print = true
+}
+```
+
 ## Contributing
 
 1. Create a feature branch

tooling/sparta/src/.env.example

@@ -17,3 +17,9 @@ APPROVAL_AMOUNT=10000000000000000000000
 # Google Sheets Configuration
 GOOGLE_API_KEY=your_google_api_key_here
 SPREADSHEET_ID=your_spreadsheet_id_here
+
+# Logging Configuration
+# Available levels: trace, debug, info, warn, error, fatal
+LOG_LEVEL=info
+# Enable/disable pretty printing with colors (true/false)
+LOG_PRETTY_PRINT=true

tooling/sparta/src/.gitignore

@@ -173,3 +173,4 @@ dist
 
 # Finder (MacOS) folder config
 .DS_Store
+dist

tooling/sparta/src/README.md

@@ -34,7 +34,7 @@ The `services/` directory contains the core business logic:
 
 The `roles/` directory contains command definitions for different user roles:
 
-- **00_guardians/**: Commands available to users with the Guardian role
+- **nodeOperators/**: Commands available to users with the Node Operator role
   - **validator.ts**: Commands for validator registration and checking
   - **getChainInfo.ts**: Commands for retrieving chain information
 - **admins/**: Commands available only to administrators
@@ -45,18 +45,18 @@ The `roles/` directory contains command definitions for different user roles:
 
 The bot automatically assigns hierarchical Discord roles based on user scores from Google Sheets:
 
-1. **Guardian**: Base role (default)
-2. **Defender**: Middle role (score > 5)
-3. **Sentinel**: Highest role (score > 10)
+1. **Guardian**: Base role (default, requires minimum score of 0)
+2. **Defender**: Middle role (requires score > 5)
+3. **Sentinel**: Highest role (set manually, but can be removed by this service)
 
 ```typescript
 // Example from googlesheet-service.ts
 if (score > 10) {
-  roleName = "Sentinel"; // Highest role
+  roleName = NodeOperatorRoles.Sentinel; // Highest role
 } else if (score > 5) {
-  roleName = "Defender"; // Middle role
+  roleName = NodeOperatorRoles.Defender; // Middle role
 } else {
-  roleName = "Guardian"; // Default/lowest role
+  roleName = NodeOperatorRoles.Guardian; // Default/lowest role
 }
 ```
 

tooling/sparta/src/clients/aztec.ts

@@ -3,6 +3,7 @@
  * @description Provides Aztec node interaction methods via JSON-RPC
  * @module sparta/utils/aztec
  */
+import { logger } from "../utils/logger.js";
 
 export class Aztec {
 	private readonly rpcUrl: string;
@@ -13,7 +14,7 @@ export class Aztec {
 
 	static new = async () => {
 		try {
-			console.log("Initializing Aztec client");
+			logger.info("Initializing Aztec client");
 			const rpcUrl = process.env.AZTEC_NODE_URL;
 
 			if (!rpcUrl) {
@@ -22,7 +23,7 @@ export class Aztec {
 
 			return new Aztec(rpcUrl);
 		} catch (error) {
-			console.error("Error initializing Aztec client:", error);
+			logger.error({ error }, "Error initializing Aztec client");
 			throw error;
 		}
 	};

tooling/sparta/src/clients/discord.ts

@@ -14,8 +14,9 @@ import {
 	REST,
 	Routes,
 } from "discord.js";
-import guardianCommands from "../roles/00_guardians/index.js";
+import nodeOperatorCommands from "../roles/nodeOperators/index.js";
 import adminsCommands from "../roles/admins/index.js";
+import { logger } from "../utils/logger.js";
 
 // Extended Discord client interface with commands collection
 export interface ExtendedClient extends Client {
@@ -34,7 +35,7 @@ export class Discord {
 	 */
 	static new = async () => {
 		try {
-			console.log("Initializing Discord client");
+			logger.info("Initializing Discord client");
 
 			// Initialize Discord client with required intents
 			const client = new Client({
@@ -55,7 +56,7 @@ export class Discord {
 
 			return new Discord(client);
 		} catch (error) {
-			console.error("Error initializing Discord client:", error);
+			logger.error({ error }, "Error initializing Discord client");
 			throw error;
 		}
 	};
@@ -69,15 +70,18 @@ export class Discord {
 		 * Error event handler
 		 */
 		client.once("error", (error) => {
-			console.error("Error:", error);
+			logger.error({ error }, "Discord client error");
 		});
 
 		/**
 		 * Ready event handler - called when bot is initialized
 		 */
 		client.once("ready", async () => {
-			console.log("Sparta bot is ready!");
-			console.log("Bot Client ID: ", process.env.BOT_CLIENT_ID);
+			logger.info("Sparta bot is ready!");
+			logger.info(
+				{ clientId: process.env.BOT_CLIENT_ID },
+				"Bot connected with Client ID"
+			);
 			Discord.deployCommands(client);
 		});
 
@@ -95,15 +99,21 @@ export class Discord {
 				const channel = interaction.channel as TextChannel;
 
 				const reply = await command.execute(interaction);
-				console.log("Command:", {
-					name: interaction.commandName,
-					channel: channel.name,
-					user: interaction.user.username,
-					date: interaction.createdAt,
-					result: reply,
-				});
+				logger.info(
+					{
+						name: interaction.commandName,
+						channel: channel.name,
+						user: interaction.user.username,
+						date: interaction.createdAt,
+						result: reply,
+					},
+					"Command executed"
+				);
 			} catch (error) {
-				console.error(error);
+				logger.error(
+					{ error, command: interaction.commandName },
+					"Error executing command"
+				);
 				await interaction.reply({
 					content: "There was an error executing this command!",
 					flags: MessageFlags.Ephemeral,
@@ -122,10 +132,10 @@ export class Discord {
 		);
 
 		try {
-			console.log("Started refreshing application (/) commands.");
+			logger.info("Started refreshing application (/) commands");
 
 			const commandsData = Object.values({
-				...guardianCommands,
+				...nodeOperatorCommands,
 				...adminsCommands,
 			}).map((command) => command.data.toJSON());
 
@@ -140,16 +150,16 @@ export class Discord {
 			);
 
 			for (const command of Object.values({
-				...guardianCommands,
+				...nodeOperatorCommands,
 				...adminsCommands,
 			})) {
 				client.commands.set(command.data.name, command);
-				console.log(`Registered command: ${command.data.name}`);
+				logger.debug(`Registered command: ${command.data.name}`);
 			}
 
-			console.log("Successfully reloaded application (/) commands.");
+			logger.info("Successfully reloaded application (/) commands");
 		} catch (error) {
-			console.error(error);
+			logger.error({ error }, "Error deploying commands");
 		}
 	}
 

tooling/sparta/src/clients/ethereum.ts

@@ -23,6 +23,8 @@ import { RegistryAbi } from "../utils/abis/registryAbi.js";
 import { privateKeyToAccount } from "viem/accounts";
 import type { Hex } from "viem";
 import { ForwarderBytecode, ForwarderAbi } from "../utils/abis/forwarder.js";
+import { logger } from "../utils/logger.js";
+
 export const DEPLOYER_ADDRESS: Hex =
 	"0x4e59b44847b379578588920cA78FbF26c0B4956C";
 
@@ -67,6 +69,7 @@ export function getExpectedAddress(args: [`0x${string}`], salt: Hex) {
 		calldata,
 	};
 }
+
 export class Ethereum {
 	constructor(
 		private publicClient: ReturnType<typeof createPublicClient>,
@@ -77,7 +80,7 @@ export class Ethereum {
 
 	static new = async () => {
 		try {
-			console.log("Initializing Ethereum client");
+			logger.info("Initializing Ethereum client");
 			const rpcUrl = process.env.ETHEREUM_HOST as string;
 			const privateKey = process.env.MINTER_PRIVATE_KEY as `0x${string}`;
 
@@ -119,7 +122,7 @@ export class Ethereum {
 				stakingAsset
 			);
 		} catch (error) {
-			console.error("Error initializing Ethereum client:", error);
+			logger.error({ error }, "Error initializing Ethereum client");
 			throw error;
 		}
 	};