Merge pull request #16 from rainshowerLabs/0.4.0

0.4.0 release

Author: makemake-kbo

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "sothis"
-version = "0.3.2"
+version = "0.4.0"
 edition = "2021"
 authors = ["makemake <vukasin@gostovic.me>"]
 license = "GPL-3.0-or-later"
@@ -15,11 +15,8 @@ categories = ["command-line-utilities"]
 [dependencies]
 clap = "4.3.0"
 ctrlc = "3.4.0"
-env = "0.0.0"
 ethers = {version = "2.0.7", features = ["legacy"]}
-lazy_static = "1.4.0"
 reqwest = { version = "0.11.18", features = ["blocking", "json"] }
-rlp = "0.5.2"
 serde = { version = "1.0.163", features = ["derive"] }
 serde_json = "1.0.96"
 tokio = { version = "1.28.1", features = ["full"] }

Cargo.toml

@@ -4,6 +4,8 @@
 
 Sothis is a tool for replaying historical state on a local ***anvil/hardhat*** testnet node. 
 
+**For detailed instructions, read the [wiki.](https://github.com/rainshowerLabs/sothis/wiki)**
+
 ## Support and discussion
 
 Join the [Rainshower Labs discord server](https://discord.gg/Cs3h397gkz) to discuss sothis and get help.
@@ -18,12 +20,12 @@ Usage: sothis [OPTIONS] --source_rpc <source_rpc>...
 Options:
   -s, --source_rpc <source_rpc>...
           HTTP JSON-RPC of the node we're querying data from
-  -b, --terminal_block <terminal_block>...
-          Block we're replaying until
   -r, --replay_rpc <replay_rpc>...
           HTTP JSON-RPC of the node we're replaying data to
   -m, --mode <mode>...
-          Choose between live, historic replay, or tracking [default: historic]
+          Choose between live, historic, track, or fast_track [default: historic]
+  -b, --terminal_block <terminal_block>...
+          Block we're replaying until
       --exit_on_tx_fail [<exit_on_tx_fail>...]
           Exit the program if a transaction fails
   -t, --block_listen_time <block_listen_time>...
@@ -32,12 +34,16 @@ Options:
           Set the percentage of failed transactions to trigger a warning [default: 0.07]
   -d, --replay_delay <replay_delay>...
           Default delay for block replay in ms [default: 0]
-      --send_as_raw [<send_as_raw>...]
+      --send_as_unsigned [<send_as_unsigned>...]
           Exit the program if a transaction fails
+      --no_setup [<no_setup>...]
+          Start replaying immediately.
   -c, --contract_address <contract_address>...
           Address of the contract we're tracking storage.
   -l, --storage_slot <storage_slot>...
           Storage slot for the variable we're tracking
+  -0, --origin_block <origin_block>...
+          First block sothis will look at.
   -p, --path <path>...
           Path to file we're writing to [default: .]
   -f, --filename <filename>...
@@ -48,22 +54,20 @@ Options:
           Print version
 ```
 
-Sothis currently has 3 modes. Live, historic and track.   
-
-***IMPORTANT:*** Hardhat support is currently experimental. If you are using Hardhat, add the `--send_as_raw` argument.
+Sothis currently has 4 modes. Live, historic, track, and fast track.   
 
 ### Historic
 
 Historic mode is the default way to use sothis. Its used to replay state to a local node forked to a deep historical block.
 
 #### Usage
 
-- `-m historic`(optional): Used to denote we are replaying in live mode.
+- `-m historic`(optinal): Used to denote we are replaying in live mode.
 - `--source_rpc`: RPC of the node we are getting blocks from.
 - `--replay_rpc`: RPC of the node were sending blocks to.
 - `--terminal_block`: Final block sothis will replay.
 
-To stop replaying, terminate the process via Ctrl+C or however else you prefer.
+To stop replaying, terminate the process via Ctrl+C or however else you preffer.
 
 ```
 sothis --source_rpc {ARCHIVE_NODE} --replay_rpc http://localhost:8545 -m historic --terminal_block 9000022
@@ -79,15 +83,15 @@ Live mode is designed to be used with a forked local node, with its tip near the
 - `--source_rpc`: RPC of the node we are getting blocks from.
 - `--replay_rpc`: RPC of the node were sending blocks to.
 
-To stop replaying, terminate the process via Ctrl+C or however else you prefer.
+To stop replaying, terminate the process via Ctrl+C or however else you preffer.
 
 ```
 sothis --source_rpc {ARCHIVE_NODE} --replay_rpc http://localhost:8545 -m live
 ```
 
 ### Track
 
-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.   
+The tracking mode is used to track the change in value of a storage slot for a contract, that needs to be updated live. 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` so tracking doesn't lag behind!) . 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.   
 
 The result is saved to a JSON file that looks like this:
 ```json
@@ -115,6 +119,26 @@ Once you are done tracking the slot, terminate the process via a `SIGTERM` or a
 `sothis --mode track --source_rpc http://localhost:8545 --contract_address 0x1c479675ad559DC151F6Ec7ed3FbF8ceE79582B6 --storage_slot 0 --filename siuuu.json --path ~/Desktop
 `
 
+### Fast track
+
+The fast track mode is used to track the change for a *historic* storage slot. It cannot be used to get a live view of it. The source_rpc must be an archive node for this mode to perform optimally. This results in a speedup of as much as ~10000% compared to the regular tracking mode. This is the recommended mode to use if you do not have a local node.
+
+#### Usage
+
+- `--mode fast_track`: Used to denote we are using the tracking mode.
+- `--source_rpc`: RPC of the node we are getting data from.
+- `--contract_address`: Address of the contract we are reading storage from.
+- `--storage_slot`: The storage slot of the contract.
+- `--origin_block`: The block from which we start tracking.
+- `--terminal_block`(optional): Final block sothis will track. If not specified, sothis will track until terminated.
+- `--filename`(optional): Name of our output file. The default filename is formatted as: `address-{}-slot-{}-timestamp-{}.json`.
+- `--path`(optional): Path to our output file. The default path is the current directory.
+
+Once you are done tracking the slot, terminate the process via a `SIGTERM` or a `SIGINT` (ctrl-c), which will terminate execution and write the file. Keep in mind that sothis will check once per new block if you tried to terminate it. If no new block are produced on the source_rpc, sothis will not terminate and nothing will be written if you force close it.
+<!-- easter egg contract -->
+`sothis --mode track --source_rpc http://localhost:8545 --contract_address 0x910cbd523d972eb0a6f4cae4618ad62622b39dbf --storage_slot 3 --filename siuuu.json --path ~/Desktop
+`
+
 ## Installation
 
 Sothis is a rust crate. You can install it with cargo:
@@ -124,17 +148,13 @@ Sothis is a rust crate. You can install it with cargo:
 
 ###  Why is sothis so slow?
 
-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.
-If using `anvil` make sure you add the `--cups {REALLY_HIGH_VALUE}` arg so anvil doesn't throttle itself.
+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.       
+If using `anvil` make sure you add the `--cups {REALL_HIGH_VALUE}` arg so anvil doesn't throttle itself.
 
 ### I have a problem with sothis. Can devs do something?
 
 Yes! Make a github issue detailing your problem.
 
 ### Why the name?
 
-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.
-
-## todo
-
-- ??????
+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.