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

Commit

Permalink
Merge branch 'main' into simple-2
Browse files Browse the repository at this point in the history
  • Loading branch information
Eikix authored Jan 8, 2025
2 parents 81c4581 + ce22fb9 commit adca5e9
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 11 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@

---

## Update

The development of `kakarot-rpc` is halted for now. This repository - an
Ethereum RPC gateway to Starknet EVM - is frozen, mainly to halt creation of new
issues and pull requests. It is MIT licensed, not audited.

## About

Kakarot RPC fits in the three-part architecture of the Kakarot zkEVM rollup
Expand Down
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.
6 changes: 3 additions & 3 deletions docs/methods/eth_gasPrice.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

Returns the current price per gas in wei.

Kakarot specificity: since Kakarot does not have a fee market as of January
2024, transactions are ordered on a "First Come First Serve" basis.
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:

- gasPrice == baseFee
- priority fee is generally a variable that isn't used.
- setting a EIP-1559 transaction with `maxPriorityFeePerGas > 0` has no
- setting an EIP-1559 transaction with `maxPriorityFeePerGas > 0` has no
effect.
4 changes: 2 additions & 2 deletions docs/rpc_api_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ documented in `./methods/{method}.md`
| [eth_getCode](./methods/eth_getCode.md) | Returns code at a given address. ||
| eth_sign | The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))). ||
| eth_signTransaction | Signs a transaction that can be submitted to the network at a later time using with eth_sendRawTransaction. ||
| eth_sendTransaction | Creates new message call transaction or a contract creation, if the data field contains code. ||
| [eth_sendRawTransaction](./methods/eth_sendRawTransaction.md) | Creates new message call transaction or a contract creation for signed transactions. ||
| eth_sendTransaction | Creates a new message call transaction or a contract creation, if the data field contains code. ||
| [eth_sendRawTransaction](./methods/eth_sendRawTransaction.md) | Creates a new message call transaction or a contract creation for signed transactions. ||
| [eth_call](./methods/eth_call.md) | Executes a new message call immediately without creating a transaction on the blockchain. ||
| [eth_estimateGas](./methods/eth_estimateGas.md) | Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. ||
| eth_getBlockByHash | Returns information about a block by hash. ||
Expand Down
2 changes: 1 addition & 1 deletion indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ _Why not directly modify a CairoVM client?_
[Madara](https://madara-docs.vercel.app/)).

<details>
<summary>For reference, click to see how the above mentioned monolithic architecture
<summary>For reference, click to see how the above-mentioned monolithic architecture
would look like (note that it is not the current architecture of Kakarot zkEVM):
</summary>

Expand Down

0 comments on commit adca5e9

Please sign in to comment.