Skip to content
This repository has been archived by the owner on Jan 8, 2025. It is now read-only.

Commit

Permalink
Improve Documentation Consistency and Clarity (#1536)
Browse files Browse the repository at this point in the history
* Update types.md

* Update eth_call.md

* Update eth_coinbase.md

* Update eth_estimateGas.md

* Update eth_gasPrice.md
  • Loading branch information
donatik27 authored Jan 8, 2025
1 parent 7e6c8c0 commit ce22fb9
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/contributing/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Hex encoding

Every value is Hex encoded, starts with `0x` and contains at least one
Every value is Hex-encoded, starts with `0x`, and contains at least one
hexadecimal digit

- ✅ 0x1
- ✅ 0x01
- ✅ 0x0
- ❌ 0x
- ❌ 0x // Invalid, missing hexadecimal digits
- ❌ 0x4000 // no leading zeroes allowed
- ❌ ff // must be prefixed with `0x`

Expand Down
2 changes: 1 addition & 1 deletion docs/methods/eth_call.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

## Description

Submits an EVM call by wrapping the EVM compatible transaction object into a
Submits an EVM call by wrapping the EVM-compatible transaction object into a
Starknet call.

Kakarot Specificity:
Expand Down
2 changes: 1 addition & 1 deletion docs/methods/eth_coinbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@

Returns the Ethereum account controlled by the Kakarot zkEVM sequencer.

Kakarot specifity: since Kakarot set of Cairo programs run on the StarknetOS
Kakarot specificity: since Kakarot set of Cairo programs run on the StarknetOS
(i.e. on an underlying CairoVM client), the coinbase is the EVM representation
of a Starknet account that collects the fees.
2 changes: 1 addition & 1 deletion docs/methods/eth_estimateGas.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ transaction to complete.
Kakarot Specificity:

- Call the Kakarot Cairo smart contract's entrypoint: `eth_call` with the EVM
transaction fields as argument and get the returned `gas_used` variable. This
transaction fields as arguments and get the returned `gas_used` variable. This
value is the estimated gas needed to complete the transaction.
2 changes: 1 addition & 1 deletion docs/methods/eth_gasPrice.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Returns the current price per gas in wei.

Kakarot specifity: since Kakarot does not have a fee market as of January 2024,
Kakarot specificity: since Kakarot does not have a fee market as of January 2024,
transactions are ordered on a "First Come First Serve" basis.

For this reason:
Expand Down

0 comments on commit ce22fb9

Please sign in to comment.