SC Monitor Service

Requirements Description

1. Overview

This document outlines the requirements for a Smart Contract Monitoring Service. This service is designed to monitor events emitted by smart contracts, execute specific functions at defined intervals, and publish the results for further utilization.

2. Objective

To provide a comprehensive solution for tracking and interacting with smart contracts on blockchain networks. This includes monitoring contract events, executing contract functions on a schedule, and integrating these outputs with external systems through a Pub/Sub model.

3. Functional Requirements

3.1 Smart Contract Registration

• Contract Address Input: Ability to input the address of the smart contract to monitor.

• Contract ABI Input: Facility to input or upload the ABI of the smart contract.

3.2 Event Listener and Processing

• Dynamic Event Subscription: Subscribe to events of registered contracts.

• Event Processing: Process and decode events as they are emitted.

3.3 Function Execution Scheduler

• Function Registration: Register specific functions within the smart contract for monitoring or execution.

• Interval Configuration: Configure the time intervals for executing registered functions.

• Execution Handling: Handle the execution of functions, including transaction management.

3.4 Pub/Sub System

• Publishing Mechanism: Publish processed event data and function execution outputs to a Pub/Sub system.

• Subscriber Management: Allow subscription to specific topics or queues.

3.5 Security and Authentication

• Secure Access: Implement robust authentication and authorization for API and UI.

• Transaction Security: Ensure secure handling of all blockchain transactions.

3.6 Monitoring and Alerts

• System Health Monitoring: Continuous monitoring of the service's health and performance.

• Alert System: Alert mechanisms for any anomalies or failures.

4. Technical Requirements

4.1 High Availability and Scalability

• Cloud Deployment: The service should be deployable on cloud platforms like GCP.

• Scalability: Ensure the system is scalable to handle varying loads.

4.2 Documentation

• API Documentation: Well-documented API endpoints. Swagger/Async API

5. Use Cases

5.1 Event Monitoring

• Use Case: Monitoring specific events emitted by a smart contract.

• Flow: User registers a smart contract, selects events to monitor, system listens to and processes these events, and publishes them.

5.2 Function Execution

• Use Case: Executing a smart contract function at defined intervals.

• Flow: User registers a function, sets execution intervals, system executes the function at these intervals, processes the output, and publishes it.

6. Conclusion

It aims to bridge the gap between blockchain smart contracts and external systems, providing real-time monitoring and interaction capabilities.