From 930933d98dbaef47433133a6ee36b65de6850320 Mon Sep 17 00:00:00 2001 From: Dzejkop Date: Fri, 31 May 2024 15:48:41 +0200 Subject: [PATCH] Update docs --- .env.example | 2 +- README.md | 24 ++++++++++++------------ tests/common/mod.rs | 3 +-- 3 files changed, 14 insertions(+), 15 deletions(-) diff --git a/.env.example b/.env.example index 943896d..89a47ae 100644 --- a/.env.example +++ b/.env.example @@ -1 +1 @@ -RUST_LOG=info,tx_sitter=debug,fake_rpc=debug,tower_http=debug +RUST_LOG=info,tx_sitter=debug,tower_http=debug diff --git a/README.md b/README.md index 960855d..b4c52b5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # Tx Sitter Monolith -A monolithized version of the [tx-sitter](https://github.com/worldcoin/tx-sitter-aws/). +An easy to run transaction relayer. + +## Quickstart +Copy `.env.example` to `.env` or set `RUST_LOG=info,service=debug` to have logging. + +1. Spin up the database `docker run --rm -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432:5432 postgres` +2. Spin up a chain `anvil --chain-id 31337 --block-time 2` +3. Start the service `cargo run` + +This will use the `config.toml` configuration. + +If you have [nushell](https://www.nushell.sh/) installed, `nu manual_test.nu` can be run to execute a basic test. ## Configuration The Tx Sitter can be configured in 2 ways: @@ -31,17 +42,6 @@ The Tx Sitter can be configured in 2 ways: TX_SITTER__KEYS__KIND="local" ``` -## Testing locally -Copy `.env.example` to `.env` or set `RUST_LOG=info,service=debug` to have logging. - -1. Spin up the database `docker run --rm -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432:5432 postgres` -2. Spin up the chain `anvil --chain-id 31337 --block-time 2` -3. Start the service `cargo run` - -This will use the `config.toml` configuration. - -If you have [nushell](https://www.nushell.sh/) installed, `nu manual_test.nu` can be run to execute a basic test. - ## Running tests While you obviously can run tests with ``` diff --git a/tests/common/mod.rs b/tests/common/mod.rs index c514749..f3ba48a 100644 --- a/tests/common/mod.rs +++ b/tests/common/mod.rs @@ -70,8 +70,7 @@ pub fn setup_tracing() { .with( EnvFilter::builder() .with_default_directive(LevelFilter::INFO.into()) - // Logging from fake_rpc can get very messy so we set it to warn only - .parse_lossy("info,tx_sitter=debug,fake_rpc=warn"), + .parse_lossy("info,tx_sitter=debug"), ) .init(); }