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

[Test] Test the SDK realy handling #13

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

[Test] Test the SDK realy handling #13

red-0ne opened this issue Jun 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@red-0ne
Copy link
Collaborator

red-0ne commented Jun 18, 2024

Objective

Test the SDK relay handling logic and and have it as an example use case and reference it in the documentation.

Origin Document

In order to document how the SDK handles relay requests with a working example, create an example test that documents and exercises the different components involved in the relay request workflow.

image

Goals

  • Demonstrate how the SDK relay handling logic works.
  • Test the SDK happy path.

Deliverables

  • A single PR testing the SDK relay handling happy path

Non-goals / Non-deliverables

  • Test all the code paths of the SDK

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: [@red-0ne ]
Co-Owners: [@adshmh ]

@red-0ne red-0ne added the documentation Improvements or additions to documentation label Jun 18, 2024
@red-0ne red-0ne self-assigned this Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant