Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dzejkop committed May 31, 2024
1 parent 384a841 commit 930933d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1 +1 @@
RUST_LOG=info,tx_sitter=debug,fake_rpc=debug,tower_http=debug
RUST_LOG=info,tx_sitter=debug,tower_http=debug
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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
```
Expand Down
3 changes: 1 addition & 2 deletions tests/common/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Expand Down

0 comments on commit 930933d

Please sign in to comment.