Websocket Support v1

[stephenpdeos]

Websocket Support v1

Problem

EOS EVM currently lacks native support for WebSockets, which are essential for establishing real-time and interactive communication between dApps and the blockchain network. WebSockets provide a more efficient and responsive alternative to traditional HTTP requests, enabling dApps to receive immediate updates on events, transactions, and contract state changes. The absence of WebSockets limits the real-time capabilities of EOS EVM-based applications, hindering their potential for providing dynamic and interactive user experiences.

Opportunity: What are the needs of our target user groups?

Developers and users within the EOS EVM ecosystem require real-time access to blockchain events and updates for various use cases, such as tracking transactions, monitoring contract state changes, and receiving notifications. With WebSocket support, dApps can deliver more engaging and interactive experiences to users by providing instant updates on blockchain activities.

Strategic alignment: How does this problem align with our core strategic pillars?

The enhancement aligns with our strategic goal of enhancing the user experience and developer capabilities within EOS EVM. By enabling WebSocket support, EOS EVM empowers developers to build dynamic and responsive dApps that provide real-time updates and interactive features to users.

Solution

Solution name: How should we refer to this product opportunity?

Websocket Support v1

Purpose: Define the product’s purpose briefly

The purpose of this enhancement is to introduce native support for WebSockets within EOS EVM. By enabling WebSockets, EOS EVM will allow dApps to establish real-time and interactive communication with the blockchain network, providing instant updates on events, transactions, and contract state changes.

Success definition: What are the top metrics for the product (up to 5) to define success?

1. WebSocket Adoption Rate: Measure the percentage of dApps within the EOS EVM ecosystem that integrate WebSocket support for real-time updates.
2. User Engagement: Monitor user engagement metrics, such as time spent on dApps, transaction frequency, and active users, to assess the impact of real-time updates on user interaction.
3. Developer Satisfaction: Gather feedback from developers about the effectiveness and ease of integrating WebSocket functionality into their dApps.
4. Real-time Notifications: Track the volume of real-time notifications sent to users through WebSocket connections, indicating the success of delivering instant updates.
5. Increase in Interactive Features: Observe the development of dApps offering interactive and real-time features, such as live transaction tracking and dynamic content updates.

Assumptions

Implementing WebSocket support requires modifications to EOS EVM's communication layer to accommodate real-time data streaming.

Risks: What risks should be considered?

There's a potential risk of increased network load due to real-time data streaming, which may impact the overall network performance. Proper optimization and load-balancing mechanisms should be in place to manage this risk.

Business Objectives/Functionality

1. WebSocket Integration: Integrate WebSocket functionality into the EOS EVM network to establish real-time communication channels.
2. Event Subscription: Provide APIs for developers to subscribe to specific blockchain events, transactions, and contract state changes.
3. Real-time Updates: Deliver real-time updates to subscribed dApps, enabling instant notifications and interactive user experiences.
4. Developer Guides: Develop comprehensive guides and documentation to assist developers in integrating WebSocket functionality into their dApps.

User stories

• As a dApp developer, I want to receive real-time updates on blockchain events, transactions, and contract state changes in order to provide instant notifications to users.
• As a dApp user, I want to experience dynamic and interactive features that provide real-time updates on blockchain activities, enhancing my engagement with the application.

Tasks

Beta Give feedback

1. https://github.com/eosnetworkfoundation/eos-evm-internal/issues/48
2. Websocket support for RPC nodes eos-evm-contract#571
   enhancement 👍 lgtm +2
   
3. SubscriptionServer polish for Websocket proxy eos-evm-node#61
   👍 lgtm +1
   
4. BlockMonitor polish for Websocket proxy eos-evm-node#62
   👍 lgtm +1
   
5. WebSocketHandler polish for Websocket proxy eos-evm-node#63
   👍 lgtm +1
   
6. Websocket proxy readme eos-evm-node#64
   👍 lgtm +1
   
7. WebSocket proxy logging eos-evm-node#65
   👍 lgtm +1
   
8. WebSocket proxy unit tests - block monitor eos-evm-node#66
   👍 lgtm +1
   
9. WebSocket proxy unit tests - WebSocket Handler eos-evm-node#75
   👍 lgtm +1
   
10. WebSocket proxy unit tests - Subscription Server eos-evm-node#76
    👍 lgtm +1
    
11. WebSocket proxy: Query logs in a batch request eos-evm-node#69
    👍 lgtm +1
    
12. Configure websocket proxy to route methods to appropriate destination eos-evm-node#91
    👍 lgtm +1
    
13. Configure nginx to route websocket connections to websocket proxy eos-evm-node#90
    👍 lgtm +1
    
14. websocket server send unlinkable blocks (skipping some blocks) during fork switching eos-evm-node#100
    bug 👍 lgtm +2
    

Follow-on tasks

Beta Give feedback

1. Apply rate_limit to tx_proxy eos-evm-node#85
   👍 lgtm +1
   
2. Ensure all the block information (logs) is available when the rpc indicates that a block is part of the chain eos-evm-node#70
   bug 👍 lgtm +2