docs: add minimum symbols to proto api explanation #1211
Merged
Conversation
This file contains hidden or 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
jianoaix
approved these changes
Feb 4, 2025
| @@ -29,6 +29,8 @@ message DisperseBlobRequest { | |||
| // The blob to be dispersed. | |||
| // | |||
| // The size of this byte array may be any size as long as it does not exceed the maximum length of 16MiB. | |||
| // While there is no minimum size, the blob size charged against the payment method will be rounded up to | |||
| // the nearest multiple of `minNumSymbols` defined by the payment vault contract (https://github.com/Layr-Labs/eigenda/blob/1430d56258b4e814b388e497320fd76354bfb478/contracts/src/payments/PaymentVaultStorage.sol#L9). | |||
| // (In the future, the 16MiB limit may be increased, but this is not guaranteed to happen.) | |||
There was a problem hiding this comment.
// (In the future, the 16MiB limit may be increased, but this is not guaranteed to happen.)
is this not true anymore?
There was a problem hiding this comment.
removed the line but still curious
There was a problem hiding this comment.
Just not quite useful to mention a "maybe" future that doesn't have any specifics at the API.
When we actually increase it, we'll announce it loud and clear anyway (and update this documentation).
| @@ -29,6 +29,8 @@ message DisperseBlobRequest { | |||
| // The blob to be dispersed. | |||
| // | |||
| // The size of this byte array may be any size as long as it does not exceed the maximum length of 16MiB. | |||
| // While there is no minimum size, the blob size charged against the payment method will be rounded up to | |||
There was a problem hiding this comment.
Can it be 0? len(blob)>0 is required right?
There was a problem hiding this comment.
you are right, fixed the sentence
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?
Checks