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.

Sign up for GitHub

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

fix: typos in documentation files #1003

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+5 −5
Open

fix: typos in documentation files #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3dc83e
Update flags.go
vtjl10 Dec 14, 2024
da1fce2
Update node.md
vtjl10 Dec 14, 2024
41f6733
Update node.proto
vtjl10 Dec 16, 2024
833eca3
Update node.proto
vtjl10 Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/docs/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ BatchHeader (see core/data.go#BatchHeader)
<a name="node-Blob"></a>

### Blob
In EigenDA, the original blob to disperse is encoded as a polynomial via taking
Copy link
Contributor

Choose a reason for hiding this comment

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

You need to edit the .proto file instead and then generate the md files

In EigenDA, the original blob to disperse is encoded as a polynomial via
taking different point evaluations (i.e. erasure coding). These points are split
into disjoint subsets which are assigned to different operator nodes in the EigenDA
network.
Expand Down
6 changes: 3 additions & 3 deletions api/proto/node/node.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ service Dispersal {
// for the protocol-defined length of custody. It will return a signature at the
// end to attest to the data in this request it has processed.
rpc StoreChunks(StoreChunksRequest) returns (StoreChunksReply) {}
// StoreBlobs is simiar to StoreChunks, but it stores the blobs using a different storage schema
// StoreBlobs is similar to StoreChunks, but it stores the blobs using a different storage schema
// so that the stored blobs can later be aggregated by AttestBatch method to a bigger batch.
// StoreBlobs + AttestBatch will eventually replace and deprecate StoreChunks method.
// DEPRECATED: StoreBlobs method is not used
Expand Down Expand Up @@ -59,7 +59,7 @@ message StoreBlobsRequest {
}

message StoreBlobsReply {
// The operator's BLS sgnature signed on the blob header hashes.
// The operator's BLS signature signed on the blob header hashes.
// The ordering of the signatures must match the ordering of the blobs sent
// in the request, with empty signatures in the places for discarded blobs.
repeated google.protobuf.BytesValue signatures = 1;
Expand Down Expand Up @@ -131,7 +131,7 @@ message MerkleProof {
// Types

// In EigenDA, the original blob to disperse is encoded as a polynomial via taking
// taking different point evaluations (i.e. erasure coding). These points are split
// different point evaluations (i.e. erasure coding). These points are split
// into disjoint subsets which are assigned to different operator nodes in the EigenDA
// network.
// The data in this message is a subset of these points that are assigned to a
Expand Down
2 changes: 1 addition & 1 deletion node/flags/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ var (

// This flag is used to control if the DA Node registers itself when it starts.
// This is useful for testing and for hosted node where we don't want to have
// mannual operation with CLI to register.
// manual operation with CLI to register.
// By default, it will not register itself at start.
RegisterAtNodeStartFlag = cli.BoolFlag{
Name: common.PrefixFlag(FlagPrefix, "register-at-node-start"),
Expand Down