docs: add documentation for disperser v2 grpc api and related functions/structs #1104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samlaf
commented
Jan 13, 2025
Comment on lines
+29
to
31
| // TODO: is this length always a power of 2? Are there any other characteristics that we should list? etc. | ||
| uint32 length = 4; | ||
| } |
There was a problem hiding this comment.
Does anyone know for this one?
There was a problem hiding this comment.
Yes it's the padded length, always power of 2 (so maybe not really "actual degree/length" as commented above)
samlaf
commented
Jan 13, 2025
Comment on lines
+19
to
+21
| // TODO: we should probably just force the data to be a multiple of 32 bytes. | ||
| // This would make the API and code simpler to read, and also allow the code | ||
| // to be auto-vectorized by the compiler (it probably isn't right now given the if inside the for loop). |
There was a problem hiding this comment.
Can we do this? Really think it would greatly help devex.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
The v2 interfaces are missing documentation, which makes it hard for intergration to interface with core. Adding some ad-hoc documentation here for thing that I needed to lookup today, but would be useful to do a uniform pass on the API to make sure its documentation is complete at some point.
Just learned about #1082, so therre might be some redundancy here. Probably should merge that one first (it's documents every more broadly) and then I'll rebase mine on top (I have more precise documentation for much fewer things).
Checks