Skip to content

Conversation

@vgonkivs
Copy link
Member

@vgonkivs vgonkivs commented Oct 28, 2025

@vgonkivs vgonkivs self-assigned this Oct 28, 2025
@vgonkivs vgonkivs added the kind:docs For solely documentation PRs label Oct 28, 2025
@vgonkivs vgonkivs changed the title Shrex client server specificatio Shrex client server specification Oct 28, 2025
@codecov-commenter
Copy link

codecov-commenter commented Oct 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (shrex_spec@76db37c). Learn more about missing BASE report.

Additional details and impacted files
@@              Coverage Diff              @@
##             shrex_spec    #4665   +/-   ##
=============================================
  Coverage              ?   36.10%           
=============================================
  Files                 ?      304           
  Lines                 ?    20170           
  Branches              ?        0           
=============================================
  Hits                  ?     7283           
  Misses                ?    11939           
  Partials              ?      948           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Retrieving data from local storage
- Sending responses back to clients

### Request Handling
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in certain cases (ND), not found comes with data too (non incl proof)

- **NOT FOUND**: Requested data is not available
- **INTERNAL ERROR**: Server encountered an error

2. **Data (if OK)**: The actual requested data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also include non-incl proof if ND not found


- Connection failures
- Timeouts
- Invalid data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meaning invalid data sent back from server?

Copy link
Member Author

@vgonkivs vgonkivs Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

relic

Copy link
Member

@walldiss walldiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to add:

  • transport protocol spec (libp2p streaming)
  • message flow. Status message definition and proto. Error model in status message
  • reference to shwap spec defining encoding and payload of requests and responses
  • peer manager integration, reference to peer manager spec

@vgonkivs
Copy link
Member Author

vgonkivs commented Nov 3, 2025

reference to shwap spec defining encoding and payload of requests and responses

I haven't added this spec yet. My idea was to add it when I will be merging all specs into a single.

peer manager integration, reference to peer manager spec

Client-Server does not interact with peer manager, but Getter does.

I will update spec with

transport protocol spec (libp2p streaming)
message flow. Status message definition and proto. Error model in status message

Additionally, I can add a list of available endpoints

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:docs For solely documentation PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants