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

[Documentation]: Improve gRPC Command Examples for Clarity #762

Open
log2cn opened this issue Sep 14, 2024 · 1 comment
Open

[Documentation]: Improve gRPC Command Examples for Clarity #762

log2cn opened this issue Sep 14, 2024 · 1 comment

Comments

@log2cn
Copy link

log2cn commented Sep 14, 2024

Documentation.

I would like to propose some improvements to the documentation found in the eigenda/inabox README regarding the gRPC commands for sending and retrieving blob status.

Suggested Changes:

  1. Update the command for dispersing a blob:
    Current command:

    grpcurl -plaintext -d '{"data": "'$(tools/kzgpad/bin/kzgpad -e hello)'"}' \
    localhost:32003 disperser.Disperser/DisperseBlob

    Suggested command:

    REQUEST_ID=$(grpcurl -plaintext -d '{"data": "'$(../tools/kzgpad/bin/kzgpad -e hello)'"}' \
    localhost:32003 disperser.Disperser/DisperseBlob | jq -r .requestId)

    Reason: This change captures the REQUEST_ID directly in the command, making it easier for users to reference this ID in subsequent commands without needing to manually extract it.

  2. Update the command for checking blob status:
    Current command:

    grpcurl -plaintext -d '{"request_id": "$REQUEST_ID"}' \
    localhost:32003 disperser.Disperser/GetBlobStatus

    Suggested command:

    grpcurl -plaintext -d "{\"request_id\": \"$REQUEST_ID\"}" \
    localhost:32003 disperser.Disperser/GetBlobStatus

    Reason: Using double quotes for the JSON string allows for proper variable interpolation, ensuring that the value of REQUEST_ID is correctly passed in the request.

Additional information.

Thank you for considering these changes!

@samlaf
Copy link
Contributor

samlaf commented Oct 29, 2024

@l0g2 very much agree with you here, I had the same hiccups when first playing with these. May I suggest you put a quick PR up for this, I'll gladly accept it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants