Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Off-Chain] Enhance RelayMiner and Gateway Communication Protocols #590

Open
6 tasks
red-0ne opened this issue Jun 5, 2024 · 0 comments
Open
6 tasks

[Off-Chain] Enhance RelayMiner and Gateway Communication Protocols #590

red-0ne opened this issue Jun 5, 2024 · 0 comments
Assignees
Labels
off-chain Off-chain business logic relayminer Changes related to the Relayminer research Related to open-ended research & investigation sdk Everything relatd to the sdk

Comments

@red-0ne
Copy link
Contributor

red-0ne commented Jun 5, 2024

Objective

Enhance the communication protocol between RelayMiners and Gateways for RelayRequest/RelayResponse exchanges while maintaining support for existing protocols.

Origin Document

Currently, the communication between the AppGateServer and the RelayMiner uses HTTP. This could be improved by adopting a more generic and performant protocol, such as pure TCP or QUIC

Screenshot 2024-06-04 at 2 07 03 PM

Goals

  • Investigate potential communication protocols for RelayMiner<->Gateway select the most suitable one.
  • Modify the RelayMiner config to support multiple communication protocols.
  • Implement the chosen protocol's server in the RelayMiner.
  • Implement the chosen protocol's client in the AppGateServer.

Deliverables

  • A research document evaluating different communication protocols and recommending the best option.
  • A single PR that includes:
    • Updates to the RelayMiner configuration to support multiple communication protocols.
    • Server implementation of the new protocol in the RelayMiner
    • Client implementation of the new protocol in the AppGateServer

Non-goals / Non-deliverables

  • The new communication protocol should complement, not replace, the existing protocol.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: [@studna]
Co-Owners: [@red-0ne]

@red-0ne red-0ne added relayminer Changes related to the Relayminer off-chain Off-chain business logic sdk Everything relatd to the sdk labels Jun 5, 2024
@Olshansk Olshansk added the research Related to open-ended research & investigation label Jun 5, 2024
@Olshansk Olshansk removed this from the Research, Writing & Publication milestone Aug 5, 2024
@Olshansk Olshansk added this to the Shannon Quality of Life milestone Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
off-chain Off-chain business logic relayminer Changes related to the Relayminer research Related to open-ended research & investigation sdk Everything relatd to the sdk
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants