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

fix: typos in the docs #1527

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ This is a rough outline of what a contributor's workflow looks like:
- If the PR contains any breaking changes, add the breaking label to your PR.
- If you are part of the FuelLabs Github org, please open a PR from the repository itself.
- Otherwise, push your changes to a branch in your fork of the repository and submit a pull request.
- Make sure mention the issue, which is created at step 1, in the commit message.
- Make sure to mention the issue, which is created at step 1, in the commit message.
- Your PR will be reviewed and some changes may be requested.
- Once you've made changes, your PR must be re-reviewed and approved.
- If the PR becomes out of date, you can use GitHub's 'update branch' button.
Expand All @@ -120,7 +120,7 @@ Thanks for your contributions!

For beginners, we have prepared many suitable tasks for you. Checkout our [Help Wanted issues](https://github.com/FuelLabs/fuel-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) for a list.

If you are planning something big, for example, relates to multiple components or changes current behaviors, make sure to open an issue to discuss with us before going on.
If you are planning something big, for example, relates to multiple components or changes in current behaviors, make sure to open an issue to discuss with us before going on.

The Client team actively develops and maintains several dependencies used in Fuel Core, which you may be also interested in:

Expand Down
8 changes: 4 additions & 4 deletions docs/fee_calculations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ to include an additional cost to op codes that write new data to storage or to
transactions that add new contracts to the chain.

There are a number of ways we might calculate this value; we have decided to go
with a simple calculatoin based on the our target storage growth and working
with a simple calculation based on our target storage growth and working
backward from there.

#### Pessimistic Estimate
Expand All @@ -23,13 +23,13 @@ This gives us this graph:
| 500,000,000,000 | 10,000,000 | 31536000 | **15,855** | **630.72** |

This is a harsh estimate that isn't taking into the additional base cost of tx
execution and the cost of any additional op codes. It is also assuming that
execution and the cost of any additional op codes. It is also assumed that
all blocks would be maxing out the storage.

#### Generous Estimate

Additionally, this will only apply to our early networks, which won't be long-live.
This allows us to take a bigger risk on the storage price and increas it over
This allows us to take a bigger risk on the storage price and increase it over
time to compensate for users adding a lot of data.

All this included, if we re-estimate the yearly storage limit as 5 TB we get:
Expand All @@ -56,7 +56,7 @@ blocks_per_year = 365 * 24 * 60 * ~5 = ~2628000

yearly_new_contract_bytes = blocks_per_year * contracts_per_block * max_contract_size = **378,432,000,000**

Which rougly lines up with our pessimistic estimate.
Which roughly lines up with our pessimistic estimate.

#### Conclusion

Expand Down
4 changes: 2 additions & 2 deletions docs/poa/flows.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Flows

## PoA Primary Production Flow
When the node is configured with a POA key, produce blocks and notify network.
When the node is configured with a POA key, produces blocks and notifies the network.

```mermaid
sequenceDiagram
Expand Down Expand Up @@ -99,7 +99,7 @@ sequenceDiagram
S->>+POA: verify signed block header
POA->>+R: await new block da height
R-->>-POA:
note right of POA: verify signature against current authority key
note right of POA: verify the signature against current authority key
POA->>-S:
S->>+BI: commit sealed block
BI->>+R: check_da_height for message inclusion
Expand Down