Skip to content

Commit 4ee2d0f

Browse files
authored
Merge pull request #10 from engn33r/patch-1
Fix typos, clarify throttling
2 parents 29bf94d + b14074f commit 4ee2d0f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ Historic mode is the default way to use sothis. Its used to replay state to a lo
5858

5959
#### Usage
6060

61-
- `-m historic`(optinal): Used to denote we are replaying in live mode.
61+
- `-m historic`(optional): Used to denote we are replaying in live mode.
6262
- `--source_rpc`: RPC of the node we are getting blocks from.
6363
- `--replay_rpc`: RPC of the node were sending blocks to.
6464
- `--terminal_block`: Final block sothis will replay.
6565

66-
To stop replaying, terminate the process via Ctrl+C or however else you preffer.
66+
To stop replaying, terminate the process via Ctrl+C or however else you prefer.
6767

6868
```
6969
sothis --source_rpc {ARCHIVE_NODE} --replay_rpc http://localhost:8545 -m historic --terminal_block 9000022
@@ -79,15 +79,15 @@ Live mode is designed to be used with a forked local node, with its tip near the
7979
- `--source_rpc`: RPC of the node we are getting blocks from.
8080
- `--replay_rpc`: RPC of the node were sending blocks to.
8181

82-
To stop replaying, terminate the process via Ctrl+C or however else you preffer.
82+
To stop replaying, terminate the process via Ctrl+C or however else you prefer.
8383

8484
```
8585
sothis --source_rpc {ARCHIVE_NODE} --replay_rpc http://localhost:8545 -m live
8686
```
8787

8888
### Track
8989

90-
The tracking mode is used to track the change in value of a storage slot for a contract. It can be used on a live production network, as well as in conjuntion with sothis (keep in mind that you can use the `--block_listen_time`!) . If you are testing on a local network, you can launch another instance of sothis to track the change of a slot on a replay node.
90+
The tracking mode is used to track the change in value of a storage slot for a contract. It can be used on a live production network, as well as in conjunction with sothis (keep in mind that you can use the `--block_listen_time`!) . If you are testing on a local network, you can launch another instance of sothis to track the change of a slot on a replay node.
9191

9292
The result is saved to a JSON file that looks like this:
9393
```json
@@ -124,16 +124,16 @@ Sothis is a rust crate. You can install it with cargo:
124124

125125
### Why is sothis so slow?
126126

127-
Sothis uses a lot of JSON-RPC calls. This may cause your RPC provider to throttle you. It's recommended to use your own local node.
128-
If using `anvil` make sure you add the `--cups {REALL_HIGH_VALUE}` arg so anvil doesn't throttle itself.
127+
Sothis uses a lot of JSON-RPC calls. This may cause your RPC provider to throttle you. One indication the throttling is happening is when the `evm_mine` action takes a long time. If `anvil` is frozen on `evm_mine`, it may take 3-4 minutes to mine a single block but it will eventually finish. It's recommended to use your own local node.
128+
If using `anvil` make sure you add the `--cups {REALLY_HIGH_VALUE}` arg so anvil doesn't throttle itself.
129129

130130
### I have a problem with sothis. Can devs do something?
131131

132132
Yes! Make a github issue detailing your problem.
133133

134134
### Why the name?
135135

136-
Sothis is known as the creator and God of Fódlan in Fire Emblem: Thee Houses. She has the ability to rewind time at will.
136+
Sothis is known as the creator and God of Fódlan in Fire Emblem: Three Houses. She has the ability to rewind time at will.
137137

138138
## todo
139139

0 commit comments

Comments
 (0)