Skip to content

Commit

Permalink
Improvements to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Eagle941 committed Oct 2, 2024
1 parent 9909090 commit db4272b
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Starknet Replay

`starknet-replay` is a CLI application to replay Starknet transactions. The
state of the blockchain is queried using the Starknet RPC protocol.
It also reports the frequency with which each `libfunc` has been called when
replaying the transactions.
state of the blockchain is queried using the Starknet RPC protocol. It also
reports the frequency with which each `libfunc` has been called when replaying
the transactions.

It's possible to export the histogram of the most frequently used libfuncs
by number of calls. The data plotted in the histogram is filtered to only
include the libfuncs that amount to 80% of the total calls in the replay. This
helps readability and visual analysis.
It's possible to export the histogram of the most frequently used libfuncs by
number of calls. The data plotted in the histogram is filtered to only include
the libfuncs that amount to 80% of the total calls in the replay. This helps
readability and visual analysis.

Only `INVOKE` transactions of Sierra contracts are used for this report because
only Sierra contracts use libfuncs and only `INVOKE` transactions execute Sierra
Expand Down Expand Up @@ -50,6 +50,9 @@ Libfunc frequency results haven't been checked yet.

This crate is compatible with Rust 1.78. Both x86 and ARM are supported.

`blockifier` dependency is not compatible with Rust 1.81+. `pathfinder_simp`
dependency is not compatible with Rust 1.83+ on ARM.

## Useful links

- [Starknet](https://docs.starknet.io/documentation/)
Expand Down

0 comments on commit db4272b

Please sign in to comment.