Skip to content

Commit

Permalink
Fix typos (rollkit#1579)
Browse files Browse the repository at this point in the history
Fix typos

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Improved clarity and corrected grammatical errors in the
`CONTRIBUTING.md` file, including instructions for community
contributions.
- Corrected typos in documentation files for better accuracy and
consistency.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
omahs authored Mar 5, 2024
1 parent bec9ad0 commit fc0f100
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Issue labels have been used to help designate the priority, status and beginner-
- **Issues available for community contribution:**
- `good first issue`: Open to participation from the community and friendly towards new contributors

No explicit permission is needed to work on these issues but it would be good idea to tag the user who opened the issue and ask that the issue is assinged to yourself.
No explicit permission is needed to work on these issues but it would be a good idea to tag the user who opened the issue and request that the issue be assigned to yourself.

All issue labels can be [found here](https://github.com/rollkit/rollkit/labels) for you to explore and see what peaks your interest.

Expand All @@ -27,7 +27,7 @@ Once you've found an issue you'd like to work on, please follow these steps to m

If you want to work on something that there is no GitHub issue for, follow these steps:

1. Create a a new GitHub issue and propose your change there. Be sure to include implementation details and the rationale for the proposed change.
1. Create a new GitHub issue and propose your change there. Be sure to include implementation details and the rationale for the proposed change.
- We are very reluctant to accept random pull requests without a related issue created first.
2. Wait for a project maintainer to evaluate your issue and decide whether it's something that we will accept a pull request for.
3. Once the project maintainer has approved the issue, you may start work on code as described in the "Contribution process" section above.
4 changes: 2 additions & 2 deletions da/da.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Rollkit provides a wrapper for [go-da][go-da], a generic data availability inter

## Details

`DAClient` under the hood uses a GRPC implementation of the [go-da][go-da] DA interface. Using the `DAAddress` specified in the node's config, node creates a GRPC connection to it using go-da's gprc implementation [grpc-proxy][grpc-proxy] which is then used under the hood of `DAClient` to communicated with the underlying DA.
`DAClient` under the hood uses a GRPC implementation of the [go-da][go-da] DA interface. Using the `DAAddress` specified in the node's config, node creates a GRPC connection to it using go-da's gprc implementation [grpc-proxy][grpc-proxy] which is then used under the hood of `DAClient` to communicate with the underlying DA.

Given a set of blocks to be submitted to DA by the block manager, the `SubmitBlocks` first encodes the blocks using protobuf (the encoded data are called blobs) and invokes the `Submit` method on the underlying DA implementation. On successful submission (`StatusSuccess`), the DA block height which included in the rollup blocks is returned.

To make sure that the serialised blocks don't exceed the underlying DA's blob limits, it fetches the the blob size limit by calling `Config` which returns the limit as `uint64` bytes, then includes serialised blocks until the limit is reached. If the limit is reached, it submits the partial set and returns the count of successfully submitted blocks as `SubmittedCount`. The caller should retry with the remaining blocks until all the blocks are submitted. If the first block itself is over the limit, it throws an error.
To make sure that the serialised blocks don't exceed the underlying DA's blob limits, it fetches the blob size limit by calling `Config` which returns the limit as `uint64` bytes, then includes serialised blocks until the limit is reached. If the limit is reached, it submits the partial set and returns the count of successfully submitted blocks as `SubmittedCount`. The caller should retry with the remaining blocks until all the blocks are submitted. If the first block itself is over the limit, it throws an error.

The `Submit` call may result in an error (`StatusError`) based on the underlying DA implementations on following scenarios:

Expand Down
2 changes: 1 addition & 1 deletion specs/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ gantt
```

### Grammer and spelling check
### Grammar and spelling check

The recommendation is to use your favorite spellchecker extension in your IDE like [grammarly], to make sure that the document is free of spelling and grammar errors.

Expand Down

0 comments on commit fc0f100

Please sign in to comment.